SpringMVC源碼解析之消息轉(zhuǎn)換器HttpMessageConverter

更新時間：2017年11月30日 09:09:53 作者：相見歡

本篇文章主要介紹了SpringMVC源碼解析之消息轉(zhuǎn)換器HttpMessageConverter ，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

摘要

SpringMVC使用消息轉(zhuǎn)換器實現(xiàn)請求報文和對象、對象和響應報文之間的自動轉(zhuǎn)換

在SpringMVC中，可以使用@RequestBody和@ResponseBody兩個注解，分別完成請求報文到對象和對象到響應報文的轉(zhuǎn)換，底層這種靈活的消息轉(zhuǎn)換機制，就是Spring3.x中新引入的HttpMessageConverter即消息轉(zhuǎn)換器機制。

#Http請求的抽象還是回到請求-響應，也就是解析請求體，然后返回響應報文這個最基本的Http請求過程中來。我們知道，在servlet標準中，可以用javax.servlet.ServletRequest接口中的以下方法：

public ServletInputStream getInputStream() throws IOException;

來得到一個ServletInputStream。這個ServletInputStream中，可以讀取到一個原始請求報文的所有內(nèi)容。同樣的，在javax.servlet.ServletResponse接口中，可以用以下方法：

public ServletOutputStream getOutputStream() throws IOException;

來得到一個ServletOutputStream，這個ServletOutputSteam，繼承自java中的OutputStream，可以讓你輸出Http的響應報文內(nèi)容。

讓我們嘗試著像SpringMVC的設計者一樣來思考一下。我們知道，Http請求和響應報文本質(zhì)上都是一串字符串，當請求報文來到java世界，它會被封裝成為一個ServletInputStream的輸入流，供我們讀取報文。響應報文則是通過一個ServletOutputStream的輸出流，來輸出響應報文。

我們從流中，只能讀取到原始的字符串報文，同樣，我們往輸出流中，也只能寫原始的字符。而在java世界中，處理業(yè)務邏輯，都是以一個個有業(yè)務意義的對象為處理維度的，那么在報文到達SpringMVC和從SpringMVC出去，都存在一個字符串到java對象的阻抗問題。這一過程，不可能由開發(fā)者手工轉(zhuǎn)換。我們知道，在Struts2中，采用了OGNL來應對這個問題，而在SpringMVC中，它是HttpMessageConverter機制。我們先來看兩個接口。

#HttpInputMessage 這個類是SpringMVC內(nèi)部對一次Http請求報文的抽象，在HttpMessageConverter的read()方法中，有一個HttpInputMessage的形參，它正是SpringMVC的消息轉(zhuǎn)換器所作用的受體“請求消息”的內(nèi)部抽象，消息轉(zhuǎn)換器從“請求消息”中按照規(guī)則提取消息，轉(zhuǎn)換為方法形參中聲明的對象。

package org.springframework.http;

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

public interface HttpInputMessage extends HttpMessage {

 InputStream getBody() throws IOException;

}

#HttpOutputMessage 這個類是SpringMVC內(nèi)部對一次Http響應報文的抽象，在HttpMessageConverter的write()方法中，有一個HttpOutputMessage的形參，它正是SpringMVC的消息轉(zhuǎn)換器所作用的受體“響應消息”的內(nèi)部抽象，消息轉(zhuǎn)換器將“響應消息”按照一定的規(guī)則寫到響應報文中。

package org.springframework.http;

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

public interface HttpOutputMessage extends HttpMessage {

 OutputStream getBody() throws IOException;

}

#HttpMessageConverter 對消息轉(zhuǎn)換器最高層次的接口抽象，描述了一個消息轉(zhuǎn)換器的一般特征，我們可以從這個接口中定義的方法，來領悟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接口的定義出現(xiàn)了成對的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方法前，會根據(jù)@RequestBody注解選擇適當?shù)腍ttpMessageConverter實現(xiàn)類來將請求參數(shù)解析到string變量中，具體來說是使用了StringHttpMessageConverter類，它的canRead()方法返回true，然后它的read()方法會從請求中讀出請求參數(shù)，綁定到readString()方法的string變量中。

當SpringMVC執(zhí)行readString方法后，由于返回值標識了@ResponseBody，SpringMVC將使用StringHttpMessageConverter的write()方法，將結(jié)果作為String值寫入響應報文，當然，此時canWrite()方法返回true。

我們可以用下面的圖，簡單描述一下這個過程。

#RequestResponseBodyMethodProcessor 將上述過程集中描述的一個類是org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor，這個類同時實現(xiàn)了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這個類，同時充當了方法參數(shù)解析和返回值處理兩種角色。我們從它的源碼中，可以找到上面兩個接口的方法實現(xiàn)。

對HandlerMethodArgumentResolver接口的實現(xiàn)：

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接口的實現(xiàn)

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消息轉(zhuǎn)換的脈絡已經(jīng)非常清晰。因為兩個接口的實現(xiàn)，分別是以是否有@RequestBody和@ResponseBody為條件，然后分別調(diào)用HttpMessageConverter來進行消息的讀寫。

如果你想問，怎么樣跟蹤到RequestResponseBodyMethodProcessor中，請你按照前面幾篇博文的思路，然后到這里spring-mvc-showcase下載源碼回來，對其中HttpMessageConverter相關(guān)的例子進行debug，只要你肯下功夫，相信你一定會有屬于自己的收獲的。

#思考張小龍在談微信的本質(zhì)時候說：“微信只是個平臺，消息在其中流轉(zhuǎn)”。在我們對SpringMVC源碼分析的過程中，我們可以從HttpMessageConverter機制中領悟到類似的道理。在SpringMVC的設計者眼中，一次請求報文和一次響應報文，分別被抽象為一個請求消息HttpInputMessage和一個響應消息HttpOutputMessage。

處理請求時，由合適的消息轉(zhuǎn)換器將請求報文綁定為方法中的形參對象，在這里，同一個對象就有可能出現(xiàn)多種不同的消息形式，比如json和xml。同樣，當響應請求時，方法的返回值也同樣可能被返回為不同的消息形式，比如json和xml。

在SpringMVC中，針對不同的消息形式，我們有不同的HttpMessageConverter實現(xiàn)類來處理各種消息形式。但是，只要這些消息所蘊含的“有效信息”是一致的，那么各種不同的消息轉(zhuǎn)換器，都會生成同樣的轉(zhuǎn)換結(jié)果。至于各種消息間解析細節(jié)的不同，就被屏蔽在不同的HttpMessageConverter實現(xiàn)類中了。

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: