使用SpringMVC响应json格式返回的结果类型

背景：

SpringMVC如何响应json格式的数据？

技术实现

方式1：在Controller使用@RestController注解

方式2：在Controller使用@Controller，在需要返回方法处使用@ResponseBody注解实现

需要导入j支持的jar包

jackson-annotations-2.2.2.jar

jackson-core-2.2.2.jar

jackson-databind-2.2.2.jar

注意事项：

springMVC底层的实现需要这三个包支持，注意版本，springMVC4.0版本对应的包jackson应该在2.0以上

方式1：在Controller使用@RestController注解

查看源码可以看到，@RestController这个注解是一个组合注解：

那么在Controller上使用@RestController，也达到了@Controller + @ResponseBody的效果；但是，当这个controller使用这个注解的时候，要求这个Controller每个方法都返回json格式的字符串！

如果开发的是第三方口，则会使用这个注解进行开发。

@RestController//所有的方法都需要返回json格式的字符串
public class ProductController {
	@RequestMapping("queryAll.do")
	public List<Product> queryAll() {

		//模拟数据
		List<Product> products = new ArrayList<>();
		for (int i = 1; i <= 10; i++) {
			Product p = new Product(i, "name" + i);
			products.add(p);
		}
		return products;
	}
}

使用Postman查看结果：

方式2：在Controller使用@Controller

在需要返回方法处使用@ResponseBody注解实现

使用这样的组合注解，Controller中的方法返回值可以灵活。不仅限于json格式的字符串。

@Controller
public class ProductController {
	@RequestMapping("queryAll.do")
	@ResponseBody // 这个注解放在方法上，目的是把该方法的返回值转换成json格式的字符串
	public List<Product> queryAll() {

		//模拟数据
		List<Product> products = new ArrayList<>();
		for (int i = 1; i <= 10; i++) {
			Product p = new Product(i, "name" + i);
			products.add(p);
		}
		return products;
	}
}

三种方式实现SpringMVC返回json数据

1、第一种方式

是spring2时代的产物，也就是每个json视图controller配置一个Jsoniew。

如：

<bean id="defaultJsonView" class="org.springframework.web.servlet.view.json.MappingJacksonJsonView"/> 

或者

<bean id="defaultJsonView" class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"/>

同样要用jackson的jar包。

2、第二种方式

使用JSON工具将对象序列化成json，常用工具Jackson，fastjson，gson。

利用HttpServletResponse，然后获取response.getOutputStream()或response.getWriter()直接输出。

示例：

public class JsonUtil
{
    private static Gson gson=new Gson();
    /**
     * @MethodName : toJson
     * @Description : 将对象转为JSON串，此方法能够满足大部分需求
     * @param src
     *            :将要被转化的对象
     * @return :转化后的JSON串
     */
    public static String toJson(Object src) {
        if (src == null) {
            return gson.toJson(JsonNull.INSTANCE);
        }
        return gson.toJson(src);
    }
}

3、第三种方式

利用spring mvc3的注解@ResponseBody

例如：

@ResponseBody
  @RequestMapping("/list")
  public List<String> list(ModelMap modelMap) {
    String hql = "select c from Clothing c ";
    Page<Clothing> page = new Page<Clothing>();
    page.setPageSize(6);
    page  = clothingServiceImpl.queryForPageByHql(page, hql);
    return page.getResult();
  }

然后使用spring mvc的默认配置就可以返回json了，不过需要jackson的jar包哦。

注意：当springMVC-servlet.xml中使用<mvc:annotation-driven />时，如果是3.1之前已经默认注入AnnotationMethodHandlerAdapter，3.1之后默认注入RequestMappingHandlerAdapter只需加上上面提及的jar包即可!

如果是手动注入RequestMappingHandlerAdapter 可以这样设置

配置如下：

<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"
  p:ignoreDefaultModelOnRedirect="true" >
   <property name="messageConverters">
    <list>
     <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"/>
    </list>
   </property>
  </bean>

添加包

jackson-mapper-asl-*.jar

jackson-core-asl-*.jar

可以看出，使用方式越来越简单，程序员越来越傻，不知道是好事，还是坏事……以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。