共计 3320 个字符,预计需要花费 9 分钟才能阅读完成。
最近很多交互要同原生的 HttpServletRequest
和HttpServletResponse
打交道。从 HttpServletRequest
中读取 body 数据封装成某种数据结构;向 HttpServletResponse
写入数据并响应。传统的写法十分不优雅,明天给大家介绍一种比拟优雅的形式。
HttpMessageConverter
HttpMessageConverter
是 Spring 框架提供的一个音讯转换器模型,用于在 HTTP 申请和响应之间进行转换的策略接口。它能够对输出音讯 HttpInputMessage
进行读;也能够对输入音讯 HttpOutputMessage
进行写。
Spring MVC的音讯转换都是通过这个接口的实现来实现的。HttpMessageConverter
有很多实现:
通常 Spring MVC 中解决 Form 表单提交、JSON、XML、字符串、甚至 Protobuf 都由 HttpMessageConverter
的实现来实现,前端传递到后端的 body 参数,后端返回给前端的数据都是由这个接口实现转换的。在 Spring IoC 中(Spring MVC环境)还存在一个寄存 HttpMessageConverter
的容器HttpMessageConverters
:
@Bean
@ConditionalOnMissingBean
public HttpMessageConverters messageConverters(ObjectProvider<HttpMessageConverter<?>> converters) {return new HttpMessageConverters((Collection)converters.orderedStream().collect(Collectors.toList()));
}
咱们能够间接拿来应用。那么到底怎么应用呢?那首先要搞清楚 HttpInputMessage
和HttpOutputMessage
是干什么用的。
HttpInputMessage
HttpInputMessage
示意一个 HTTP 输出音讯,由申请头 headers 和一个可读的申请体 body 组成,通常由服务器端的 HTTP 申请句柄或客户端的 HTTP 响应句柄实现。
而 HttpServletRequest
是ServletRequest
的扩大接口,提供了 HTTP Servlet 的申请信息,也蕴含了申请头和申请体,所以两者是有分割的。咱们只有找出两者之间的理论关系就能让 HttpMessageConverter
去读取并解决 HttpServletRequest
携带的申请信息。
ServletServerHttpRequest
说实话还真找到了:
ServletServerHttpRequest
不仅仅是 HttpInputMessage
的实现,它还持有了一个 HttpServletRequest
实例属性,ServletServerHttpRequest
的所有操作都是基于 HttpServletRequest
进行的。咱们能够通过结构为其注入 HttpServletRequest
实例,这样 HttpMessageConverter
就能间接解决 HttpServletRequest
了。
提取申请体实战
这里聚焦的场景是在 Servlet 过滤器中应用 HttpMessageConverter
,在 Spring MVC 中不太倡议去操作HttpServletRequest
。我抉择了FormHttpMessageConverter
,它通常用来解决application/x-www-form-urlencoded
申请。咱们编写一个过滤器来拦挡申请提取body:
/**
* 解决 application/x-www-form-urlencoded 申请
*
* @author felord.cn
*/
@Component
public class FormUrlencodedFilter implements Filter {private final FormHttpMessageConverter formHttpMessageConverter = new FormHttpMessageConverter();
private static final Logger log = LoggerFactory.getLogger(FormUrlencodedFilter.class);
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException {String contentType = request.getContentType();
MediaType type= StringUtils.hasText(contentType)? MediaType.valueOf(contentType):null;
ServletServerHttpRequest serverHttpRequest = new ServletServerHttpRequest((HttpServletRequest) request);
if (formHttpMessageConverter.canRead(MultiValueMap.class,type)) {MultiValueMap<String, String> read = formHttpMessageConverter.read(null, serverHttpRequest);
log.info("打印读取到的申请体:{}",read);
}
}
}
而后执行一个 POST
类型,Content-Type
为 application/x-www-form-urlencoded
的申请:
POST /ind HTTP/1.1
Host: localhost:8080
Content-Type: application/x-www-form-urlencoded
Content-Length: 20
a=b123&c=d123&e=f123
控制台会打印:
2021-12-30 6:43:56.409 INFO 12408 --- [nio-8080-exec-1] sfds: 打印读取到的申请体:{a=[b123], c=[d123], e=[f123]}
ServletServerHttpResponse
有 ServletServerHttpRequest
就有 ServletServerHttpResponse
,大抵原理差不多。它正好和ServletServerHttpRequest
相同,如果咱们须要去解决响应问题,比方想通过 HttpServletResponse
写个 JSON 响应,大略能够这么写:
ServletServerHttpResponse servletServerHttpResponse = new ServletServerHttpResponse(response);
// 应用 json converter
MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
// authentication 指的是须要写的对象实例
mappingJackson2HttpMessageConverter.write(authentication, MediaType.APPLICATION_JSON,servletServerHttpResponse);
总结
HttpMessageConverter
形象了 HTTP 音讯转换的策略,能够帮忙咱们优雅地解决一些申请响应的问题。不过有一点须要留神,申请体 body 只能读取一次,即便它包裹在 ServletServerHttpRequest
中,要留神和 HttpServletRequestWrapper
的区别。
关注公众号:Felordcn 获取更多资讯
集体博客:https://felord.cn