spring mvc 输出 json

来源:互联网 发布:淘宝联盟怎么查普通pid 编辑:程序博客网 时间:2024/06/14 09:06
对于web应用,少不了Ajax请求,因此少不了JSON输出支持,在spring-mvc中实现这点非常简单、如下:
------------------------------------------spring-mvc配置----------------------------------------------------
<!-- 启用注解支持 -->
<mvc:annotation-driven />
<!-- 处理器-适配器 -->
<bean id="handlerAdapter" class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
<property name="cacheSeconds" value="0" />
<property name="messageConverters" ref="messageConverters" />
</bean>
<!-- Http messageConverters,用于将对象输出到客户端-->
<util:list id="messageConverters">
<bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
<property name="supportedMediaTypes">
<list>
<value>application/json</value>
<value>application/javascript</value>
<value>text/json</value>
<value>text/javascript</value>
</list>
</property>
<property name="objectMapper" ref="objectMapper"></property>
</bean>
</util:list>

--------------------------------------Controller代码-----------------------------------------------------------------
/**
* 示例方法 - 接收/demoAjax.action请求,使用@ResponseBody输出数据
* */
@RequestMapping("/demoAjax")
@ResponseBody
public Map demoAjax(String name) {
System.out.println("name:" + name);
return Collections.singletonMap("name", name);
}

--------------------------------------javascript代码----------------------------------------------------------------------
$.ajax({
url: "demoAjax.action",
data: {name: "you param"},
dataType : "json",
type : "POST",
success: function(data){
alert("请求发送成功,返回数据:" + data.name);
}
});

运行以上代码可看到结果,输出JSON就这么简单!只需要在Controller方法上标记@ResponseBody。
另外、也可以使用内容协商机制,或以请求后缀名匹配用以输出JSON。但是控制能力不如@ResponseBody,而且性能没有这个好,所以这里使@ResponseBody。

那么他是如何工作呢?
@ResponseBody:将Controller方法返回值直接输出到response响应体,所以不经过视图解析器,性能更好。

spring mvc默认会注册很多适配器、映射器、等等。上面配置的AnnotationMethodHandlerAdapter也是其中一个,看名字就知道他是干嘛的 - 处理Controller和其注解。

DispatcherServlet调用映射器来找到Controller处理该请求的方法,然后使用适配器来调用该方法,由于<mvc:annotation-driven />启用注解支持,那么将使用AnnotationMethodHandlerAdapter来调用Controller。

如果方法上标有@ResponseBody,那么AnnotationMethodHandlerAdapter将使用messageConverters将Controller返回值直接输出到响应体。

messageConverters是一个列表(messageConverters不仅可以输出JSON),列表中的每个单元(messageConverter)都指定了supportedMediaTypes,这就是它所支持的类型。

如果请求头Accept与某个messageConverter的supportedMediaTypes匹配,那么将使用此messageConverter向响应体输出内容

AnnotationMethodHandlerAdapter遍历messageConverters寻找匹配的单元,用以输出内容。