SpringMVC关于json、xml自动转换的原理研究[附带源码分析]

目录

前言

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

如果有同学对它不熟悉,那么请参考它的入门blog:http://www.cnblogs.com/fangjian0423/p/springMVC-introduction.html

现象

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

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

(视图配置省略)

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

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")
@ResponseBody
public Map<String, Object> xmlOrJson() {Map<String, Object> map = new HashMap<String, Object>();map.put("list", employeeService.list());return map;
}
复制代码
复制代码

直接访问地址:

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

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

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

源码分析

本文使用的spring版本是4.0.2。  

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

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

下面开始分析<mvc:annotation-driven/>这句配置:

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

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

分别实例化了RequestMappingHandlerMapping,ConfigurableWebBindingInitializer,RequestMappingHandlerAdapter等诸多类。

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

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

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

私有方法:getMessageConverters

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

1.如果<mvc:annotation-driven>节点有子节点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等。

我们看到这么一段:

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

 其中ClassUtils中的isPresent方法如下:

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

<mvc:annotation-driven>的作用读者也明白了。

下面我们看如何通过消息转换器将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方法:

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

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

具体的转换方法:

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

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

 

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

我们来分析吧。

 

由于我们只配置了<mvc:annotation-driven>,因此使用spring默认的那些转换器。

很明显,我们看到了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")
@ResponseBody
public 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"}
});
复制代码
复制代码

验证成功。

关于配置

如果不想使用<mvc:annotation-driven/>中默认的RequestMappingHandlerAdapter的话,我们可以在重新定义这个bean,spring会覆盖掉默认的RequestMappingHandlerAdapter。

为何会覆盖,请参考楼主的另外一篇博客:http://www.cnblogs.com/fangjian0423/p/spring-Ordered-interface.html

    <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的话。

以上是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还有很多内容,以后自己研究其他内容的时候还会与大家一起共享的。

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

参考资料

http://my.oschina.net/HeliosFly/blog/205343

http://my.oschina.net/lichhao/blog/172562

http://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/419376.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

“睡服”面试官系列第三篇之变量的结构赋值(建议收藏学习)

目录 变量的解构赋值 1. 数组的解构赋值 2. 对象的解构赋值 3. 字符串的解构赋值 4. 数值和布尔值的解构赋值 5. 函数参数的解构赋值 6. 圆括号问题 7. 用途 变量的解构赋值 1. 数组的解构赋值 基本用法 ES6 允许按照一定模式&#xff0c;从数组和对象中提取值&#…

【宋红康程序思想学习日记3】杨辉三角

class Shuzu3 { public static void main(String[] args) {    int[][] yanghuinew int[10][];   //初始化二维数组   for(int i0;i<yanghui.length;i){     yanghui[i]new int[i1]; }   for(int i0;i<yanghui.length;i){     for(int j0;j<yanghui…

Android为网络请求自定义加载动画

android自带的加载动画都不怎么好看&#xff0c;在这里介绍一种自定义加载动画的方法 原始图片&#xff1a; 编写动画progressbar.xml, <?xml version"1.0" encoding"utf-8"?> <animated-rotate android:drawable"drawable/publicloading&…

mybatis在xml文件中处理大于号小于号的方法

第一种方法&#xff1a; 用了转义字符把>和<替换掉&#xff0c;然后就没有问题了。 SELECT * FROM test WHERE 1 1 AND start_date < CURRENT_DATE AND end_date > CURRENT_DATE 附&#xff1a;XML转义字符 < …

Android之Notification初识

1.Notification创建 首先&#xff0c;介绍一下&#xff0c;创建一个通知所需要用到的类和方法NotificationManager类 NotificationManager类是用来管理系统的所有通知的类&#xff0c;该类的对象必须通过Context类的getSystemService()方法获取。完整代码&#xff1a; Notifica…

MyBatis参数传入集合之foreach动态sql

foreach的主要用在构建in条件中&#xff0c;它可以在SQL语句中进行迭代一个集合。foreach元素的属性主要有item&#xff0c;index&#xff0c;collection&#xff0c;open&#xff0c;separator&#xff0c;close。item表示集合中每一个元素进行迭代时的别名&#xff0c;index指…

“睡服”面试官系列第四篇之字符串的扩展(建议收藏学习)

目录 字符串的扩展 1. 字符的 Unicode 表示法 2. codePointAt() 3. String.fromCodePoint() 4. 字符串的遍历器接口 5. at() 6. normalize() 7. includes(), startsWith(), endsWith() 8. repeat() 9. padStart()&#xff0c;padEnd() 10. 模板字符串 11. 实例&…

Chapter 5 Exercises Problems

转载于:https://www.cnblogs.com/momoko/p/4931714.html

Android之Notification制作多媒体控制器

上一篇讲述了Notification的基础用法&#xff0c;本篇将介绍&#xff0c;自定义通知栏&#xff0c;并利用讲到的内容&#xff0c;实现一个简单的音乐播发器。 1.自定义通知的实现&#xff1b; Notification有一个contentView属性&#xff0c;该属性接受的对象是RemoteView对象&…

MyBatis 多表联合查询及优化

关于优化 对于优化嘛&#xff0c;我这里简单的提几点&#xff0c;大家可以考虑一下。首先&#xff0c;就是对表的设计&#xff0c;在设计表初期&#xff0c;不仅仅要考虑到数据库的规范性&#xff0c;还好考虑到所谓的业务&#xff0c;以及对性能的影响&#xff0c;比如&#x…

React Native windows环境安装遇到的坑

在官方中文文档中&#xff08;http://reactnative.cn/docs/0.37/getting-started.html&#xff09;有一段话是&#xff1a;使用Chocolatey来安装NodeJS。注意&#xff0c;目前已知Node 7.1版本在windows上无法正常工作&#xff0c;请注意避开这个版本&#xff01; 如何避开&…

linux指令查看tomcat日志

实际开发中经常遇到查看远程tomcat日志&#xff0c;来查找原因:因此总结了一些常用的linux指令 1、先切换到&#xff1a;cd usr/local/tomcat5/logs 2、tail -f catalina.out3、这样运行时就可以实时查看运行日志了 Ctrlc 是退出tail命令。 其他常用的linux指令整理&#x…

iptables对请求的URL作IP访问控制

服务器运行环境是Tomcat&#xff0c;现在要实现的目的是&#xff0c;只允许特定的IP访问某个目录&#xff0c;一种方法是在tomcat配置文件server.conf中&#xff0c;使用RemoteAddrValve对虚拟主机做访问控制。另外一种方法可以通过iptables规则。个人比较喜欢iptables例如&…

React-Native填坑之TextInput value属性

TextInput用法就不多讲了&#xff0c;主要记录下遇到的一个怪问题。 背景&#xff1a;项目需要开发一个充值页面&#xff0c;需要一个输入框&#xff0c;然后几个按钮&#xff0c;输入框是允许用户自己输入任意金额&#xff0c;按钮是可以让用户快捷选择金额。那么问题来了&…

Spring的特点

Spring框架Spring框架是一个分层架构,有7个定义良好的模块组成spring模块构建在核心容器智之上, 核心容器定义了创建、 配置、和管理bean的方式组成spring框架的每个模块(或组件)都可以单独存在, 或者与其他一个或多个模块联合实现 模块如下: 1--核心容器 核心容器提供spring框…