SpringMVC：与前台的json数据交互以及底层实现

喜欢ヅ旅行 2022-05-20 05:13 182阅读 0赞

转自：[https://www.cnblogs.com/love540376/p/6912637.html][https_www.cnblogs.com_love540376_p_6912637.html]

转自：[https://www.cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html][https_www.cnblogs.com_fangjian0423_p_springMVC-xml-json-convert.html]

#### 总结： ####

前台传过来的方式有两种，一种是传json格式的数据过来，另一种就是在url的末尾传普通的key/value串过来，针对这两种方式，在Controller类中会有不同的解析，但是在Controller类中返回的json格式的数据都是一样的。

@RequestBody注解用于读取http请求的内容(字符串)，通过SpringMVC提供的HttpMessageConverter接口将读到的内容转换为json、xml等格式的数据并绑定到Controller类方法的参数上。

另一种就是在url的末尾传普通的key/value串过来，不需要@RequestBody注解，将json传转成jaava对象

**SpringMVC默认用MappingJacksonHttpMessageConverter对json数据进行转换，需要加入jackson的包**

#### **原文：** ####

json数据格式在接口调用中、html页面中比较常用，json格式比较简单，解析也比较方便，所以使用很普遍。在SpringMVC中，也支持对json数据的解析和转换，这篇文章主要总结一下在SpringMVC中如何和前台交互json数据。

# 两种交互形式 #

SpringMVC和前台交互主要有两种形式，如下图所示：   
![48590-20170527140316950-1204883095.png][]  
可以看出，前台传过来的方式有两种，一种是传json格式的数据过来，另一种就是在url的末尾传普通的key/value串过来，针对这两种方式，在Controller类中会有不同的解析，但是在Controller类中返回的json格式的数据都是一样的。下面来具体分析一下SpringMVC是如何与前台进行json数据的交互的。在讲之前先认识两个注解。

# @RequestBody注解 #

@RequestBody注解用于读取http请求的内容(字符串)，通过SpringMVC提供的HttpMessageConverter接口将读到的内容转换为json、xml等格式的数据并绑定到Controller类方法的参数上。   
本例子应用：@RequestBody注解实现接收http请求的json数据，将json数据转换为java对象。如下：   
![48590-20170527140328825-1849477734.png][]

![48590-20170527140344419-1742253803.png][]

# @ResponseBody注解 #

@ResponseBody注解用于将Controller类的方法返回的对象，通过HttpMessageConverter接口转换为指定格式的数据如：json、xml等，通过Response响应给客户端。   
本例子应用：@ResponseBody注解实现将Controller类方法返回对象转换为json响应给客户端，如下：   
![48590-20170527140357779-25279971.png][]

![48590-20170527140545669-1401070681.png][]  
经过我如此细致地讲解，想必大家已认识到这两个注解的意思了。好了，下面来具体分析一下SpringMVC是如何与前台进行json数据的交互的。

# 环境的准备 #

## 加载json的jar包 ##

SpringMVC默认用MappingJacksonHttpMessageConverter对json数据进行转换，需要加入jackson的包，又因为SpringMVC3和SpringMVC4针对json交互的jar包有区别，我用的是SpringMVC4，需要导入如下三个jar包：   
![48590-20170527140627857-1048637068.png][]   
读者千万不要忘了导入jQuery的类库，因为我是使用jQuery的ajax提交json串的，就像下图这样：   
![48590-20170527140637622-2073293882.png][]

## 配置json转换器 ##

配置json转换器有两种方式，如果是配置了注解适配器org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter的话，需要在该适配器中配置json转换器，如下：

<bean id="stringConverter" class="org.springframework.http.converter.StringHttpMessageConverter"> <property name="supportedMediaTypes"> <list> <value>text/plain;charset=UTF-8</value> </list> </property> </bean> <bean id="jsonConverter" class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"></bean> <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"> <property name="messageConverters"> <list> <ref bean="stringConverter" /> <ref bean="jsonConverter" /> </list> </property> </bean>

但是如果使用`<mvc:annotation-driven />`注解驱动的话就不用以上的配置了，默认已经配好了。建议使用这种，比较方便。

# json交互的测试 #

这里，我使用jQuery的ajax提交json串，对输出的json结果进行解析。前台的程序如下：

<button onclick="sendJson()">json数据交互测试</button> <script type="text/javascript"> function sendJson() { $.ajax({ type:"post", url:"${pageContext.request.contextPath }/item/json_test.action", data:'{"id":"1","name":"电冰箱","price":"1999"}', contentType:"application/json;charset=utf-8", success:function(data) { alert(data.id + ":" + data.name); } }); } </script>

那么前台itemList.jsp页面的内容就应改造为：   
![48590-20170527140656810-388787205.png][]  
接着编辑ItemController类，并在该类中编写如下方法：

// JSON数据交互 // @RequestBody：接收json数据并转换成pojo对象 // @ResponseBody：响应json数据，把pojo对象转换成json数据并响应 @RequestMapping("/json_test") @ResponseBody public Items jsonTest(@RequestBody Items items) { return items; }

由于前台传的是id、name和price三个属性，所以在后台就用Items类来接收了，这个类中也有这三个属性。重点是@RequestBody注解，它是将前台传过来的json串转换成items对象，然后再将该对象return回去，通过@ResponseBody注解将items对象转成json格式返回给前台。这样前台接收到了后就可以解析了。我们看一下测试的结果：   
![48590-20170527140714419-1538346551.png][]  
响应的结果，null表示空值而已，这里就返回了原对象，也就只有id、name和price属性。   
![48590-20170527140758325-95009939.png][]

springmvc与前台json数据的交互就总结这么多。

============================================================

## [SpringMVC关于json、xml自动转换的原理研究\[附带源码分析\]][https_www.cnblogs.com_fangjian0423_p_springMVC-xml-json-convert.html] ##

# 目录 #

*  [前言][Link 1]
 *  [现象][Link 2]
 *  [源码分析][Link 3]
 *  [实例讲解][Link 4]
 *  [关于配置][Link 5]
 *  [总结][Link 6]
 *  [参考资料][Link 7]

# 前言 #

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

如果有同学对它不熟悉，那么请参考它的入门blog：[http://www.cnblogs.com/fangjian0423/p/springMVC-introduction.html][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：

![复制代码][copycode.gif]

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

![复制代码][copycode.gif]

直接访问地址：

![101449596675807.png][]

我们看到，短短几行配置。使用@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消息转换接口。有关这方面的知识大家可以参考"参考资料"中的[第二条链接][Link 8]，里面讲的很清楚。

![101510002604230.png][]

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

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

![101606162131470.png][]

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

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

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

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

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

![101611179016436.png][]

私有方法:getMessageConverters

![101630232136603.png][]

从代码中我们可以，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等。

我们看到这么一段：

![101640298384297.png][]

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

![101641297132356.png][]

其中ClassUtils中的isPresent方法如下：

![101643277139672.png][]

看到这里，读者应该明白了为什么本文一开始在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][http_www.cnblogs.com_fangjian0423_p_springMVC-request-param-analysis.html]。然后找到对应的HandlerMethodReturnValueHandler对结果值进行处理。

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

RequestResponseBodyMethodProcessor的supportsReturnType方法：

![101803027605809.png][]

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

![101803105889900.png][]

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

具体的转换方法：

![101809037135949.png][]

![102031439173571.png][]

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

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

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

我们来分析吧。

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

![101816581047144.png][]

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

我们先分析SourceHttpMessageConverter：

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

![101830573234896.png][]

![101832284176592.png][]

![101832352929525.png][]

发现SUPPORTED\_CLASSES中没有Map类(本文demo返回的是Map类)，因此不支持。

下面看Jaxb2RootElementHttpMessageConverter：

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

![101838053851073.png][]

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

最终MappingJackson2HttpMessageConverter匹配，进行json转换。（为何匹配，请读者自行查看源码）

# 实例讲解 #

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

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

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

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

因此，Controller加上一个方法：

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

实体中加上@XmlRootElement注解

![101903141989122.png][]

结果如下：

![101904598389030.png][]

我们发现，解析成了xml。

这里为什么解析成xml，而不解析成json呢？

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

我们使用firebug看到：

![102222464019898.png][]

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

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

![复制代码][copycode.gif]

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

![复制代码][copycode.gif]

![102231412601968.png][]

![复制代码][copycode.gif]

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

![复制代码][copycode.gif]

![102231514794990.png][]

验证成功。

# 关于配置 #

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

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

或者如果只想换messageConverters的话。

如果还想用其他converters的话。

![102311480731629.png][]

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

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

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

![102313161827280.png][]

我们这里使用XStreamMarshaller。

![102319292603758.png][]

![102319412294581.png][]

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_HeliosFly_blog_205343]

[http://my.oschina.net/lichhao/blog/172562][Link 8]

[http://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html][http_docs.spring.io_spring_docs_current_spring-framework-reference_html_mvc.html]

[https_www.cnblogs.com_love540376_p_6912637.html]: https://www.cnblogs.com/love540376/p/6912637.html
[https_www.cnblogs.com_fangjian0423_p_springMVC-xml-json-convert.html]: https://www.cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html
[48590-20170527140316950-1204883095.png]: /images/20220520/93ecc26f4ebd49daa381b86ba8893c43.png
[48590-20170527140328825-1849477734.png]: /images/20220520/482775a853284424aae3fb563b6cd91d.png
[48590-20170527140344419-1742253803.png]: /images/20220520/3bd78937fdbf41a5b6b52147c0eb0614.png
[48590-20170527140357779-25279971.png]: /images/20220520/e8d3471ee5584f86a1bff8de19a1cc87.png
[48590-20170527140545669-1401070681.png]: /images/20220520/ba8d20d1f4a84cf8a0439f6cfbdc4f45.png
[48590-20170527140627857-1048637068.png]: /images/20220520/ea46b92a02564a74a7b08642a2e78c7e.png
[48590-20170527140637622-2073293882.png]: /images/20220520/64278f7c7f1f4be5b641617dfed5c988.png
[48590-20170527140656810-388787205.png]: /images/20220520/769f484d44ff41f59470b543a135ee46.png
[48590-20170527140714419-1538346551.png]: /images/20220520/d3b1be612a0b4f439cd28b92d118b5bd.png
[48590-20170527140758325-95009939.png]: /images/20220520/0ce5eee497184146893170ca782f8988.png
[Link 1]: https://www.cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html#preface
[Link 2]: https://www.cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html#phenomenon
[Link 3]: https://www.cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html#analysis
[Link 4]: https://www.cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html#demo
[Link 5]: https://www.cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html#config
[Link 6]: https://www.cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html#summary
[Link 7]: https://www.cnblogs.com/fangjian0423/p/springMVC-xml-json-convert.html#reference
[http_www.cnblogs.com_fangjian0423_p_springMVC-introduction.html]: http://www.cnblogs.com/fangjian0423/p/springMVC-introduction.html
[copycode.gif]: /images/20220520/256010deaa5b4e2c89386fd1075cf482.png
[101449596675807.png]: /images/20220520/846166ee1e17495bbb5e2d0e71d0cb8b.png
[Link 8]: http://my.oschina.net/lichhao/blog/172562
[101510002604230.png]: /images/20220520/85a23d1eb7ea44e28a764663f3803f3d.png
[101606162131470.png]: /images/20220520/1bad9cc4ce254c87807a84b7eec586da.png
[101611179016436.png]: /images/20220520/2ec8826328b74c87bd16c0d76d785292.png
[101630232136603.png]: /images/20220520/c18e7690916842839d256c7563ed5f7f.png
[101640298384297.png]: /images/20220520/82e5f2f3a80f4147a5ae2901f3522b03.png
[101641297132356.png]: /images/20220520/8e1d830b209c47fa99d0e49a1a119c83.png
[101643277139672.png]: /images/20220520/c8ec6b3bde294312beb4a49f79ccba8e.png
[http_www.cnblogs.com_fangjian0423_p_springMVC-request-param-analysis.html]: http://www.cnblogs.com/fangjian0423/p/springMVC-request-param-analysis.html
[101803027605809.png]: /images/20220520/0819bb508009415691202f9b54d90dc5.png
[101803105889900.png]: /images/20220520/be7f99ecdc834a23a3c0c3c96a52ea11.png
[101809037135949.png]: /images/20220520/ec872a752d8c45b898a2774f35a9c3cb.png
[102031439173571.png]: /images/20220520/22e53aa8016e4aa1b35649d3b908eebd.png
[101816581047144.png]: /images/20220520/4c55758b6e3d41cf8354647a69fcc9a0.png
[101830573234896.png]: /images/20220520/1684b903e73945889c38f1c14895b233.png
[101832284176592.png]: /images/20220520/9d4f6ea62b534587be663ce1b9ca7b28.png
[101832352929525.png]: /images/20220520/8851544bffbb4695b769fbeb22652f78.png
[101838053851073.png]: /images/20220520/91343ebf220848d3848abaf09b5406d9.png
[101903141989122.png]: /images/20220520/ccd9e700ddde44acb03cf1fe9ba2ea00.png
[101904598389030.png]: /images/20220520/18ee496ae0f942dc8c238c6c594cc3c6.png
[102222464019898.png]: /images/20220520/15d7a36566e241988d8495160a4dada4.png
[102231412601968.png]: /images/20220520/6251e45f44b54f5c8aa089895da9d2a8.png
[102231514794990.png]: /images/20220520/aeb935903fe94cf2996245ee826b49d7.png
[http_www.cnblogs.com_fangjian0423_p_spring-Ordered-interface.html]: http://www.cnblogs.com/fangjian0423/p/spring-Ordered-interface.html
[102311480731629.png]: /images/20220520/71016dab69144b518ed8889660ed78a5.png
[102313161827280.png]: /images/20220520/b85674f05cb0431f81c145cca358c6c0.png
[102319292603758.png]: /images/20220520/ca220af11a11417f90afe6a141793388.png
[102319412294581.png]: /images/20220520/a573fab87f554ca08691f2d22da0e51b.png
[http_my.oschina.net_HeliosFly_blog_205343]: http://my.oschina.net/HeliosFly/blog/205343
[http_docs.spring.io_spring_docs_current_spring-framework-reference_html_mvc.html]: http://docs.spring.io/spring/docs/current/spring-framework-reference/html/mvc.html