[JavaWeb] SpringBoot LogFilter获取 x-www-form-urlencoded/json 的请求参数

 

package com.xiwi.qa.common.filter;

import com.alibaba.fastjson.JSONObject;
import com.xiwi.qa.common.utils.http.BodyReaderHttpServletRequestWrapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Enumeration;
import java.util.LinkedHashMap;

/**
 * file: LogFilter
 * date: 2020-10-13
 * time: 8:43
 * explain: 获取接口请求参数
 * author: Xiwi
 */

@WebFilter(urlPatterns = "/*", filterName = "logFilter")
public class LogFilter implements Filter {

    private static final Logger logger = LoggerFactory.getLogger(LogFilter.class);

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
//        logger.info("--------------logFilter 过滤器初始化------------");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        // 防止流读取一次后就没有了, 所以需要将流继续写出去
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        ServletRequest requestWrapper = new BodyReaderHttpServletRequestWrapper(httpServletRequest);
        printRequest(requestWrapper);
        filterChain.doFilter(requestWrapper, servletResponse);
    }

    @Override
    public void destroy() {
//        logger.info("--------------过滤器销毁------------");
    }

    private void printRequest(ServletRequest servletRequest) {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String uri = request.getRequestURI();
        String protocol = request.getProtocol();
        String ip = request.getRemoteAddr();

        //获取请求头信息
        JSONObject headerJson = new JSONObject(new LinkedHashMap<>());
        Enumeration<String> headerNames = request.getHeaderNames();
        //使用循环遍历请求头，并通过getHeader()方法获取一个指定名称的头字段
        while (headerNames.hasMoreElements()){
            String headerName = headerNames.nextElement();
            headerJson.put(headerName, request.getHeader(headerName));
        }
        String header = headerJson.toJSONString();


        String requestBody = "";
        String requestContentType = request.getHeader(HttpHeaders.CONTENT_TYPE);
        if (requestContentType != null) {
            //    拦截 x-www-form-urlencoded/json 请求的参数
            if (requestContentType.startsWith(MediaType.APPLICATION_JSON_VALUE) ||
                    requestContentType.startsWith(MediaType.APPLICATION_XML_VALUE) ||
                    requestContentType.startsWith(MediaType.APPLICATION_FORM_URLENCODED_VALUE)) {
                requestBody = getRequestBody(request);
                logger.info("请求接口打印 url ==={}", uri);
                logger.info("请求接口打印 urlParams ==={}", protocol);
                logger.info("请求接口打印 参数 ==={}", requestBody);
                logger.info("请求接口打印 请求头 ==={}", header);
                logger.info("请求接口打印 IP ==={}", ip);
            }
        }
    }
    private String getRequestBody(HttpServletRequest request) {
        int contentLength = request.getContentLength();
        if (contentLength <= 0) {
            return "";
        }
        try {
            return request.getReader().readLine();
        } catch (IOException e) {
            logger.error("获取请求体失败", e);
            return "";
        }
    }
}

 

 

 

package com.xiwi.qa.common.utils.http;

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;

/**
 * file: BodyReaderHttpServletRequestWrapper
 * date: 2020-10-13
 * time: 8:46
 * explain:
 * author: Xiwi
 */
public class BodyReaderHttpServletRequestWrapper extends HttpServletRequestWrapper {
    private final byte[] body;

    public BodyReaderHttpServletRequestWrapper(HttpServletRequest request) throws IOException {
        super(request);
        String sessionStream = getBodyString(request);
        body = sessionStream.getBytes(Charset.forName("UTF-8"));
    }

    /**
     * 获取请求Body
     *
     * @param request
     * @return
     */
    public String getBodyString(final ServletRequest request) {
        StringBuilder sb = new StringBuilder();
        InputStream inputStream = null;
        BufferedReader reader = null;
        try {
            inputStream = cloneInputStream(request.getInputStream());
            reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName("UTF-8")));
            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();
    }

    /**
     * Description: 复制输入流
     *
     * @param inputStream
     * @return
     */
    public InputStream cloneInputStream(ServletInputStream inputStream) {
        ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
        byte[] buffer = new byte[1024];
        int len;
        try {
            while ((len = inputStream.read(buffer)) > -1) {
                byteArrayOutputStream.write(buffer, 0, len);
            }
            byteArrayOutputStream.flush();
        } catch (IOException e) {
            e.printStackTrace();
        }
        InputStream byteArrayInputStream = new ByteArrayInputStream(byteArrayOutputStream.toByteArray());
        return byteArrayInputStream;
    }

    @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 readListener) {
            }
        };
    }
}

 

 

最后把 logFilter 交给Spring管理；在启动类上 加上这一句

@ServletComponentScan(basePackages = "com.xiwi.qa.common.filter") //所扫描的包路径必须包含该Filter