SpringMVC： HttpMessageConverter消息转换器机制

一、概述

在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机制。咱们 先来看两个接口。

2.一、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;

}

2.二、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;

}

2.三、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。

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

2.四、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来进行消息的读写。

三、<mvc:annotation-driven/>初始化7个转换器

• ByteArrayHttpMessageConverter 

• StringHttpMessageConverter 

• ResourceHttpMessageConverter 

• SourceHttpMessageConverter 

• XmlAwareFormHttpMessageConverter 

• Jaxb2RootElementHttpMessageConverter 

• MappingJacksonHttpMessageConverter

对于json的解析就是经过MappingJacksonHttpMessageConverter转换器完成的。

只添加<mvc:annotation-driven />还不行，须要在classpath环境中能找到Jackson包

 <mvc:annotation-driven>  
        <mvc:message-converters register-defaults="true">  
            <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"             p:supportedMediaTypes="/" />  
        </mvc:message-converters>
        <!--注入的message-converters优先级高于默认注入的json转换器-->
    </mvc:annotation-driven>

json依赖包

<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>
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>2.4.4</version>
</dependency>