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

碼農小胖哥發表於2021-12-31
HTTPServlet

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

HttpMessageConverter

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

HttpMessageConverter

Spring MVC的訊息轉換都是通過這個介面的實現來完成的。HttpMessageConverter有很多實現：

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 響應控制程式碼實現。

HttpInputMessage

而HttpServletRequest是ServletRequest的擴充套件介面，提供了HTTP Servlet的請求資訊，也包含了請求頭和請求體，所以兩者是有聯絡的。我們只要找出兩者之間的實際關係就能讓HttpMessageConverter去讀取並處理HttpServletRequest攜帶的請求資訊。

ServletServerHttpRequest

說實話還真找到了：

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

相關文章