SpringMVC源码剖析5：消息转换器HttpMessageConverter与@ResponseBody注解

时间  2019-11-16
标签 springmvc 源码 剖析 消息 转换器 httpmessageconverter responsebody 注解 栏目 Spring 繁體版
原文   原文链接

转自 [SpringMVC关于json、xml自动转换的原理研究[附带源码分析]](https://www.cnblogs.com/fangj...html

本系列文章首发于个人我的博客：https://h2pl.github.io/java

欢迎阅览个人CSDN专栏：Spring源码解析 https://blog.csdn.net/column/...ios

部分代码会放在个人的Github：https://github.com/h2pl/
<!-- more -->git

目录

前言

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

若是有同窗对它不熟悉，那么请参考它的入门blog：http://www.cnblogs.com/fangjian0423/p/springMVC-introduction.htmlweb

现象

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

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

(视图配置省略)json

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

pom中须要有如下依赖(Spring依赖及其余依赖不显示)：segmentfault

<dependency>
  <groupId>org.codehaus.jackson</groupId>
  jackson-core-asl
  <version>1.9.13</version>
</dependency>
<dependency>
  <groupId>org.codehaus.jackson</groupId>
  jackson-mapper-asl
  <version>1.9.13</version>
</dependency>

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

ok。咱们在Controller中添加一个method：

复制代码

<pre>@RequestMapping("/xmlOrJson")
@ResponseBody public Map<String, Object> xmlOrJson() {

Map<String, Object> map = new HashMap<String, Object>();
map.put("list", employeeService.list()); return map;

}</pre>

复制代码

直接访问地址：

咱们看到，短短几行配置。使用@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加上一个方法：

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

实体中加上@XmlRootElement注解

结果以下：

咱们发现，解析成了xml。

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

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

咱们使用firebug看到：

咱们发现Accept有xml，没有json。所以解析成xml了。

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

复制代码

<pre>$.ajax({

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

});</pre>

复制代码

复制代码

<pre>$.ajax({

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

});</pre>

复制代码

验证成功。

关于配置

若是不想使用<mvc:annotation-driven/>中默认的RequestMappingHandlerAdapter的话，咱们能够在从新定义这个bean，spring会覆盖掉默认的RequestMappingHandlerAdapter。

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

<pre> `<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>` </pre>

或者若是只想换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>
  xstream
  <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

详解RequestBody和@ResponseBody注解

概述 在SpringMVC中，可使用@RequestBody和@ResponseBody两个注解，分别完成请求报文到对象和对象到响应报文的转换，底层这种灵活的消息转换机制，就是Spring3.x中新引入的HttpMessageConverter即消息转换器机制。

Http请求的抽象 仍是回到请求-响应，也就是解析请求体，而后返回响应报文这个最基本的Http请求过程当中来。咱们知道，在servlet标准中，能够用javax.servlet.ServletRequest接口中的如下方法：

public ServletInputStream getInputStream() throws IOException;

来获得一个ServletInputStream。这个ServletInputStream中，能够读取到一个原始请求报文的全部内容。一样的，在javax.servlet.ServletResponse接口中，能够用如下方法：

public ServletOutputStream getOutputStream() throws IOException;

来获得一个ServletOutputStream，这个ServletOutputSteam，继承自java中的OutputStream，可让你输出Http的响应报文内容。

让咱们尝试着像SpringMVC的设计者同样来思考一下。咱们知道，Http请求和响应报文本质上都是一串字符串，当请求报文来到java世界，它会被封装成为一个ServletInputStream的输入流，供咱们读取报文。响应报文则是经过一个ServletOutputStream的输出流，来输出响应报文。

咱们从流中，只能读取到原始的字符串报文，一样，咱们往输出流中，也只能写原始的字符。而在java世界中，处理业务逻辑，都是以一个个有业务意义的对象为处理维度的，那么在报文到达SpringMVC和从SpringMVC出去，都存在一个字符串到java对象的阻抗问题。这一过程，不可能由开发者手工转换。咱们知道，在Struts2中，采用了OGNL来应对这个问题，而在SpringMVC中，它是HttpMessageConverter机制。咱们先来看两个接口。

HttpInputMessage 这个类是SpringMVC内部对一次Http请求报文的抽象，在HttpMessageConverter的read()方法中，有一个HttpInputMessage的形参，它正是SpringMVC的消息转换器所做用的受体“请求消息”的内部抽象，消息转换器从“请求消息”中按照规则提取消息，转换为方法形参中声明的对象。

package org.springframework.http;

import java.io.IOException;
import java.io.InputStream;

public interface HttpInputMessage extends HttpMessage {

    InputStream getBody() throws IOException;

}

HttpOutputMessage 这个类是SpringMVC内部对一次Http响应报文的抽象，在HttpMessageConverter的write()方法中，有一个HttpOutputMessage的形参，它正是SpringMVC的消息转换器所做用的受体“响应消息”的内部抽象，消息转换器将“响应消息”按照必定的规则写到响应报文中。

package org.springframework.http;

import java.io.IOException;
import java.io.OutputStream;

public interface HttpOutputMessage extends HttpMessage {

    OutputStream getBody() throws IOException;

}

HttpMessageConverter 对消息转换器最高层次的接口抽象，描述了一个消息转换器的通常特征，咱们能够从这个接口中定义的方法，来领悟Spring3.x的设计者对这一机制的思考过程。

package org.springframework.http.converter;

import java.io.IOException;
import java.util.List;

import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;

public interface HttpMessageConverter<T> {

    boolean canRead(Class<?> clazz, MediaType mediaType);

    boolean canWrite(Class<?> clazz, MediaType mediaType);

    List<MediaType> getSupportedMediaTypes();

    T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
            throws IOException, HttpMessageNotReadableException;

    void write(T t, MediaType contentType, HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException;

}

HttpMessageConverter接口的定义出现了成对的canRead()，read()和canWrite()，write()方法，MediaType是对请求的Media Type属性的封装。举个例子，当咱们声明了下面这个处理方法。

@RequestMapping(value="/string", method=RequestMethod.POST)
public @ResponseBody String readString(@RequestBody String string) {
    return "Read string '" + string + "'";
}

在SpringMVC进入readString方法前，会根据@RequestBody注解选择适当的HttpMessageConverter实现类来将请求参数解析到string变量中，具体来讲是使用了StringHttpMessageConverter类，它的canRead()方法返回true，而后它的read()方法会从请求中读出请求参数，绑定到readString()方法的string变量中。

当SpringMVC执行readString方法后，因为返回值标识了@ResponseBody，SpringMVC将使用StringHttpMessageConverter的write()方法，将结果做为String值写入响应报文，固然，此时canWrite()方法返回true。

咱们能够用下面的图，简单描述一下这个过程。

消息转换图

RequestResponseBodyMethodProcessor 将上述过程集中描述的一个类是org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor，这个类同时实现了HandlerMethodArgumentResolver和HandlerMethodReturnValueHandler两个接口。前者是将请求报文绑定处处理方法形参的策略接口，后者则是对处理方法返回值进行处理的策略接口。两个接口的源码以下：

package org.springframework.web.method.support;

import org.springframework.core.MethodParameter;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;

public interface HandlerMethodArgumentResolver {

    boolean supportsParameter(MethodParameter parameter);

    Object resolveArgument(MethodParameter parameter,
                           ModelAndViewContainer mavContainer,
                           NativeWebRequest webRequest,
                           WebDataBinderFactory binderFactory) throws Exception;

}

package org.springframework.web.method.support;

import org.springframework.core.MethodParameter;
import org.springframework.web.context.request.NativeWebRequest;

public interface HandlerMethodReturnValueHandler {

    boolean supportsReturnType(MethodParameter returnType);

    void handleReturnValue(Object returnValue,
                           MethodParameter returnType,
                           ModelAndViewContainer mavContainer,
                           NativeWebRequest webRequest) throws Exception;

}

RequestResponseBodyMethodProcessor这个类，同时充当了方法参数解析和返回值处理两种角色。咱们从它的源码中，能够找到上面两个接口的方法实现。

对HandlerMethodArgumentResolver接口的实现：

public boolean supportsParameter(MethodParameter parameter) {
    return parameter.hasParameterAnnotation(RequestBody.class);
}

public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
        NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {

    Object argument = readWithMessageConverters(webRequest, parameter, parameter.getGenericParameterType());

    String name = Conventions.getVariableNameForParameter(parameter);
    WebDataBinder binder = binderFactory.createBinder(webRequest, argument, name);

    if (argument != null) {
        validate(binder, parameter);
    }

    mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());

    return argument;
}

对HandlerMethodReturnValueHandler接口的实现

public boolean supportsReturnType(MethodParameter returnType) {
    return returnType.getMethodAnnotation(ResponseBody.class) != null;
}

    public void handleReturnValue(Object returnValue, MethodParameter returnType,
        ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
        throws IOException, HttpMediaTypeNotAcceptableException {

    mavContainer.setRequestHandled(true);
    if (returnValue != null) {
        writeWithMessageConverters(returnValue, returnType, webRequest);
    }
}

看完上面的代码，整个HttpMessageConverter消息转换的脉络已经很是清晰。由于两个接口的实现，分别是以是否有@RequestBody和@ResponseBody为条件，而后分别调用HttpMessageConverter来进行消息的读写。

若是你想问，怎么样跟踪到RequestResponseBodyMethodProcessor中，请你按照前面几篇博文的思路，而后到这里spring-mvc-showcase下载源码回来，对其中HttpMessageConverter相关的例子进行debug，只要你肯下功夫，相信你必定会有属于本身的收获的。

思考 张小龙在谈微信的本质时候说：“微信只是个平台，消息在其中流转”。在咱们对SpringMVC源码分析的过程当中，咱们能够从HttpMessageConverter机制中领悟到相似的道理。在SpringMVC的设计者眼中，一次请求报文和一次响应报文，分别被抽象为一个请求消息HttpInputMessage和一个响应消息HttpOutputMessage。

处理请求时，由合适的消息转换器将请求报文绑定为方法中的形参对象，在这里，同一个对象就有可能出现多种不一样的消息形式，好比json和xml。一样，当响应请求时，方法的返回值也一样可能被返回为不一样的消息形式，好比json和xml。

在SpringMVC中，针对不一样的消息形式，咱们有不一样的HttpMessageConverter实现类来处理各类消息形式。可是，只要这些消息所蕴含的“有效信息”是一致的，那么各类不一样的消息转换器，都会生成一样的转换结果。至于各类消息间解析细节的不一样，就被屏蔽在不一样的HttpMessageConverter实现类中了。

图片描述

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程