解決在Spring MVC或Spring Boot中使用Filter打印請求參數(shù)問題

  @Override
  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse       
         response, FilterChain filterChain) throws ServletException, IOException {
    filterChain.doFilter(request, response);
    printRequestLog(request);
    printResonseLog(response);
  }

  @Override
  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse 
       response, FilterChain filterChain) throws ServletException, IOException {
    printRequestLog(request);
    printResonseLog(response);
    filterChain.doFilter(request, response);
  }

import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.*;
import java.nio.charset.Charset;
/**
* @Description:  請求包裝器
* @Author:     liuliya
* @CreateDate:   2020/4/29 10:00
*/
public class RequestWrapper extends HttpServletRequestWrapper {
  
  private final byte[] body;
 
  public RequestWrapper(HttpServletRequest request) throws IOException {
    super(request);
    body = getRequestBodyString(request).getBytes(Charset.defaultCharset());
  }
 
  @Override
  public BufferedReader getReader() throws IOException {
    return new BufferedReader(new InputStreamReader(getInputStream()));
  }
 
  @Override
  public ServletInputStream getInputStream() throws IOException {
 
    final ByteArrayInputStream bais = new ByteArrayInputStream(body);
 
    return new ServletInputStream() {
 
      @Override
      public int read() throws IOException {
        return bais.read();
      }
 
      @Override
      public boolean isFinished() {
        return false;
      }
 
      @Override
      public boolean isReady() {
        return false;
      }
 
      @Override
      public void setReadListener(ReadListener listener) {
 
      }
    };
  }
 
  public String getRequestBodyString(ServletRequest request) {
    StringBuilder sb = new StringBuilder();
    InputStream inputStream = null;
    BufferedReader reader = null;
    try {
      inputStream = request.getInputStream();
      reader = new BufferedReader(new InputStreamReader(inputStream, Charset.defaultCharset()));
      String line;
      while ((line = reader.readLine()) != null) {
        sb.append(line);
      }
    } catch (IOException e) {
      e.printStackTrace();
    } finally {
      if (inputStream != null) {
        try {
          inputStream.close();
        } catch (IOException e) {
          e.printStackTrace();
        }
      }
      if (reader != null) {
        try {
          reader.close();
        } catch (IOException e) {
          e.printStackTrace();
        }
      }
    }
    return sb.toString();
  }
}

package com.micro.backend.filter.support;
 
import org.apache.commons.io.output.TeeOutputStream; 
import javax.servlet.ServletOutputStream;
import javax.servlet.ServletResponse;
import javax.servlet.WriteListener;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintWriter;
 
/**
 * @Description: 響應(yīng)包裝器
 * @Author: liuliya
 * @CreateDate: 2020/4/29 10:00
 */
public class ResponseWrapper extends HttpServletResponseWrapper {
 
  private final ByteArrayOutputStream bos = new ByteArrayOutputStream();
  private PrintWriter writer = new PrintWriter(bos);
 
  public ResponseWrapper(HttpServletResponse response) {
    super(response);
  }
 
  @Override
  public ServletResponse getResponse() {
    return this;
  }
 
  @Override
  public ServletOutputStream getOutputStream() throws IOException {
    return new ServletOutputStream() {
      @Override
      public boolean isReady() {
        return false;
      }
 
      @Override
      public void setWriteListener(WriteListener listener) {
 
      }
 
      private TeeOutputStream tee = new TeeOutputStream(ResponseWrapper.super.getOutputStream(), bos);
 
      @Override
      public void write(int b) throws IOException {
        tee.write(b);
      }
    };
  }
 
  @Override
  public PrintWriter getWriter() throws IOException {
    return new TeePrintWriter(super.getWriter(), writer);
  }
 
  public byte[] toByteArray() {
    return bos.toByteArray();
  }
}

package com.micro.backend.filter.support;
import java.io.PrintWriter;
//PrintWriter是一種寫入字符的一種操作類，可以寫入字符，TeePrintWriter繼承了他，主要功能是把原始的字符流copy到branch里面。
public class TeePrintWriter extends PrintWriter {
 
  PrintWriter branch;
 
  public TeePrintWriter(PrintWriter main, PrintWriter branch) {
    super(main, true);
    this.branch = branch;
  }
 
  public void write(char buf[], int off, int len) {
    super.write(buf, off, len);
    super.flush();
    branch.write(buf, off, len);
    branch.flush();
  }
 
  public void write(String s, int off, int len) {
    super.write(s, off, len);
    super.flush();
    branch.write(s, off, len);
    branch.flush();
  }
 
  public void write(int c) {
    super.write(c);
    super.flush();
    branch.write(c);
    branch.flush();
  }
 
  public void flush() {
    super.flush();
    branch.flush();
  }
}

package com.micro.backend.filter;
 
import com.micro.backend.filter.support.RequestWrapper;
import com.micro.backend.filter.support.ResponseWrapper;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.filter.OncePerRequestFilter;
 
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
 
/**
* @Author:     liuliya
* @CreateDate:   2020/4/28 23:30
*/
@Slf4j
@Configuration
public class LoggingFilter extends OncePerRequestFilter {
  
  private static final String REQUEST_PREFIX_NAME = "Request請求: ";
  private static final String RESPONSE_PREFIX_NAME = "Response請求: ";
 
  @Override
  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
    request = new RequestWrapper(request);
    response = new ResponseWrapper(response);
    filterChain.doFilter(request, response);
    printRequestLog(request);
    printResponseLog((ResponseWrapper) response);
  }
 
  private void printRequestLog(final HttpServletRequest request) {
    StringBuilder msg = new StringBuilder();
    msg.append(REQUEST_PREFIX_NAME);
    HttpSession session = request.getSession(false);
    if (session != null) {
      msg.append("sessionId = ").append(session.getId()).append("; ");
    }
    if (request.getMethod() != null) {
      msg.append("method = ").append(request.getMethod()).append("; ");
    }
    if (request.getContentType() != null) {
      msg.append("contentType = ").append(request.getContentType()).append("; ");
    }
    msg.append("uri = ").append(request.getRequestURI());
    if (request.getQueryString() != null) {
      msg.append('?').append(request.getQueryString());
    }
 
    if (request instanceof RequestWrapper && !isMultipart(request) && !isBinaryContent(request)) {
      RequestWrapper requestWrapper = (RequestWrapper) request;
      msg.append("; payload = ").append(requestWrapper.getRequestBodyString(request));
    }
    log.info(msg.toString());
  }
 
  private boolean isBinaryContent(final HttpServletRequest request) {
    if (request.getContentType() == null) {
      return false;
    }
    return request.getContentType().startsWith("image")
        || request.getContentType().startsWith("video")
        || request.getContentType().startsWith("audio");
  }
 
  private boolean isMultipart(final HttpServletRequest request) {
    return request.getContentType() != null
        && request.getContentType().startsWith("multipart/form-data");
  }
 
  private void printResponseLog(final ResponseWrapper response) {
    StringBuilder msg = new StringBuilder();
    msg.append(RESPONSE_PREFIX_NAME);
    try {
      msg.append("; payload = ")
          .append(new String(response.toByteArray(), response.getCharacterEncoding()));
    } catch (UnsupportedEncodingException e) {
      log.warn("Failed to parse response payload", e);
    }
    log.info(msg.toString());
  } 
}