Spring MVC 中處理 Request 和 Response 的策略
最近很多交互要同原生的HttpServletRequest和HttpServletResponse打交道。從HttpServletRequest中讀取body數(shù)據(jù)封裝成某種數(shù)據(jù)結(jié)構(gòu);向HttpServletResponse寫入數(shù)據(jù)并響應(yīng)。傳統(tǒng)的寫法非常不優(yōu)雅,今天給大家介紹一種比較優(yōu)雅的方式。
HttpMessageConverter
HttpMessageConverter是Spring框架提供的一個消息轉(zhuǎn)換器模型,用于在 HTTP 請求和響應(yīng)之間進(jìn)行轉(zhuǎn)換的策略接口。它可以對輸入消息HttpInputMessage進(jìn)行讀;也可以對輸出消息HttpOutputMessage進(jìn)行寫。
HttpMessageConverter
Spring MVC的消息轉(zhuǎn)換都是通過這個接口的實(shí)現(xiàn)來完成的。HttpMessageConverter有很多實(shí)現(xiàn):
HttpMessageConverter常見實(shí)現(xiàn)
通常Spring MVC中處理Form表單提交、JSON、XML、字符串、甚至Protobuf都由HttpMessageConverter的實(shí)現(xiàn)來完成,前端傳遞到后端的body參數(shù),后端返回給前端的數(shù)據(jù)都是由這個接口完成轉(zhuǎn)換的。在Spring IoC中(Spring MVC環(huán)境)還存在一個存放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組成,通常由服務(wù)器端的 HTTP 請求句柄或客戶端的 HTTP 響應(yīng)句柄實(shí)現(xiàn)。
HttpInputMessage
而HttpServletRequest是ServletRequest的擴(kuò)展接口,提供了HTTP Servlet的請求信息,也包含了請求頭和請求體,所以兩者是有聯(lián)系的。我們只要找出兩者之間的實(shí)際關(guān)系就能讓HttpMessageConverter去讀取并處理HttpServletRequest攜帶的請求信息。
ServletServerHttpRequest
說實(shí)話還真找到了:
ServletServerHttpRequest
ServletServerHttpRequest不僅僅是HttpInputMessage的實(shí)現(xiàn),它還持有了一個HttpServletRequest實(shí)例屬性,ServletServerHttpRequest的所有操作都是基于HttpServletRequest進(jìn)行的。我們可以通過構(gòu)造為其注入HttpServletRequest實(shí)例,這樣HttpMessageConverter就能間接處理HttpServletRequest了。
提取請求體實(shí)戰(zhàn)
這里聚焦的場景是在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);
- }
- }
- }
然后執(zhí)行一個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
控制臺打?。?/p>
- 打印讀取到的請求體:{a=[b123], c=[d123], e=[f123]}
ServletServerHttpResponse
有ServletServerHttpRequest就有ServletServerHttpResponse,大致原理差不多。它正好和ServletServerHttpRequest相反,如果我們需要去處理響應(yīng)問題,比如想通過HttpServletResponse寫個JSON響應(yīng),大概可以這么寫:
- ServletServerHttpResponse servletServerHttpResponse = new ServletServerHttpResponse(response);
- // 使用json converter
- MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();
- // authentication 指的是需要寫的對象實(shí)例
- mappingJackson2HttpMessageConverter.write(authentication, MediaType.APPLICATION_JSON,servletServerHttpResponse);
總結(jié)
HttpMessageConverter抽象了HTTP消息轉(zhuǎn)換的策略,可以幫助我們優(yōu)雅地處理一些請求響應(yīng)的問題。不過有一點(diǎn)需要注意,請求體body只能讀取一次,即使它包裹在ServletServerHttpRequest中,要注意和HttpServletRequestWrapper的區(qū)別。