记录 HttpRequest 参数和请求正文

Question

我正在尝试为我的网络应用程序创建请求日志。我正在使用Spring 3。 0.

我实现了一个扩展 HandlerInterceptorAdapter 的类，并使用 preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) 来拦截请求。

在该方法中，我希望能够记录请求正文（我的参数是直接写入请求正文的 XML 中的对象），为此我使用 request.getReader();

问题是 - 稍后当 spring 控制器尝试读取请求时，我将收到一个 IllegalStateException 。

有办法做我想做的事吗？

Answer 1

您可以使用过滤器来做到这一点。请求参数很容易处理。
然而处理请求体会困难得多
并且需要包装 servlet 请求，请参阅： HttpServletRequest。

您需要查看传入请求有多大，并决定是否要将请求正文存储为 tmp 文件或字符串。

您将需要使用您的文件或用于日志记录的已保存字符串覆盖 ServetRequest.getInputStream()。

如果请求正文很大，我建议将输入流放入缓冲输入流中，然后读取正文的开头。

public class LogRequest extends HttpServletRequestWrapper {

    public LogRequest(HttpServletRequest request) {
        super(request);
    }

    @Override
    public ServletInputStream getInputStream() throws IOException {
        //read from tmp file or string.
    }

    @Override
    public BufferedReader getReader() throws IOException {
        //read from tmp file or string
    }

}

Answer 2

Spring 有一个现成的过滤器可以为您执行此操作 - 请参阅 这个答案。

请注意，使用此解决方案时，仅在请求处理完成并且应用程序已读取请求正文后才会记录请求正文。

Answer 3

小请求的简单实现。不要将其用于多部分请求。

package ru.rbs.logger.web;

import org.apache.commons.io.IOUtils;

import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;

class CachedRequestWrapper extends HttpServletRequestWrapper {
    private final byte[] cachedBody;

    CachedRequestWrapper(HttpServletRequest request) throws IOException {
        super(request);

        ByteArrayOutputStream bos = new ByteArrayOutputStream();
        IOUtils.copy(request.getInputStream(), bos);
        cachedBody = bos.toByteArray();
    }

    @Override
    public ServletInputStream getInputStream() throws IOException {
        return new CachedServletInputStream();
    }

    byte[] toByteArray(){
        return cachedBody;
    }

    private class CachedServletInputStream extends ServletInputStream {
        private InputStream baseInputStream;

        CachedServletInputStream() throws IOException {
            baseInputStream = new ByteArrayInputStream(cachedBody);
        }

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

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

        @Override
        public void setReadListener(ReadListener readListener) {

        }

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

Answer 4

使用 TeeInputStream。这会同时写入两个流：源输入流和一些输出流。只需重写请求包装器中的 ServletInputStream 并从 TeeInputStream 读取即可。然后，您可以在调用chain.doFilter()后从输出流中读取：

@Override
public void doFilterNonOption(HttpServletRequest request, HttpServletResponse response,
      FilterChain chain) throws IOException, ServletException {
  ByteArrayOutputStream requestBaos = new ByteArrayOutputStream();
  final PrintStream requestPrintStream = new PrintStream(requestBaos);
  final TeeInputStream inputStream = new TeeInputStream(request.getInputStream(), requestPrintStream);

  HttpServletRequestWrapper wrappedRequest = new HttpServletRequestWrapper(request) {
    @Override
    public ServletInputStream getInputStream() {
      return new ServletInputStream() {
        @Override
        public boolean isFinished() {
          return false;
        }

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

        @Override
        public void setReadListener(ReadListener readListener) {
          // NOOP
        }

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

  try {
    chain.doFilter(wrappedRequest, response);
  } finally {
    System.out.println(requestBaos.toString(StandardCharsets.UTF-8));
  }
}