SpringMVC关于json、xml自动转换的原理研究

1、SpringMVC关于json、xml自动转换的原理研究视图配置省略.pom中需要有以下依赖(Spring依赖及其他依赖不显示)： org.codehaus.jackson jackson-core-asl 1.9.13 org.codehaus.jackson jackson-mapper-asl 1.9.13 这个依赖分别是json序列化的依赖。ok。我们在Controller中添加一个method：RequestMapping(/)ResponseBodypublic Map map = new HashMap(); map.put(list, employeeService.list(

2、); return map;直接访问地址：我们看到，短短几行配置。使用ResponseBody注解之后，Controller返回的对象 自动被转换成对应的json数据，在这里不得不感叹SpringMVC的强大。我们好像也没看到具体的配置，唯一看到的就是*-dispatcher.那么spring到底是如何实现java对象到json对象的自动转换的呢？ 为什么转换成了json数据，如果想转换成源码分析本文使用的spring版本是4.0.2。 在讲解这个配置之前，我们先了解下Spring的消息转换机制。ResponseBody这个注解就是使用消息转换机制，最终通过json的转换器转换成json数据的

3、。HttpMessageConverter接口就是Spring提供的http消息转换接口。有关这方面的知识大家可以参考参考资料中的第二条链接，里面讲的很清楚。下面开始分析这句配置:这句代码在spring中的解析类是：在AnnotationDrivenBeanDefinitionParser源码的152行parse方法中：分别实例化了RequestMappingHandlerMapping，ConfigurableWebBindingInitializer，RequestMappingHandlerAdapter等诸多类。其中RequestMappingHandlerMapping和Reques

4、tMappingHandlerAdapter这两个类比较重要。RequestMappingHandlerMapping处理请求映射的，处理RequestMapping跟请求地址之间的关系。RequestMappingHandlerAdapter是请求处理的适配器，也就是请求之后处理具体逻辑的执行，关系到哪个类的哪个方法以及转换器等工作，这个类是我们讲的重点，其中它的属性messageConverters是本文要讲的重点。私有方法:getMessageConverters从代码中我们可以，RequestMappingHandlerAdapter设置messageConverters的逻辑：1.如

5、果节点有子节点message-converters，那么它的转换器属性messageConverters也由这些子节点组成。message-converters的子节点配置如下： 2.message-converters子节点不存在或它的属性register-defaults为true的话，加入其他的转换器：ByteArrayHttpMessageConverter、StringHttpMessageConverter、ResourceHttpMessageConverter等。我们看到这么一段：这些boolean属性是哪里来的呢，它们是AnnotationDrivenBeanDefiniti

6、onParser的静态变量。其中ClassUtils中的isPresent方法如下：看到这里，读者应该明白了为什么本文一开始在pom文件中需要加入对应的jackson依赖，为了让json转换器jackson成为默认转换器之一。的作用读者也明白了。下面我们看如何通过消息转换器将java对象进行转换的。RequestMappingHandlerAdapter在进行handle的时候，会委托给HandlerMethod（具体由子类ServletInvocableHandlerMethod处理）的invokeAndHandle方法进行处理，这个方法又转接给HandlerMethodReturnValu

7、eHandlerComposite处理。HandlerMethodReturnValueHandlerComposite维护了一个HandlerMethodReturnValueHandler列表。HandlerMethodReturnValueHandler是一个对返回值进行处理的策略接口。然后找到确定的HandlerMethodReturnValueHandler对结果值进行处理。最终找到RequestResponseBodyMethodProcessor这个Handler（由于使用了ResponseBody注解）。RequestResponseBodyMethodProcessor的su

8、pportsReturnType方法：然后使用handleReturnValue方法进行处理：我们看到，这里使用了转换器。具体的转换方法：至于为何是请求头部的Accept数据，读者可以进去debug这个getAcceptableMediaTypes方法看看。 我就不罗嗦了ok。至此，我们走遍了所有的流程。现在，回过头来看。为什么一开始的demo输出了json数据？我们来分析吧。由于我们只配置了，因此使用spring默认的那些转换器。很明显，我们看到了2个要看能不能转换，得看HttpMessageConverter接口的public boolean canWrite(Class clazz, M

9、ediaType mediaType)方法是否返回true来决定的。我们先分析SourceHttpMessageConverter：它的canWrite方法被父类AbstractHttpMessageConverter重写了。发现SUPPORTED_CLASSES中没有Map类(本文demo返回的是Map类)，因此不支持。下面看Jaxb2RootElementHttpMessageConverter：这个类直接重写了canWrite方法。需要有最终MappingJackson2HttpMessageConverter匹配，进行json转换。（为何匹配，请读者自行查看源码）实例讲解我们分析了转换

10、器的转换过程之后，下面就通过实例来验证我们的结论吧。首先，我们先把之前已经分析，默认的转换器中是支持由于Map是jdk源码中的部分，因此我们用Employee来做demo。因此，Controller加上一个方法：RequestMapping(/)ResponseBodypublic Employee return employeeService.getById(1);实体中加上结果如下：我们发现，解析成了这里为什么解析成之前分析过，消息转换器是根据class和mediaType决定的。我们使用firebug看到：我们发现Accept有我们再来验证，同一地址，HTTP头部不同Accept。看是否

11、正确。$.ajax( url: $request.contextPath/employee/, success: function(res) console.log(res); , headers: Accept: application/ );$.ajax( url: $request.contextPath/employee/, success: function(res) console.log(res); , headers: Accept: application/json );验证成功。关于配置如果不想使用中默认的RequestMappingHandlerAdapter的话，我们可以在重新定义这个bean，spring会覆盖掉默认的RequestMappingHandlerAdapter。 或者如果只想换messageConverters的话。 如果还想用其他converters的话。以上是spring-mvc jar包中的converters。这里我们使用转换这个converter里面使用了marshaller进行转换我们这里使用XStreamMarshaller。json没有转换器，返回406.至于使用这种方式，pom别忘记了加入xstream的依赖： com.thoughtworks.x