SpringMVC源码解析之消息转换器HttpMessageConverter

摘要

springmvc使用消息转换器实现请求报文和对象、对象和响应报文之间的自动转换

在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中，请你按照前面几篇博文的思路，然后到这里下载源码回来，对其中httpmessageconverter相关的例子进行debug，只要你肯下功夫，相信你一定会有属于自己的收获的。

#思考 张小龙在谈微信的本质时候说：“微信只是个平台，消息在其中流转”。在我们对springmvc源码分析的过程中，我们可以从httpmessageconverter机制中领悟到类似的道理。在springmvc的设计者眼中，一次请求报文和一次响应报文，分别被抽象为一个请求消息httpinputmessage和一个响应消息httpoutputmessage。

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

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

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。