SpringBoot獲取http數(shù)據(jù)、打印HTTP參數(shù)的4種方式

更新時間：2024年03月13日 11:17:24 作者：澄風(fēng)

Java的話本地打斷點可以調(diào)試獲取rest入?yún)?但是在生產(chǎn)環(huán)境可能我們獲取入?yún)ⅲ℉ttp?header/parameter）可能就沒有那么的輕松了,所以本文給大家介紹了SpringBoot獲取http數(shù)據(jù)、打印HTTP參數(shù)的4種方式,需要的朋友可以參考下

Java的話本地打斷點可以調(diào)試獲取rest入?yún)ⅲ╤ttp header），但是在生產(chǎn)環(huán)境可能我們獲取入?yún)ⅲ℉ttp header/parameter）可能就沒有那么的輕松了。我們可能在header中放置了很多自定的參數(shù)用來鑒權(quán)或者其他用途。如果排查問題的時候需要這些參數(shù)，我們有很多種選擇去獲取這些參數(shù)。

輸出到應(yīng)用日志中，比如使用logback,log.error(xxx)
借助nginx 輸出到access.log日志中
借助Skywalking/zipkin等中間件輸出到鏈路中
網(wǎng)關(guān)日志中輸出

1. 輸出到應(yīng)用日志中

我們可以借助Springboot的攔截器在進(jìn)入rest controller 之前將request header / param 輸出出來，在rest controller調(diào)用結(jié)束之后將response header / param輸出。

LogInterceptor
攔截器，注意攔截器和過濾器的區(qū)別，過濾器屬于Tomcat/Jetty/… Servlet 容器的生命周期維護(hù)的，要早于攔截器。過濾器是Springboot維護(hù)的攔截，在handler mapping 映射之后先去調(diào)用攔截器之后在調(diào)用controller。

在這里插入圖片描述

攔截器攔截的就是上圖4的這部分。

@Component
@Slf4j
public class LogInterceptor extends HandlerInterceptorAdapter {

    private static ThreadLocal<Long> threadLocal = new ThreadLocal<>();

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        threadLocal.set(System.currentTimeMillis());
        log.info("Request uri = [{}], method is: [{}]", request.getRequestURI(), request.getMethod());
        log.info("Request header is : [{}]", parseRequestHeaders(request));
        log.info("Request param is : [{}]", parseParams(request));

        if (request instanceof RequestCustomWrapper) {
            RequestCustomWrapper requestCustomWrapper = (RequestCustomWrapper) request;
            byte[] body = requestCustomWrapper.getBody();
            log.info("Request body is : [{}]", new String(body));
        }

        return super.preHandle(request, response, handler);
    }

    public static String parseParams (HttpServletRequest request) {
        StringBuilder stringBuilder = new StringBuilder();
        Enumeration<String> parameterNames = request.getParameterNames();
        while (parameterNames.hasMoreElements()) {
            String name = parameterNames.nextElement();
            request.getParameter(name);
            stringBuilder.append(name).append("=").append(";");
        }
        return stringBuilder.toString();
    }

    public static String parseRequestHeaders (HttpServletRequest request) {
        StringBuilder stringBuilder = new StringBuilder();
        Enumeration<String> headerNames = request.getHeaderNames();
        while (headerNames.hasMoreElements()) {
            String name  = headerNames.nextElement();
            String value = request.getHeader(name);
            stringBuilder.append(name).append("=").append(value).append(";");
        }
        return stringBuilder.toString();
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        super.afterCompletion(request, response, handler, ex);
    }
}

RequestCustomWrapper
因為Springboot框架規(guī)定,Request getInputStream只能獲取一次，獲取第二次的時候就會報錯。所以這個時候需要實現(xiàn)RequestWrapper去包裹Request重寫getInputStream實現(xiàn)可重復(fù)獲取Request Stream。

@Slf4j
public class RequestCustomWrapper extends HttpServletRequestWrapper {

    private byte[] body;

    public byte[] getBody() {
        return body;
    }

    public RequestCustomWrapper(HttpServletRequest request) {
        super(request);
        try {
            body = readBytes(request.getReader());
        } catch (IOException e) {
            log.error("讀取request input stream失敗..");
        }
    }

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

    @Override
    public ServletInputStream getInputStream() throws IOException {
        try (final ByteArrayInputStream bais = new ByteArrayInputStream(body)) {
            return new ServletInputStream() {
                @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 bais.read();
                }
            };
        }

    }

    public byte[] readBytes (BufferedReader br) throws IOException {
        byte[] emptyBytes = new byte[0];
        String str;
        StringBuilder sb = new StringBuilder();
        while ((str = br.readLine()) != null) {
            sb.append(str);
        }

        if (StringUtils.isNotBlank(sb.toString())) {
            return sb.toString().getBytes(StandardCharsets.UTF_8);
        }

        return emptyBytes;
    }
}

