SpringMVC源码剖析(五)-消息转换器HttpMessageConverter
概述
在SpringMVC中,可以使用@RequestBody和@ResponseBody两个注解,分别完成请求报文到对象和对象到响应报文的转换,底层这种灵活的消息转换机制,就是Spring3.x中新引入的HttpMessageConverter即消息转换器机制。
Http请求的抽象
还是回到请求-响应,也就是解析请求体,然后返回响应报文这个最基本的Http请求过程中来。我们知道,在servlet标准中,可以用javax.servlet.ServletRequest接口中的以下方法:
1
|
public ServletInputStream getInputStream() throws IOException;
|
来得到一个ServletInputStream。这个ServletInputStream中,可以读取到一个原始请求报文的所有内容。同样的,在javax.servlet.ServletResponse接口中,可以用以下方法:
1
|
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的消息转换器所作用的受体“请求消息”的内部抽象,消息转换器从“请求消息”中按照规则提取消息,转换为方法形参中声明的对象。
01
|
package org.springframework.http;
|
02
|
03
|
import java.io.IOException;
|
04
|
import java.io.InputStream;
|
05
|
06
|
public interface HttpInputMessage extends HttpMessage {
|
07
|
08
|
InputStream getBody() throws IOException;
|
09
|
10
|
}
|
HttpOutputMessage
这个类是SpringMVC内部对一次Http响应报文的抽象,在HttpMessageConverter的write()方法中,有一个HttpOutputMessage的形参,它正是SpringMVC的消息转换器所作用的受体“响应消息”的内部抽象,消息转换器将“响应消息”按照一定的规则写到响应报文中。
01
|
package org.springframework.http;
|
02
|
03
|
import java.io.IOException;
|
04
|
import java.io.OutputStream;
|
05
|
06
|
public interface HttpOutputMessage extends HttpMessage {
|
07
|
08
|
OutputStream getBody() throws IOException;
|
09
|
10
|
}
|
HttpMessageConverter
对消息转换器最高层次的接口抽象,描述了一个消息转换器的一般特征,我们可以从这个接口中定义的方法,来领悟Spring3.x的设计者对这一机制的思考过程。
01
|
package org.springframework.http.converter;
|
02
|
03
|
import java.io.IOException;
|
04
|
import java.util.List;
|
05
|
06
|
import org.springframework.http.HttpInputMessage;
|
07
|
import org.springframework.http.HttpOutputMessage;
|
08
|
import org.springframework.http.MediaType;
|
09
|
10
|
public interface HttpMessageConverter<T> {
|
11
|
12
|
boolean canRead(Class<?> clazz, MediaType mediaType);
|
13
|
14
|
boolean canWrite(Class<?> clazz, MediaType mediaType);
|
15
|
16
|
List<MediaType> getSupportedMediaTypes();
|
17
|
18
|
T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
|
19
|
throws IOException, HttpMessageNotReadableException;
|
20
|
21
|
void write(T t, MediaType contentType, HttpOutputMessage outputMessage)
|
22
|
throws IOException, HttpMessageNotWritableException;
|
23
|
24
|
}
|
HttpMessageConverter接口的定义出现了成对的canRead(),read()和canWrite(),write()方法,MediaType是对请求的Media Type属性的封装。举个例子,当我们声明了下面这个处理方法。
1
|
@RequestMapping (value= "/string" , method=RequestMethod.POST)
|
2
|
public @ResponseBody String readString( @RequestBody String string) {
|
3
|
return "Read string '" + string + "'" ;
|
4
|
}
|
在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两个接口。前者是将请求报文绑定到处理方法形参的策略接口,后者则是对处理方法返回值进行处理的策略接口。两个接口的源码如下:
01
|
package org.springframework.web.method.support;
|
02
|
03
|
import org.springframework.core.MethodParameter;
|
04
|
import org.springframework.web.bind.WebDataBinder;
|
05
|
import org.springframework.web.bind.support.WebDataBinderFactory;
|
06
|
import org.springframework.web.context.request.NativeWebRequest;
|
07
|
08
|
public interface HandlerMethodArgumentResolver {
|
09
|
10
|
boolean supportsParameter(MethodParameter parameter);
|
11
|
12
|
Object resolveArgument(MethodParameter parameter,
|
13
|
ModelAndViewContainer mavContainer,
|
14
|
NativeWebRequest webRequest,
|
15
|
WebDataBinderFactory binderFactory) throws Exception;
|
16
|
17
|
}
|
18
|
19
|
package org.springframework.web.method.support;
|
20
|
21
|
import org.springframework.core.MethodParameter;
|
22
|
import org.springframework.web.context.request.NativeWebRequest;
|
23
|
24
|
public interface HandlerMethodReturnValueHandler {
|
25
|
26
|
boolean supportsReturnType(MethodParameter returnType);
|
27
|
28
|
void handleReturnValue(Object returnValue,
|
29
|
MethodParameter returnType,
|
30
|
ModelAndViewContainer mavContainer,
|
31
|
NativeWebRequest webRequest) throws Exception;
|
32
|
33
|
}
|
RequestResponseBodyMethodProcessor这个类,同时充当了方法参数解析和返回值处理两种角色。我们从它的源码中,可以找到上面两个接口的方法实现。
对HandlerMethodArgumentResolver接口的实现:
01
|
public boolean supportsParameter(MethodParameter parameter) {
|
02
|
return parameter.hasParameterAnnotation(RequestBody. class );
|
03
|
}
|
04
|
05
|
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
|
06
|
NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
|
07
|
08
|
Object argument = readWithMessageConverters(webRequest, parameter, parameter.getGenericParameterType());
|
09
|
10
|
String name = Conventions.getVariableNameForParameter(parameter);
|
11
|
WebDataBinder binder = binderFactory.createBinder(webRequest, argument, name);
|
12
|
13
|
if (argument != null ) {
|
14
|
validate(binder, parameter);
|
15
|
}
|
16
|
17
|
mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
|
18
|
19
|
return argument;
|
20
|
}
|
对HandlerMethodReturnValueHandler接口的实现
01
|
public boolean supportsReturnType(MethodParameter returnType) {
|
02
|
return returnType.getMethodAnnotation(ResponseBody. class ) != null ;
|
03
|
}
|
04
|
05
|
public void handleReturnValue(Object returnValue, MethodParameter returnType,
|
06
|
ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
|
07
|
throws IOException, HttpMediaTypeNotAcceptableException {
|
08
|
09
|
mavContainer.setRequestHandled( true );
|
10
|
if (returnValue != null ) {
|
11
|
writeWithMessageConverters(returnValue, returnType, webRequest);
|
12
|
}
|
13
|
}
|
看完上面的代码,整个HttpMessageConverter消息转换的脉络已经非常清晰。因为两个接口的实现,分别是以是否有@RequestBody和@ResponseBody为条件,然后分别调用HttpMessageConverter来进行消息的读写。
如果你想问,怎么样跟踪到RequestResponseBodyMethodProcessor中,请你按照前面几篇博文的思路,然后到这里spring-mvc-showcase下载源码回来,对其中HttpMessageConverter相关的例子进行debug,只要你肯下功夫,相信你一定会有属于自己的收获的。
思考
张小龙在谈微信的本质时候说:“微信只是个平台,消息在其中流转”。在我们对SpringMVC源码分析的过程中,我们可以从HttpMessageConverter机制中领悟到类似的道理。在SpringMVC的设计者眼中,一次请求报文和一次响应报文,分别被抽象为一个请求消息HttpInputMessage和一个响应消息HttpOutputMessage。
处理请求时,由合适的消息转换器将请求报文绑定为方法中的形参对象,在这里,同一个对象就有可能出现多种不同的消息形式,比如json和xml。同样,当响应请求时,方法的返回值也同样可能被返回为不同的消息形式,比如json和xml。
在SpringMVC中,针对不同的消息形式,我们有不同的HttpMessageConverter实现类来处理各种消息形式。但是,只要这些消息所蕴含的“有效信息”是一致的,那么各种不同的消息转换器,都会生成同样的转换结果。至于各种消息间解析细节的不同,就被屏蔽在不同的HttpMessageConverter实现类中了。
SpringMVC源码剖析(五)-消息转换器HttpMessageConverter相关推荐
- java注解返回不同消息,SpringMVC源码剖析5:消息转换器HttpMessageConverter与@ResponseBody注解...
转自 [SpringMVC关于json.xml自动转换的原理研究[附带源码分析]](https://www.cnblogs.com/fangj... 部分代码会放在我的的Github:https:// ...
- SpringMVC源码剖析(三)- DispatcherServlet的初始化流程
我们启动web服务器,在浏览器中输入地址,就可以看到浏览器上输出我们写好的页面.为了更好的理解上面这个过程,你需要学习关于Servlet生命周期的三个阶段,就是所谓的"init-servic ...
- 【Spring学习笔记-MVC-1.3】消息转换器HttpMessageConverter
作者:ssslinppp 参考链接: SpringMVC源码剖析(五)-消息转换器HttpMessageConverter: http://my.oschina.net/lichhao/b ...
- 源码 状态机_阿里中间件seata源码剖析七:saga模式实现
saga模式是分布式事务中使用比较多的一种模式,他主要应用在长流程的服务,对一个全局事务,如果某个节点抛出了异常,则从这个节点往前依次回滚或补偿事务.今天我们就来看看它的源码实现. 状态机初始化 在之 ...
- 阿里中间件seata源码剖析六:TCC模式中2阶段提交实现
目录 TM通知TC事务状态 TC通知RM分支事务提交 RM处理TC提交事务请求 总结 上篇文章中,我们以TCC模式的demo为例,讲解了seata中全局事务的开启.在这个demo中,TM作为一个全局事 ...
- springMVC消息转换器HttpMessageConverter
前言 为何需要消息转换器 HttpMessageConverter是用来处理request和response里的数据的. 请求和响应都有对应的body,而这个body就是需要关注的主要数据. 请求体的 ...
- SpringMVC源码分析(4)剖析DispatcherServlet重要组件
简单介绍了一个请求的处理过程, 简略描述了调用过程,并没有涉及过多细节,如url匹配,报文解析转换等. <SpringMVC源码分析(2)DispatcherServlet的初始化>:介绍 ...
- redis源码剖析(十五)——客户端思维导图整理
redis源码剖析(十五)--客户端执行逻辑结构整理 加载略慢
- SpringMVC子父容器源码剖析
SpringMVC子父容器源码剖析 一.子父容器启动流程 二.环境准备 spring源码搭建 spring-framework-5.1.x 源码编译 环境搭建 [ idea:2020.1 ] 在spr ...
最新文章
- 2016年研究数据可视化最不应该错过的10篇文章
- IMX6ULL的GPIO操作方法
- 线下报名 | YOCSEF TDS:深度强化学习的理论、算法与应用
- centos 7 安装 mail
- 梯度下降的三种形式——BGD、SGD、MBGD
- nginx哪个版本性能好_nginx性能为什么好
- javaweb实现验证码功能
- 关于禁用html中a标签的思考
- C#:重启后,AssemblyInfo中AssemblyTitle的描述内容显示正常.........
- iptable 帮助
- 中高端时代趁势而来,本就艰难的酒店企业如何顺势而为
- 动态桌面软件测试简历,动态壁纸软件横评
- 一个PHP调用GET多个API,PHP GET 调用企查查 API 示例
- caffe 损失函数
- Unity粒子系统基本
- 全等三角形的判定方法
- 企业信息化战略与实施
- 端口号被占用的解决方法
- echart图表缩放到一定比例(可自定义)后,停止放大,还可以缩小回去
- echart中国地图
热门文章
- css特效:鼠标滑过图片出现一道闪光效果
- 经济学的几个经典故事
- android重签名闪退,360加固保加固完之后重新签名的包运行闪退,求大神帮忙解答...
- geoserver发布shape地图步骤
- 俄美研制出新型太阳能电池 成本低转换效率高
- 【手势交互】12. MYO臂环
- 用Issue来管理项目!
- ORACLE日期时间函数大全 TO_DATE格式(以时间:2007-11-02 13:45:25为例) Year: yy two digi
- 清华大学计算机系报考的条件,清华大学报考信息出炉 2021年清华大学报考最新信息...
- cad刷新快捷键_纯干货|CAD口诀