Spring MVC 中处理 Request 和 Response 的策略

时间:2021-07-20 23:10:06

Spring MVC 中处理 Request 和 Response 的策略

最近很多交互要同原生的HttpServletRequest和HttpServletResponse打交道。从HttpServletRequest中读取body数据封装成某种数据结构;向HttpServletResponse写入数据并响应。传统的写法非常不优雅,今天给大家介绍一种比较优雅的方式。

HttpMessageConverter

HttpMessageConverter是Spring框架提供的一个消息转换器模型,用于在 HTTP 请求和响应之间进行转换的策略接口。它可以对输入消息HttpInputMessage进行读;也可以对输出消息HttpOutputMessage进行写。

Spring MVC 中处理 Request 和 Response 的策略

HttpMessageConverter

Spring MVC的消息转换都是通过这个接口的实现来完成的。HttpMessageConverter有很多实现:

Spring MVC 中处理 Request 和 Response 的策略

HttpMessageConverter常见实现

通常Spring MVC中处理Form表单提交、JSON、XML、字符串、甚至Protobuf都由HttpMessageConverter的实现来完成,前端传递到后端的body参数,后端返回给前端的数据都是由这个接口完成转换的。在Spring IoC中(Spring MVC环境)还存在一个存放HttpMessageConverter的容器HttpMessageConverters:

  1. @Bean 
  2.  @ConditionalOnMissingBean 
  3.  public HttpMessageConverters messageConverters(ObjectProvider<HttpMessageConverter<?>> converters) { 
  4.      return new HttpMessageConverters((Collection)converters.orderedStream().collect(Collectors.toList())); 
  5.  } 

我们可以直接拿来使用。那么到底怎么使用呢?那首先要搞清楚HttpInputMessage 和HttpOutputMessage是干什么用的。

HttpInputMessage

HttpInputMessage表示一个 HTTP 输入消息,由请求头headers和一个可读的请求体body组成,通常由服务器端的 HTTP 请求句柄或客户端的 HTTP 响应句柄实现。

Spring MVC 中处理 Request 和 Response 的策略

HttpInputMessage

而HttpServletRequest是ServletRequest的扩展接口,提供了HTTP Servlet的请求信息,也包含了请求头和请求体,所以两者是有联系的。我们只要找出两者之间的实际关系就能让HttpMessageConverter去读取并处理HttpServletRequest携带的请求信息。

ServletServerHttpRequest

说实话还真找到了:

Spring MVC 中处理 Request 和 Response 的策略

ServletServerHttpRequest

ServletServerHttpRequest不仅仅是HttpInputMessage的实现,它还持有了一个HttpServletRequest实例属性,ServletServerHttpRequest的所有操作都是基于HttpServletRequest进行的。我们可以通过构造为其注入HttpServletRequest实例,这样HttpMessageConverter就能间接处理HttpServletRequest了。

提取请求体实战

这里聚焦的场景是在Servlet过滤器中使用HttpMessageConverter,在Spring MVC中不太建议去操作HttpServletRequest。我选择了FormHttpMessageConverter,它通常用来处理application/x-www-form-urlencoded请求。我们编写一个过滤器来拦截请求提取body:

  1. /** 
  2.  * 处理 application/x-www-form-urlencoded 请求 
  3.  * 
  4.  * @author  felord.cn 
  5.  */ 
  6.  
  7. @Component 
  8. public class FormUrlencodedFilter implements Filter { 
  9.     private final FormHttpMessageConverter formHttpMessageConverter = new FormHttpMessageConverter(); 
  10.     private static final Logger log = LoggerFactory.getLogger(FormUrlencodedFilter.class); 
  11.  
  12.     @Override 
  13.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException { 
  14.         String contentType = request.getContentType(); 
  15.         MediaType type= StringUtils.hasText(contentType)? MediaType.valueOf(contentType):null
  16.         ServletServerHttpRequest serverHttpRequest = new ServletServerHttpRequest((HttpServletRequest) request); 
  17.          
  18.         if (formHttpMessageConverter.canRead(MultiValueMap.class,type)) { 
  19.             MultiValueMap<String, String> read = formHttpMessageConverter.read(null, serverHttpRequest); 
  20.              log.info("打印读取到的请求体:{}",read); 
  21.         } 
  22.     } 

然后执行一个POST类型,Content-Type为application/x-www-form-urlencoded的请求:

  1. POST /ind HTTP/1.1 
  2. Host: localhost:8080 
  3. Content-Type: application/x-www-form-urlencoded 
  4. Content-Length: 20 
  5.  
  6. a=b123&c=d123&e=f123 

控制台打印:

  1. 打印读取到的请求体:{a=[b123], c=[d123], e=[f123]} 

ServletServerHttpResponse

有ServletServerHttpRequest就有ServletServerHttpResponse,大致原理差不多。它正好和ServletServerHttpRequest相反,如果我们需要去处理响应问题,比如想通过HttpServletResponse写个JSON响应,大概可以这么写:

  1. ServletServerHttpResponse servletServerHttpResponse = new ServletServerHttpResponse(response); 
  2. // 使用json converter 
  3. MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter(); 
  4. //  authentication 指的是需要写的对象实例 
  5. mappingJackson2HttpMessageConverter.write(authentication, MediaType.APPLICATION_JSON,servletServerHttpResponse); 

总结

HttpMessageConverter抽象了HTTP消息转换的策略,可以帮助我们优雅地处理一些请求响应的问题。不过有一点需要注意,请求体body只能读取一次,即使它包裹在ServletServerHttpRequest中,要注意和HttpServletRequestWrapper的区别。

原文链接:https://mp.weixin.qq.com/s/3eFygsiVl8dC2nRy8_8n5g