点击上方 "程序员小乐"关注, 星标或置顶一起成长
第一时间与你相约
每日英文
Be alike flower. Spread beauty and happiness wherever you stay; irrespective of your surroundings.
像花儿一样，无论身在何处，不管周遭环境如何，都依然潇洒的绽放自己的美丽，活出自己的精彩。
每日掏心话
人生尝尽了百味方觉甜美。偶尔隐匿的阳光，再来时更温暖；扑朔迷离的希望，出现时才令人惊喜。
来自：format丶 | 责编：乐乐
链接：cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html
程序员小乐(ID:study_tech)第 830 次推文 图片来自百度
往日回顾：史上首次！个人所得税退税来了！如何退？怎么操作？
正文
前言
SpringMVC是目前主流的Web MVC框架之一。
现象
本文使用的demo基于maven，是根据入门blog的例子继续写下去的。
我们先来看一看对应的现象。我们这里的配置文件 *-dispatcher.xml中的关键配置如下(其他常规的配置文件不在讲解，可参考本文一开始提到的入门blog)：
(视图配置省略)
<resources><annotation-driven><component-scan>
pom中需要有以下依赖(Spring依赖及其他依赖不显示)：
<dependency> <groupid>org.codehaus.jackson/<groupid> <artifactid>jackson-core-asl/<artifactid> <version>1.9.13/<version>/<dependency><dependency> <groupid>org.codehaus.jackson/<groupid> <artifactid>jackson-mapper-asl/<artifactid> <version>1.9.13/<version>/<dependency>
这个依赖是json序列化的依赖。
ok。我们在Controller中添加一个method：
@RequestMapping("/xmlOrJson")@ResponseBodypublic Map<string> xmlOrJson() { Map<string> map = new HashMap<string>(); map.put("list", employeeService.list()); return map;}/<string>/<string>/<string>
直接访问地址：
我们看到，短短几行配置。使用@ResponseBody注解之后，Controller返回的对象 自动被转换成对应的json数据，在这里不得不感叹SpringMVC的强大。
我们好像也没看到具体的配置，唯一看到的就是*-dispatcher.xml中的一句配置：<annotation-driven>。其实就是这个配置，导致了java对象自动转换成json对象的现象。
那么spring到底是如何实现java对象到json对象的自动转换的呢？为什么转换成了json数据，如果想转换成xml数据，那该怎么办？
源码分析
本文使用的spring版本是4.0.2。
在讲解<annotation-driven>这个配置之前，我们先了解下Spring的消息转换机制。@ResponseBody这个注解就是使用消息转换机制，最终通过json的转换器转换成json数据的。
HttpMessageConverter接口就是Spring提供的http消息转换接口。有关这方面的知识大家可以参考"参考资料"中的第二条链接，里面讲的很清楚。
下面开始分析<annotation-driven>这句配置:
这句代码在spring中的解析类是：
在AnnotationDrivenBeanDefinitionParser源码的152行parse方法中：
分别实例化了RequestMappingHandlerMapping，ConfigurableWebBindingInitializer，RequestMappingHandlerAdapter等诸多类。
其中RequestMappingHandlerMapping和RequestMappingHandlerAdapter这两个类比较重要。
RequestMappingHandlerMapping处理请求映射的，处理@RequestMapping跟请求地址之间的关系。
RequestMappingHandlerAdapter是请求处理的适配器，也就是请求之后处理具体逻辑的执行，关系到哪个类的哪个方法以及转换器等工作，这个类是我们讲的重点，其中它的属性messageConverters是本文要讲的重点。
私有方法:getMessageConverters
从代码中我们可以，RequestMappingHandlerAdapter设置messageConverters的逻辑：
1.如果<annotation-driven>节点有子节点message-converters，那么它的转换器属性messageConverters也由这些子节点组成。/<annotation-driven>
message-converters的子节点配置如下：
<annotation-driven> <message-converters> <bean> <bean> /<message-converters>/<annotation-driven>
2.message-converters子节点不存在或它的属性register-defaults为true的话，加入其他的转换器：ByteArrayHttpMessageConverter、StringHttpMessageConverter、ResourceHttpMessageConverter等。
我们看到这么一段：
这些boolean属性是哪里来的呢，它们是AnnotationDrivenBeanDefinitionParser的静态变量。
其中ClassUtils中的isPresent方法如下：
看到这里，读者应该明白了为什么本文一开始在pom文件中需要加入对应的jackson依赖，为了让json转换器jackson成为默认转换器之一。
<annotation-driven>的作用读者也明白了。/<annotation-driven>
下面我们看如何通过消息转换器将java对象进行转换的。
RequestMappingHandlerAdapter在进行handle的时候，会委托给HandlerMethod（具体由子类ServletInvocableHandlerMethod处理）的invokeAndHandle方法进行处理，这个方法又转接给HandlerMethodReturnValueHandlerComposite处理。
HandlerMethodReturnValueHandlerComposite维护了一个HandlerMethodReturnValueHandler列表。
HandlerMethodReturnValueHandler是一个对返回值进行处理的策略接口，这个接口非常重要。然后找到对应的HandlerMethodReturnValueHandler对结果值进行处理。
最终找到RequestResponseBodyMethodProcessor这个Handler（由于使用了@ResponseBody注解）。
RequestResponseBodyMethodProcessor的supportsReturnType方法：
然后使用handleReturnValue方法进行处理：
我们看到，这里使用了转换器。
具体的转换方法：
至于为何是请求头部的Accept数据，读者可以进去debug这个getAcceptableMediaTypes方法看看。我就不罗嗦了～～～
ok。至此，我们走遍了所有的流程。
现在，回过头来看。为什么一开始的demo输出了json数据？
我们来分析吧。
由于我们只配置了<annotation-driven>，因此使用spring默认的那些转换器。/<annotation-driven>
很明显，我们看到了2个xml和1个json转换器。 要看能不能转换，得看HttpMessageConverter接口的public boolean canWrite(Class> clazz, MediaType mediaType)方法是否返回true来决定的。
我们先分析SourceHttpMessageConverter：
它的canWrite方法被父类AbstractHttpMessageConverter重写了。
发现SUPPORTED_CLASSES中没有Map类(本文demo返回的是Map类)，因此不支持。
下面看Jaxb2RootElementHttpMessageConverter：
这个类直接重写了canWrite方法。
需要有XmlRootElement注解。很明显，Map类当然没有。
最终MappingJackson2HttpMessageConverter匹配，进行json转换。（为何匹配，请读者自行查看源码）
实例讲解
我们分析了转换器的转换过程之后，下面就通过实例来验证我们的结论吧。
首先，我们先把xml转换器实现。
之前已经分析，默认的转换器中是支持xml的。下面我们加上注解试试吧。
由于Map是jdk源码中的部分，因此我们用Employee来做demo。
因此，Controller加上一个方法：
-
@RequestMapping("/xmlOrJsonSimple")@ResponseBodypublic Employee xmlOrJsonSimple() { return employeeService.getById(1);}
实体中加上@XmlRootElement注解
结果如下：
我们发现，解析成了xml。
这里为什么解析成xml，而不解析成json呢？
之前分析过，消息转换器是根据class和mediaType决定的。
我们使用firebug看到：
我们发现Accept有xml，没有json。因此解析成xml了。
我们再来验证，同一地址，HTTP头部不同Accept。看是否正确。
$.ajax({ url: "${request.contextPath}/employee/xmlOrJsonSimple", success: function(res) { console.log(res); }, headers: { "Accept": "application/xml" }});
$.ajax({ url: "${request.contextPath}/employee/xmlOrJsonSimple", success: function(res) { console.log(res); }, headers: { "Accept": "application/json" }});
验证成功。
关于配置
如果不想使用<annotation-driven>中默认的RequestMappingHandlerAdapter的话，我们可以在重新定义这个bean，spring会覆盖掉默认的RequestMappingHandlerAdapter。
-
<bean> <property> <list> <bean> <bean> <bean> /<list> /<property>/<bean>
或者如果只想换messageConverters的话。
<annotation-driven> <message-converters> <bean> <bean> /<message-converters>/<annotation-driven>
如果还想用其他converters的话。
以上是spring-mvc jar包中的converters。
这里我们使用转换xml的MarshallingHttpMessageConverter。
这个converter里面使用了marshaller进行转换
我们这里使用XStreamMarshaller。
json没有转换器，返回406.
至于xml格式的问题，大家自行解决吧。这里用的是XStream～。
使用这种方式，pom别忘记了加入xstream的依赖：
<dependency> <groupid>com.thoughtworks.xstream/<groupid> <artifactid>xstream/<artifactid> <version>1.4.7/<version>/<dependency>
总结
写了这么多，可能读者觉得有点罗嗦。毕竟这也是自己的一些心得，希望都能说出来与读者共享。
刚接触SpringMVC的时候，发现这种自动转换机制很牛逼，但是一直没有研究它的原理，目前，算是了了一个小小心愿吧，SpringMVC还有很多内容，以后自己研究其他内容的时候还会与大家一起共享的。
文章难免会出现一些错误，希望读者们能指明出来。
oschina.net/HeliosFly/blog/205343
my.oschina.net/lichhao/blog/172562
docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html
欢迎在留言区留下你的观点，一起讨论提高。如果今天的文章让你有新的启发，学习能力的提升上有新的认识，欢迎转发分享给更多人。
猜你还想看
阿里、腾讯、百度、华为、京东最新面试题汇集
手把手教你 Netty 实现自定义协议！
一个简单的例子带你理解HashMap
【整理】Spring 常用注解！千万不要错过！
关注订阅号「程序员小乐」，收看更多精彩内容
嘿，你在看吗？
閱讀更多 程序員小樂 的文章