RequestCustomFilter
全局過濾器到，在執(zhí)行到RequestCustomFilter這一層的時候，將ServletRequest包裹替換成自己的Request,實現(xiàn)可重復(fù)獲取Request Stream.

public class RequestCustomFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        if (servletRequest instanceof HttpServletRequest) {
            ServletRequest requestWrapper = new RequestCustomWrapper((HttpServletRequest) servletRequest);
            filterChain.doFilter(requestWrapper, servletResponse);
        } else {
            filterChain.doFilter(servletRequest, servletResponse);
        }
    }
}

WebMvcConfig
注冊過濾器和攔截器

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor())
                .addPathPatterns("/**");
    }

    @Bean
    public FilterRegistrationBean<RequestCustomFilter> requestCustomFilter () {
        FilterRegistrationBean<RequestCustomFilter> registrationBean = new FilterRegistrationBean<>();
        RequestCustomFilter requestCustomFilter = new RequestCustomFilter();
        registrationBean.setFilter(requestCustomFilter);
        registrationBean.addUrlPatterns("/*");
        registrationBean.setOrder(1);
        return registrationBean;
    }
}

2.Nginx 配置輸出Log

配置方式：

在nginx的配置文件中有個變量：$http_cookie來獲取cookie的信息。配置方式很簡單，只需要在nginx配置文件的http段，新添加一個log_format就可以了：
nginx.conf

log_format  sendfile  '$remote_addr - $remote_user [$time_local] "$request" '
              '$status $body_bytes_sent "$http_referer" '
              '"$http_user_agent" "$http_x_forwarded_for" "$http_cookie"';

在server.conf中加入

access_log  /var/log/php/access.log sendfile;

配置層級結(jié)構(gòu)

在這里插入圖片描述

sendfile 就是上面定義的log_format 的名字，只要acces_log 后面帶這個名字的日志，就會按照定義的格式輸出日志。

reload一下nginx就可以在日志里面看到cookie信息

nginx  -s  reload

Nginx 變量參考

$remote_addr #存放了客戶端的地址，注意是客戶端的公?IP
$args #變量中存放了URL中的指令http://www.magedu.net/main/index.do?id=090&partner=search以上：id=090&partner=search 即為 $args
$document_root #保存了針對當(dāng)前資源的請求的系統(tǒng)根?錄，如/apps/nginx/html
$cookie_name #表?key為 name 的cookie值
$document_uri #保存了當(dāng)前請求中不包含指令的URI，注意是不包含請求的指令，如http://www.magedu.net/main/index.do?id=090&partner=search會被定義為/main/index.do
$host；#存放了請求的host名稱
$http_user_agent #客戶端瀏覽器的詳細(xì)信息
$http_cookie #客戶端的cookie信息
$limit_rate #如果nginx服務(wù)器使?limit_rate配置了顯??絡(luò)速率，則會顯?，如果沒有設(shè)置，則顯?0
$remote_port #客戶端請求Nginx服務(wù)器時客戶端隨機(jī)打開的端?
$remote_user #已經(jīng)經(jīng)過Auth Basic Module驗證的?戶名
$request_body_file #做反向代理時發(fā)給后端服務(wù)器的本地資源的名稱
$request_method #請求資源的?式，GET/PUT/DELETE等
$request_filename #當(dāng)前請求的資源?件的路徑名稱，由root或alias指令與URI請求?成的?件絕對路徑，

3. 借助Skywalking/zipkin等中間件輸出到鏈路中

4. 網(wǎng)關(guān)日志中輸出

這里只簡單貼一下代碼介紹網(wǎng)管如何打印Http信息

@Component
@Slf4j
public class LoggingFilter implements GlobalFilter, Ordered {

    private static final String START_TIME = "START_TIME";

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        String info = String.format("Method: {%s} Host: {%s} Path: {%s} Query: {%s}",
                request.getMethod().name(),
                request.getURI().getHost(),
                request.getURI().getPath(),
                request.getQueryParams());
        log.info(info);
        exchange.getAttributes().put(START_TIME, System.currentTimeMillis());
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {
            Long start = exchange.getAttribute(START_TIME);
            if (start != null) {
                long executeTime = System.currentTimeMillis() - start;
                log.info(exchange.getRequest().getURI().getRawPath() + ":" + executeTime + "ms");
            }
        }));
    }

    @Override
    public int getOrder() {
        return Ordered.LOWEST_PRECEDENCE;
    }
}

以上就是SpringBoot獲取http數(shù)據(jù)、打印HTTP參數(shù)的4種方式的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot獲取、打印http參數(shù)的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: