知識庫 / Spring / Spring MVC RSS 訂閱

1. 引言

本教程將指導您使用 Spring 從 <em>HttpServletRequest</em> 中多次讀取請求體的方法。

<em>HttpServletRequest</em> 是一個接口，它暴露了 <em>getInputStream()</em> 方法，用於讀取請求體。 默認情況下，從該 <em>InputStream</em> 讀取的數據只能一次性讀取。

2. Maven 依賴

我們需要添加的適當依賴是 `spring-webmvc 和 jakarta.servlet。

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>6.0.13</version>
</dependency>

此外，由於我們使用了 application/json 內容類型，因此需要添加 jackson-databind 依賴項：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.17.2</version>
</dependency>

Spring 使用該庫將數據轉換為 JSON 和從 JSON 轉換為數據。

3. Spring 中的 <em >ContentCachingRequestWrapper</em >

Spring 提供了一個 <em >ContentCachingRequestWrapper</em > 類。該類提供了一個 getContentAsByteArray() 方法，用於多次讀取請求體。

該類存在一個限制：我們不能使用 getInputStream() 和 getReader() 方法多次讀取請求體。

由於此限制，該類在所有情況下都不可用。

為了克服此限制，讓我們現在看看一種更通用的解決方案。

4. 擴展 HttpServletRequest

讓我們創建一個新的類——CachedBodyHttpServletRequest，它繼承自 HttpServletRequestWrapper。 這樣，我們就不需要覆蓋 HttpServletRequest 接口的所有抽象方法。

HttpServletRequestWrapper 類有兩個抽象方法：getInputStream() 和 getReader()。 我們將覆蓋這兩個方法並創建一個新的構造函數。

4.1. 構造函數

首先，我們創建一個構造函數。在其中，我們將從實際的 InputStream 讀取內容，並將其存儲在一個 byte[] 對象中：

public class CachedBodyHttpServletRequest extends HttpServletRequestWrapper {

    private byte[] cachedBody;

    public CachedBodyHttpServletRequest(HttpServletRequest request) throws IOException {
        super(request);
        InputStream requestInputStream = request.getInputStream();
        this.cachedBody = StreamUtils.copyToByteArray(requestInputStream);
    }
}

因此，我們可以多次閲讀正文。

4.2. getInputStream()

接下來，我們將覆蓋 getInputStream() 方法。 我們將使用此方法讀取原始內容並將其轉換為對象。

在該方法中，我們將 創建並返回一個新的 CachedBodyServletInputStream 類對象（ServletInputStream 的一個實現）。

@Override
public ServletInputStream getInputStream() throws IOException {
    return new CachedBodyServletInputStream(this.cachedBody);
}

4.3. getReader()

然後，我們將覆蓋 getReader() 方法。此方法返回一個 BufferedReader 對象：

@Override
public BufferedReader getReader() throws IOException {
    ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(this.cachedBody);
    return new BufferedReader(new InputStreamReader(byteArrayInputStream));
}

5. 實現 ServletInputStream

我們將創建一個 類 – CachedBodyServletInputStream – 來實現 ServletInputStream。 在這個類中，我們將創建一個新的構造函數，並覆蓋 isFinished()、isReady() 和 read() 方法。

public class CachedBodyServletInputStream extends ServletInputStream {

    private InputStream cachedBodyInputStream;

    public CachedBodyServletInputStream(byte[] cachedBody) {
        this.cachedBodyInputStream = new ByteArrayInputStream(cachedBody);
    }
}

@Override
public int read() throws IOException {
    return cachedBodyInputStream.read();
}

@Override
public boolean isFinished() {
    return cachedBody.available() == 0;
}

@Override
public boolean isReady() {
    return true;
}

CachedBodyHttpServletRequest cachedBodyHttpServletRequest =
  new CachedBodyHttpServletRequest(request);

filterChain.doFilter(cachedContentHttpServletRequest, response);