SpringMVC系列 教程(五):关于json、xml自动转换的原理研究(附...

程序员知识码头

共 4763字,需浏览 10分钟

 ·

2019-12-06 23:23

c690b88b8725945ba78bf9b9da812acb.webp

7961fd30452644ba2fd89f1ec58ac8de.webp

来源:https://0x9.me/9T0Vj

一. 前言


SpringMVC是目前主流的Web MVC框架之一。 上一篇介绍了解了SpringMVC中Controller的方法中参数的工作原理,今天说一说关于json、xml自动转换的原理研究!

二. 现象

本文使用的demo基于maven,是根据入门blog的例子继续写下去的。

我们先来看一看对应的现象。我们这里的配置文件 *-dispatcher.xml中的关键配置如下:

(视图配置省略)

<mvc:resources location="/static/" mapping="/static/**"/><mvc:annotation-driven/><context:component-scan base-package="org.format.demo.controller"/>

pom中需要有以下依赖(Spring依赖及其他依赖不显示):

<dependency>  <groupId>org.codehaus.jacksongroupId>  <artifactId>jackson-core-aslartifactId>  <version>1.9.13version>dependency><dependency>  <groupId>org.codehaus.jacksongroupId>  <artifactId>jackson-mapper-aslartifactId>  <version>1.9.13version>dependency>

这个依赖是json序列化的依赖。

ok。我们在Controller中添加一个method:

@RequestMapping("/xmlOrJson")@ResponseBodypublic Map<String, Object> xmlOrJson() {    Map<String, Object> map = new HashMap<String, Object>();    map.put("list", employeeService.list());    return map;}

直接访问地址:

d99d866cad8bc614cb10ac8f4b448ec0.webp

我们看到,短短几行配置。使用@ResponseBody注解之后,Controller返回的对象 自动被转换成对应的json数据,在这里不得不感叹SpringMVC的强大。

我们好像也没看到具体的配置,唯一看到的就是*-dispatcher.xml中的一句配置:。其实就是这个配置,导致了java对象自动转换成json对象的现象。

那么spring到底是如何实现java对象到json对象的自动转换的呢?为什么转换成了json数据,如果想转换成xml数据,那该怎么办?

三. 源码分析

本文使用的spring版本是4.0.2。 

在讲解这个配置之前,我们先了解下Spring的消息转换机制。@ResponseBody这个注解就是使用消息转换机制,最终通过json的转换器转换成json数据的。

HttpMessageConverter接口就是Spring提供的http消息转换接口。

0272ed83937a7cf6a3b5f97af343c332.webp

下面开始分析这句配置:

这句代码在spring中的解析类是:

c09a87641692f6879e65efe750cdc243.webp

在AnnotationDrivenBeanDefinitionParser源码的152行parse方法中:

分别实例化了

RequestMappingHandlerMapping,ConfigurableWebBindingInitializer,

RequestMappingHandlerAdapter等诸多类。


其中RequestMappingHandlerMapping和

RequestMappingHandlerAdapter这两个类比较重要。


RequestMappingHandlerMapping

处理请求映射的,处理@RequestMapping跟请求地址之间的关系。

RequestMappingHandlerAdapter是请求处理的适配器,也就是请求之后处理具体逻辑的执行,关系到哪个类的哪个方法以及转换器等工作,这个类是我们讲的重点,其中它的属性messageConverters是本文要讲的重点。

b8d10a38651f0319a9266d14115b1c06.webp

私有方法:getMessageConverters

f4b2506e258c18e43f704dbe9f979a29.webp

从代码中我们可以,RequestMappingHandlerAdapter

设置messageConverters的逻辑:

1.如果节点有子节点message-converters,那么它的转换器属性messageConverters也由这些子节点组成。

message-converters的子节点配置如下:

<mvc:annotation-driven>  <mvc:message-converters>    <bean class="org.example.MyHttpMessageConverter"/>    <bean class="org.example.MyOtherHttpMessageConverter"/>  mvc:message-converters>mvc:annotation-driven>

2.message-converters子节点不存在或它的属性register-defaults为true的话,加入其他的转换器:

ByteArrayHttpMessageConverter、

StringHttpMessageConverter、

ResourceHttpMessageConverter等。

我们看到这么一段:

484094153c055a269b3d44da288bf68b.webp

这些boolean属性是哪里来的呢,

它们是AnnotationDrivenBeanDefinitionParser的静态变量。

fcbf6a1c0258b35a046db2588cd1d398.webp

 其中ClassUtils中的isPresent方法如下:

969fe5ff29c1a0cd0163b83f34087535.webp

看到这里,读者应该明白了为什么本文一开始在pom文件中需要加入对应的jackson依赖,为了让json转换器jackson成为默认转换器之一。

的作用读者也明白了。

下面我们看如何通过消息转换器将java对象进行转换的。

 

RequestMappingHandlerAdapter在进行handle的时候,会委托给HandlerMethod

(具体由子类ServletInvocableHandlerMethod处理)

的invokeAndHandle方法进行处理,

这个方法又转接给HandlerMethodReturnValueHandlerComposite处理。

HandlerMethodReturnValueHandlerComposite维护了一个

HandlerMethodReturnValueHandler列表。HandlerMethodReturnValueHandler是一个对返回值进行处理的策略接口,这个接口非常重要。关于这个接口的细节,请参考楼主的另外一篇博客:http://www.cnblogs.com/fangjian0423/p/springMVC-request-param-analysis.html。然后找到对应的HandlerMethodReturnValueHandler对结果值进行处理。

最终找到RequestResponseBodyMethodProcessor这个Handler(由于使用了@ResponseBody注解)。

RequestResponseBodyMethodProcessor的supportsReturnType方法:

d9421f00ee343c0411e790b1d947cbc8.webp

然后使用handleReturnValue方法进行处理:

6fbe6cf60fb3f788ee3528ca3e67a41a.webp

我们看到,这里使用了转换器。  

具体的转换方法:

42aa730e6e9391c410c50c26b39284b6.webp

b41d48abf754f322d0982193d418080c.webp

至于为何是请求头部的Accept数据,读者可以进去debug这个getAcceptableMediaTypes方法看看。我就不罗嗦了~~~

 ok。至此,我们走遍了所有的流程。

 

现在,回过头来看。为什么一开始的demo输出了json数据?

我们来分析吧。

 

由于我们只配置了,因此使用spring默认的那些转换器。

05a5698308691a72878e0ac9faf2d945.webp

很明显,我们看到了2个xml和1个json转换器。 要看能不能转换,得看HttpMessageConverter接口的public boolean canWrite(Class clazz, MediaType mediaType)方法是否返回true来决定的。

我们先分析SourceHttpMessageConverter:

它的canWrite方法被父类AbstractHttpMessageConverter重写了。

c403622c173ce2b734a45928f9f0574f.webp

8359ebaa4c5cc28a76f473bd243eb7a5.webp

2de7ef6adeab10c87dcadbedba52b70a.webp

发现SUPPORTED_CLASSES中没有Map类(本文demo返回的是Map类),因此不支持。

下面看Jaxb2RootElementHttpMessageConverter:

这个类直接重写了canWrite方法。

aeff2792f0f665b370b1b590cc52e0e7.webp

需要有XmlRootElement注解。很明显,Map类当然没有。

最终MappingJackson2HttpMessageConverter匹配,进行json转换。(为何匹配,请读者自行查看源码)

四. 实例讲解

 我们分析了转换器的转换过程之后,下面就通过实例来验证我们的结论吧。

首先,我们先把xml转换器实现。

之前已经分析,默认的转换器中是支持xml的。下面我们加上注解试试吧。

由于Map是jdk源码中的部分,因此我们用Employee来做demo。

因此,Controller加上一个方法:

@RequestMapping("/xmlOrJsonSimple")@ResponseBodypublic Employee xmlOrJsonSimple() {    return employeeService.getById(1);}

实体中加上@XmlRootElement注解

da0ad41e80a412438e238ad5ee3cb754.webp

结果如下:

27674c1bc562100c6dd5a2898e1e0ad1.webp

我们发现,解析成了xml。

这里为什么解析成xml,而不解析成json呢?

 

之前分析过,消息转换器是根据class和mediaType决定的。

我们使用firebug看到:

00121ff37a5fa85669afd43a5bf0317d.webp

我们发现Accept有xml,没有json。因此解析成xml了。

 

我们再来验证,同一地址,HTTP头部不同Accept。看是否正确。

$.ajax({    url: "${request.contextPath}/employee/xmlOrJsonSimple",    success: function(res) {        console.log(res);    },    headers: {        "Accept": "application/xml"    }});

020363f485a950de76c5620c9a1a590d.webp

$.ajax({    url: "${request.contextPath}/employee/xmlOrJsonSimple",    success: function(res) {        console.log(res);    },    headers: {        "Accept": "application/json"    }});

7132cd98f187a307a2a4a10ca607a363.webp

验证成功。

五. 关于配置

如果不想使用

中默认的RequestMappingHandlerAdapter的话,

我们可以在重新定义这个bean,

spring会覆盖掉默认的RequestMappingHandlerAdapter。


<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">  <property name="messageConverters">    <list>      <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter"/>      <bean class="org.springframework.http.converter.StringHttpMessageConverter"/>      <bean class="org.springframework.http.converter.ResourceHttpMessageConverter"/>    list>  property>bean>

或者如果只想换messageConverters的话。

<mvc:annotation-driven>  <mvc:message-converters>    <bean class="org.example.MyHttpMessageConverter"/>    <bean class="org.example.MyOtherHttpMessageConverter"/>  mvc:message-converters>mvc:annotation-driven>

如果还想用其他converters的话。

8f522f98fd7a3104a5343550382a6686.webp

以上是spring-mvc jar包中的converters。

这里我们使用转换xml的MarshallingHttpMessageConverter。

这个converter里面使用了marshaller进行转换

6afa4f4fc06c877fca4220db3e45060d.webp

我们这里使用XStreamMarshaller。  

4ce8f814d944e493eeb8a10a02d7b77f.webp

9a6e519cb480266d5728c0e68a782112.webp

json没有转换器,返回406.

至于xml格式的问题,大家自行解决吧。这里用的是XStream~。

使用这种方式,pom别忘记了加入xstream的依赖:

<dependency>  <groupId>com.thoughtworks.xstreamgroupId>  <artifactId>xstreamartifactId>  <version>1.4.7version>dependency>
六. 小结


 写了这么多,可能读者觉得有点罗嗦。毕竟这也是自己的一些心得,希望都能说出来与读者共享。

刚接触SpringMVC的时候,发现这种自动转换机制很牛逼,但是一直没有研究它的原理,目前,算是了了一个小小心愿吧,SpringMVC还有很多内容,以后自己研究其他内容的时候还会与大家一起共享的。

文章难免会出现一些错误,希望读者们能指明出来。


- End -

8f81892c0d271b9545ebda44323eff89.webp


面试题系列教程  点击--> 面试题技术干货连载目录 跳转


Maven系列教程  点击--> Maven技术干货连载目录 跳转


MyBatis系列教程  点击--> MyBatis技术干货连载目录 跳转


JVM调优总结系列教程  点击--> JVM调优技术干货连载目录 跳转





, 17c283109358487c28fda36c977b4433.webp

浏览 38
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报