SpringMVC源码阅读:Json,Xml自动转换

1.前言SpringMVC是目前J2EE平台的主流Web框架,不熟悉的园友可以看SpringMVC源码阅读入门,它交代了SpringMVC的基础知识和源码阅读的技巧本文将通过源码(基于Spring4.3.7)分析,弄清楚SpringMVC如何实现Json,Xml的转换2.源码分析测试方法,浏览器输入http://localhost:8080/springmvcdemo/employee/xmlOr...

SpringMVC源码阅读:Json,Xml自动转换

1.前言

SpringMVC是目前J2EE平台的主流Web框架,不熟悉的园友可以看SpringMVC源码阅读入门,它交代了SpringMVC的基础知识和源码阅读的技巧

本文将通过源码(基于Spring4.3.7)分析,弄清楚SpringMVC如何实现Json,Xml的转换

2.源码分析

测试方法,浏览器输入http://localhost:8080/springmvcdemo/employee/xmlOrJson

 @RequestMapping(value="/xmlOrJson",produces={"application/json; charset=UTF-8"}) @ResponseBody public Map<String, Object> xmlOrJson() {  Map<String, Object> map = new HashMap<String, Object>();  map.put("list", employeeService.list());  return map; }

Demo点击这里获取,根据SpringMVC源码阅读:Controller中参数解析我们知道,RequestResponseBodyMethodProcessor支持Json类型数据的转换,我们上回遇到了消息转换器MessageConverter,我没有解释它是什么,这篇文章我们将会揭开它的面纱

那么,我们就从RequestResponseBodyMethodProcessor开始进行分析,在handleReturnValue方法169行打断点,当有@ResponseBody注解时会进入

170行获取请求路径、请求信息

171行获取Content-Type、响应信息

打开writeWithMessageConverters方法,进入AbstractMessageConverterMethodProcessor类

167行声明outputValue用来接收Controller返回值

168行声明valueType接收返回对象类型

183行requestMediaTypes获取Accept-Type

184行producibleMediaTypes获取Content-Type,正是我们在@RequestMapping中配置的produces

190行声明compatibleMediaTypes的Set来获取匹配的MediaTypes,那么它是如何匹配到"application/json"的呢?

191~197行对requestMediaTypes和producibleMediaTypes循环遍历,进行匹配,得到compatibleMediaTypes

我们看看requestMediaTypes

第一到第三个都不是"application/json",第四个使用了终极大招,"*/*"表示所有类型,所以producibleMediaTypes总有类型能与requestMediaTypes匹配上

继续分析writeWithMessageConverters方法

221行获取选中的MediaType

222行遍历HttpMessageConverter

223行判断当前HttpMessageConverter是不是GenericHttpMessageConverter类型

GenericHttpMessageConverter是一个接口,它的实现类如下

根据官网资料,我们知道各种HttpMessageConverter的作用,而MappingJackson2HttpMessageConverter是我们需要的,用以解析Json

我们需要Jackson2.x jar包来支持MappingJackson2HttpMessageConverter

  <dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.6.5</version>  </dependency>  <dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-core</artifactId><version>2.6.5</version>  </dependency>

224行检验当前GenericHttpMessageConverter是否可以被Converter写入

现在我们要弄清楚,HttpMessageConverter从哪里来,我们点击AbstractMessageConverterMethodProcessor类191行this.messageConverters跳转到了AbstractMessageConverterMethodArgumentResolver,AbstractMessageConverterMethodArgumentResolver是AbstractMessageConverterMethodProcessor的父类,messageConverters是AbstractMessageConverterMethodArgumentResolver的属性,ctrl f搜索,我们找到了AbstractMessageConverterMethodArgumentResolver的构造方法初始化了HttpMessageConverter

HttpMessageConverter如下

来自于我们在dispatcher-servlet.xml自定义的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.json.MappingJackson2HttpMessageConverter"/> <bean class="org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter"/> <bean class="org.springframework.http.converter.ResourceHttpMessageConverter"/></list>  </property> </bean>

messageConverters是RequestMappingHandlerAdapter的一个list属性,在RequestMappingHandlerAdapter我们配置了五种HttpMessageConverter,包装成list,并注入到Spring

RequestMappingHandler构造方法给我们加入了默认的HttpMessageConverter,在setMessaageConverters会被我们自定义messageConverters覆盖

this.messageConverters是构造方法加入,messageConverters是我们传入的参数,set方法后于构造方法执行,故覆盖之

再回到AbstractMessageConverterMethodProcessor类writeWithMessageConverters方法,看下224行canWrite做了什么

对canWrite ctrl alt b,根据父类继承关系,我们锁定AbstractGenericHttpMessageConverter

继续点击canWrite方法

在AbstractGenericHttpMessageConverter的父类AbstractHttpMessageConverter里给出了具体实现

根据官网我们知道MappingJackson2HttpMessageConverter负责转换Json,有必要看下该类的canWrite方法

打断点我发现,确实进入了该类的canWrite方法,但是并没有做什么事,真正的逻辑在它的父类AbstractHttpMessageConverter处理,刚才我们已经分析过

Json部分我已经分析完毕,我现在来分析下解析Xml,分析步骤和Json一致,除了解析类不一样

根据官网我们知道,Jaxb2RootElementHttpMessageConverter和MappingJackson2XMLHttpMessageConvert

源文地址:https://www.guoxiongfei.cn/cntech/9602.html