消息转换器HttpMessageConverter与@ResponseBody注解介绍（一）

480

前言

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

现象

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

我们先来看一看对应的现象。我们这里的配置文件 *-dispatcher.xml中的关键配置如下：

(视图配置省略)

<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>
  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：

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

直接访问地址：

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

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

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

源码分析

本文使用的spring版本是4.0.2。

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

HttpMessageConverter接口就是Spring提供的http消息转换接口。

下面开始分析mvc:annotation-driven这句配置:</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也由这些子节点组成。</mvc:annotation-driven>

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的作用读者也明白了。</mvc:annotation-driven>

下面我们看如何通过消息转换器将java对象进行转换的。

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

HandlerMethodReturnValueHandlerComposite维护了一个HandlerMethodReturnValueHandler列表。HandlerMethodReturnValueHandler是一个对返回值进行处理的策略接口，这个接口非常重要。然后找到对应的HandlerMethodReturnValueHandler对结果值进行处理。

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

RequestResponseBodyMethodProcessor的supportsReturnType方法：

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

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

具体的转换方法：

至于为何是请求头部的Accept数据，读者可以进去debug这个getAcceptableMediaTypes方法看看。

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

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

我们来分析吧。

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

很明显，我们看到了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转换。（为何匹配，请读者自行查看源码）。

评分

欢迎为Ta评分

消息转换器HttpMessageConverter与@ResponseBody注解介绍（一）

前言

现象

源码分析

Spring专区