【實踐】切面打印請求參數

加打印語句，將請求參數打印出來。后面想想，以后可能還會遇到這樣的情況，如果每次遇到，我都去對應的方法中加日志打印，就變成重復工作。並且日志打印跟我們的業務本身沒有任何關系。

記錄日志網上主要有三種方法：

1. aop
2. filter
3. interceptor

我選擇了filter。為什么選擇它，因為我覺得它相對於定義切點，然后切點前后處理來說，更加方便；相對於 interceptor， 我更加熟悉這種方式。

 

定義Filter

定義一個 LogFilter  。 里面對 HttpServletRequest  進行攔截，根據對應的 content-type 解析請求參數。主要代碼如下

/**
 * 功能描述: 打印請求參數
 * @author lkb
 * @date 2020/5/6
 * @param
 * @return
 */
@Slf4j
public class LogFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
        throws ServletException, IOException {

        //日志
        doLog(request, response);

        // 將request 傳到下一個Filter
        filterChain.doFilter(request, response);
    }


    private void doLog(HttpServletRequest request,  HttpServletResponse response){
        // 輸出請求體
        log.info("request. uri = {}, method = {}, requestParam = {}", request.getRequestURI(), request.getMethod(), getRequestParam(request));
        //todo 返回結果也可以進行處理
    }


    private String getRequestParam(HttpServletRequest request){
        String requestParam = "";

        String requestContentType = request.getHeader(HttpHeaders.CONTENT_TYPE);
        try {
            if(StringUtils.isNotEmpty(requestContentType)){
                if (requestContentType.startsWith(MediaType.APPLICATION_JSON_VALUE)
                        || requestContentType.startsWith(MediaType.APPLICATION_XML_VALUE)) {
                    // xml json
                    requestParam = getRequestBody(request);
                }
                else if (requestContentType.startsWith(MediaType.MULTIPART_FORM_DATA_VALUE)) {
                    // 文件表單提交
                    requestParam = getFormParam(request);
                }else if(requestContentType.startsWith(MediaType.APPLICATION_FORM_URLENCODED_VALUE)){
                    // 普通表單提交
                    requestParam = toJson(request.getParameterMap());
                }
            }else{
                // 默認普通表單提交
                requestParam = toJson(request.getParameterMap());
            }
        }catch (Exception e){
            log.error("getRequestParam error");
            log.error(e.getMessage(),e);
        }
        return requestParam;
    }
    
    ...
}

 

然后，注冊這個filter

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean logFilter() {
        final FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        final LogFilter logFilter = new LogFilter();
        filterRegistrationBean.setFilter(logFilter);
        return filterRegistrationBean;
    }

}

 

上面兩步之后，重啟項目，可以看到請求過來后會打印出請求的uri、method、param 。

 

InputStream 只能讀取一次

本來以為這樣就萬事大吉了。但是事實並不是如此。加上上面代碼后會發現，再controller 加上的 @requestBody 沒有效果，取不到任何數據，並拋出異常，告訴我們請求已經被讀取過。 為什么呢？

 

原因很簡單。因為在 doLog 中獲取請求參數的時候，我們已經將請求的 inputStream 給讀取了。讀取inputStream 時有一個offset，它表示你從哪里開始讀取輸入流。因為我們讀取了一遍 inputStream，所以offset已經在流的最末端了。我們再去讀取，就會發現沒有東西可以讀了。如果想重復讀取 inputStream 就需要每次讀取后重置 offset 的值。

 

當然為了方便，我並沒有去重新inputStream 中的reset 方法。而是選擇，在讀取請求后，將請求緩存起來。

 

首先，BufferedServletInputStream 繼承自 ServletInputStream。

public class BufferedServletInputStream extends ServletInputStream {

    private ByteArrayInputStream inputStream;

    public BufferedServletInputStream(byte[] buffer) {
        this.inputStream = new ByteArrayInputStream( buffer );
    }

    @Override
    public int available(){
        return inputStream.available();
    }

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

    @Override
    public int readLine(byte[] b, int off, int len){
        return inputStream.read( b, off, len );
    }

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

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

    @Override
    public void setReadListener(ReadListener readListener) {

    }
}

 

然后，BufferedServletRequestWrapper 繼承 HttpServletRequestWrapper。

@Slf4j
public class BufferedServletRequestWrapper extends HttpServletRequestWrapper {

    private byte[] buffer;

    public BufferedServletRequestWrapper(HttpServletRequest request) throws IOException {
        super(request);
        InputStream is = request.getInputStream();
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        byte buff[] = new byte[1024];
        int read;
        while ((read = is.read(buff)) > 0) {
            baos.write(buff, 0, read);
        }
        this.buffer = baos.toByteArray();
    }

    @Override
    public ServletInputStream getInputStream() {
        return new BufferedServletInputStream(this.buffer);
    }
}

里面使用一個 byte[] buffer 數組將請求緩存起來。

 

最后，在 LogFilter 中 doLog 前，對請求進行包裝。

@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
    throws ServletException, IOException {
    // 備份HttpServletRequest
    request = new BufferedServletRequestWrapper(request);

    //日志
    doLog(request, response);

    // 將request 傳到下一個Filter
    filterChain.doFilter(request, response);
}

經過上訴處理，我們就可以愉快地用日志記錄請求參數了。

 

總結

最后總結一下：

1. 記錄請求參數日志的方式最好采用切面的思想

2. inputStream 默認只能讀取一次，多次讀取要重新處理inputStream

3. @requestBody 的原理可以了解一下