为什么Spring MVC能自动转换json/xml,你研究过它背后的原理吗?

  1. 云栖社区>
  2. 云栖号资讯>
  3. 博客>
  4. 正文

为什么Spring MVC能自动转换json/xml,你研究过它背后的原理吗?

云栖号资讯小哥 2020-03-30 11:20:58 浏览386
展开阅读全文

云栖号资讯:【点击查看更多行业资讯
在这里您可以找到不同行业的第一手的上云资讯,还在等什么,快来!

前言

SpringMVC是目前主流的Web MVC框架之一。

现象

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

我们先来看一看对应的现象。我们这里的配置文件 *-dispatcher.xml中的关键配置如下(其他常规的配置文件不在讲解,可参考本文一开始提到的入门blog):
(视图配置省略)

BB8BF9EA_0E82_4175_BF86_AADAD1D9BEB6

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

36095799_B586_4d4e_8E85_7010066614DE

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

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

0D7CB7F7_528B_46a3_8ACE_C6140473C1FF

直接访问地址:

45F245DC_1508_44f9_B272_895C926375D5

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

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

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

源码分析

本文使用的spring版本是4.0.2。

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

HttpMessageConverter接口就是Spring提供的http消息转换接口。有关这方面的知识大家可以参考"参考资料"中的第二条链接,里面讲的很清楚。

FC644F55_6015_4b82_ABFB_F85C0E725590

下面开始分析这句配置:

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

718BFC21_DE61_4940_8386_76BB96D92D34

在AnnotationDrivenBeanDefinitionParser源码的152行parse方法中:
分别实例化了RequestMappingHandlerMapping,ConfigurableWebBindingInitializer,RequestMappingHandlerAdapter等诸多类。

其中RequestMappingHandlerMapping和RequestMappingHandlerAdapter这两个类比较重要。

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

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

D522248E_8A70_457a_A755_C0B1D042C177

私有方法:getMessageConverters

76007796_BEB8_4ae1_9FCC_995674F91A08

从代码中我们可以,RequestMappingHandlerAdapter设置messageConverters的逻辑:

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

67A0DE1C_EE43_4787_AAD7_49EF770CA3DB

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

我们看到这么一段:

16C9063C_3528_480b_970F_4CB959DDB767

这些boolean属性是哪里来的呢,它们是AnnotationDrivenBeanDefinitionParser的静态变量。

41AB0FF5_FD35_4153_8D3F_D13FA15BFA5A

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

的作用读者也明白了。
下面我们看如何通过消息转换器将java对象进行转换的。

RequestMappingHandlerAdapter在进行handle的时候,会委托给HandlerMethod(具体由子类ServletInvocableHandlerMethod处理)的invokeAndHandle方法进行处理,这个方法又转接给HandlerMethodReturnValueHandlerComposite处理。

HandlerMethodReturnValueHandlerComposite维护了一个HandlerMethodReturnValueHandler列表。

HandlerMethodReturnValueHandler是一个对返回值进行处理的策略接口,这个接口非常重要。然后找到对应的HandlerMethodReturnValueHandler对结果值进行处理。

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

RequestResponseBodyMethodProcessor的supportsReturnType方法:

E7E906BC_4901_4576_9824_A196D6DA1CA4

具体的转换方法:

05494151_22CB_464d_B7E9_8FAECD45EEF7

至于为何是请求头部的Accept数据,读者可以进去debug这个getAcceptableMediaTypes方法看看。我就不罗嗦了~~~
ok。至此,我们走遍了所有的流程。

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

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

6152FF1E_A739_4cad_9ABD_28FEC57F743E

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

我们先分析SourceHttpMessageConverter:
它的canWrite方法被父类AbstractHttpMessageConverter重写了。

F671A16E_161C_436f_9858_E37F348C6F3C

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

下面看Jaxb2RootElementHttpMessageConverter:

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

D2B18580_E026_461c_9612_EB93AEC37D99

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

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

实例讲解

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

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

之前已经分析,默认的转换器中是支持xml的。下面我们加上注解试试吧。
由于Map是jdk源码中的部分,因此我们用Employee来做demo。

因此,Controller加上一个方法:

49D5A129_094E_4a13_8E50_20D2FDB67936

实体中加上@XmlRootElement注解

A5491888_D6A7_4721_A19E_8F5E1A48AE0A

我们发现,解析成了xml。

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

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

我们使用firebug看到:

65DADF6F_05C3_4558_866C_BF16F804E541

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

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

D074A5C2_EDC2_4143_8170_691CCF83636A

195A6C59_B83D_4b85_A3FA_69CEEC2131CF

验证成功。

关于配置

如果不想使用中默认的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的话。

0EFF5665_B161_4743_9FE1_32C82F60D382

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

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

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

6D6A15D2_27C1_4c4d_ABB4_2FA1BA7021B0

我们这里使用XStreamMarshaller。

FA7DA4D5_5C9D_469a_AF07_9967120D5295

json没有转换器,返回406.

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

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

73121CB9_2602_403a_9032_EA521F475C7F

总结

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

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

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

【云栖号在线课堂】每天都有产品技术专家分享!
课程地址:https://yqh.aliyun.com/zhibo

立即加入社群,与专家面对面,及时了解课程最新动态!
【云栖号在线课堂 社群】https://c.tb.cn/F3.Z8gvnK

原文发布时间:2020-03-29
本文作者:互联网架构师
本文来自:“互联网架构师 微信公众号”,了解相关信息可以关注“互联网架构师

网友评论

登录后评论
0/500
评论
云栖号资讯小哥
+ 关注
所属团队号: 云栖号资讯