解决 HttpServletRequest 的输入流不能重复读的问题

背景

写代码的时候遇到 HttpServletRequest 里的数据为null, 感觉很奇怪，同样的请求，刚才还不为null。

排查

经过debug发现，HttpServletRequest 在 106行 之前有值, 但在106行之后为null。

而这个方法只是简单地读了一遍 httpServletRequest 里面的数据

ServletInputStream inputStream = httpServletRequest.getInputStream()
StringBuilder sb = new StringBuilder();

try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, Charset.defaultCharset()))) {
  String line;
  while ((line = reader.readLine()) != null) {
    sb.append(line);
  }
} catch (IOException e) {
  throw new RuntimeException(e);
}

return sb.toString();

于是猜想 HttpServletRequest里的 inputStream 只能读一次？

去查了一下果真如此。下面了解一下原因。

HttpServletRequest的输入流只能读取一次的原因

首先我们使用 httpServletRequest.getInputStream()

返回的是 ServletInputStream 类, 它继承于 InputStream。

而我们对这个流读数据其实 调用了 InputStream的 read()方法。

读取流的时候会根据position来获取当前位置，每读取一次，该标志就会移动一次，如果读到最后，read()返回-1，表示已经读取完了。

while(inputStream.read(b)) != -1) {
  
}

如果想要重新读取，可以调用 inputstream.reset() 方法，

但是能否 reset 取决于markSupported方法，返回true可以reset，反之则不行。

查看 ServletInputStream 可知，这个类并没有重写markSupported和reset方法。

所以这就是 HttpServletRequest输入流只能读取一次原因

解决

解决的核心思路就是对HttpServletRequest输入流进行备份。

将请求体中的流copy一份，重写getInputStream()和getReader()方法

每次调用覆写后的getInputStream()方法都是从复制出来的二进制数组中进行获取。

RequestWrapper.class

/**
 * 解决request流只读取一次的问题
 */
@Slf4j
public class RequestWrapper extends HttpServletRequestWrapper {

  /**
   * 存储body数据的容器
   */
  private final byte[] body;

  public RequestWrapper(HttpServletRequest request) throws IOException {
    super(request);

    // 将body数据存储起来
    body = getBodyString(request).getBytes(Charset.defaultCharset());
  }

  /**
   * 获取请求Body
   *
   * @param request request
   * @return String
   */
  private String getBodyString(final ServletRequest request) {
    try {
      return inputStream2String(request.getInputStream());
    } catch (IOException e) {
      throw new RuntimeException(e);
    }
  }

  /**
   * 获取请求Body
   *
   * @return String
   */
  public String getBodyString() {
    final InputStream inputStream = new ByteArrayInputStream(body);

    return inputStream2String(inputStream);
  }

  /**
   * 将inputStream里的数据读取出来并转换成字符串
   *
   * @param inputStream inputStream
   * @return String
   */
  private String inputStream2String(InputStream inputStream) {
    StringBuilder sb = new StringBuilder();

    try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, Charset.defaultCharset()))) {
      String line;
      while ((line = reader.readLine()) != null) {
        sb.append(line);
      }
    } catch (IOException e) {
      throw new RuntimeException(e);
    }

    return sb.toString();
  }

  @Override
  public BufferedReader getReader() throws IOException {
    return new BufferedReader(new InputStreamReader(getInputStream()));
  }

  @Override
  public ServletInputStream getInputStream() throws IOException {

    final ByteArrayInputStream inputStream = new ByteArrayInputStream(body);

    return new ServletInputStream() {
      @Override
      public int read() throws IOException {
        return inputStream.read();
      }

      @Override
      public boolean isFinished() {
        return false;
      }

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

      @Override
      public void setReadListener(ReadListener readListener) {
      }
    };
  }

}

Filter

除了要写一个包装器外，我们还需要在过滤器里将原生的 HttpServletRequest 对象替换成我们的RequestWrapper对象。

创建过滤器

/**
 * 解决request流只读取一次的问题
 */
public class ReplaceStreamFilter implements Filter {

  @Override
  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
    ServletRequest requestWrapper = new RequestWrapper((HttpServletRequest) request);
    chain.doFilter(requestWrapper, response);
  }
}

配置过滤器

@Configuration
class FilterConfig {
  /**
   * 注册过滤器
   *
   * @return FilterRegistrationBean
   */
  @Bean
  public FilterRegistrationBean someFilterRegistration() {
    FilterRegistrationBean registration = new FilterRegistrationBean();
    registration.setFilter(replaceStreamFilter());
    registration.addUrlPatterns("/*");
    registration.setName("streamFilter");
    return registration;
  }

  /**
   * 实例化StreamFilter
   *
   * @return Filter
   */
  @Bean(name = "replaceStreamFilter")
  public Filter replaceStreamFilter() {
    return new ReplaceStreamFilter();
  }
}

使用

使用的时候用我们创建的 RequestWrapper 读数据就好了

String requestBody =  new RequestWrapper(httpServletRequest).getBodyString();