如何優雅地讀寫HttpServletRequest和HttpServletResponse的請求體

語言: CN / TW / HK

最近很多交互要同原生的 HttpServletRequestHttpServletResponse 打交道。從 HttpServletRequest 中讀取 body 數據封裝成某種數據結構;向 HttpServletResponse 寫入數據並響應。傳統的寫法非常不優雅,今天給大家介紹一種比較優雅的方式。

HttpMessageConverter

HttpMessageConverter 是Spring框架提供的一個消息轉換器模型,用於在 HTTP 請求和響應之間進行轉換的策略接口。它可以對輸入消息 HttpInputMessage 進行讀;也可以對輸出消息 HttpOutputMessage 進行寫。

Spring MVC的消息轉換都是通過這個接口的實現來完成的。 HttpMessageConverter 有很多實現:

通常 Spring MVC 中處理 Form 表單提交、 JSONXML 、字符串、甚至 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()));
    }

我們可以直接拿來使用。那麼到底怎麼使用呢?那首先要搞清楚 HttpInputMessageHttpOutputMessage 是幹什麼用的。

HttpInputMessage

HttpInputMessage 表示一個 HTTP 輸入消息,由請求頭 headers 和一個可讀的請求體 body 組成,通常由服務器端的 HTTP 請求句柄或客户端的 HTTP 響應句柄實現。

HttpServletRequestServletRequest 的擴展接口,提供了 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-Typeapplication/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