SpringBoot 通過aop獲取@RequestBody以及RequestQueryString 參數記錄到日志

一  目的。

通過使用Spring的aop中point.getArgs()方法可以獲取body參數，這種對源代碼的侵入性比較小，優先選擇。

二 最終的日志展示效果

請求接口時間：2022-01-06 17:08:44,信息為:
【request_id】：b541f6ce42d249e781233b5fbb911efd
【請求 URL】：http://localhost:802/busquery/testloghandle
【請求 IP】：0:0:0:0:0:0:0:1
【請求類名】：com.siisoo.ontimebusquery.controller.QueryController【請求方法名】：testLogHandle
【body】：[{"age":"20","phone":"1234567"}]
【請求參數】：{"is_up_down":["1"],"line_no":["9"]} 

三  切面類源碼

package com.siisoo.ontimebusquery.handle;

import cn.hutool.core.util.IdUtil;
import com.alibaba.fastjson.JSON;
import com.siisoo.ontimebusquery.util.DateUtil;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Map;

/**

 * REST接口統一的日志處理
 */
@Aspect
@Component
public class LogHandle {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());
    @Pointcut("execution(* com.siisoo.ontimebusquery.controller..*.*(..))")
    public void restLog(){}
    @Around("restLog()")
    public void doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 生成本次請求時間戳
        String timestamp = System.currentTimeMillis()+"";
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes sra = (ServletRequestAttributes) ra;
        HttpServletRequest request = sra.getRequest();
        String url = request.getRequestURL().toString();
        String method = request.getMethod();
        String uri = request.getRequestURI();
        String queryString = request.getQueryString();
        Map<String, String[]> parameterMap = request.getParameterMap();
        StringBuffer sb = new StringBuffer();
        String requestId = IdUtil.simpleUUID();
        sb.append("\n【request_id】：").append(requestId);
        sb.append("\n【請求 URL】：").append(request.getRequestURL());
        sb.append("\n【請求 IP】：").append(getIp(request));
        sb.append("\n【請求類名】：").append(joinPoint.getSignature().getDeclaringTypeName());
        sb.append("【請求方法名】：").append(joinPoint.getSignature().getName());
        sb.append("\n【body】：").append(JSON.toJSONString(joinPoint.getArgs()));
        sb.append("\n【請求參數】：").append(JSON.toJSONString(parameterMap));

        String requestLog=sb.toString();

        logger.info(" \n 請求接口時間："+ DateUtil.getCurrentDateTime() + ",信息為:{} ", requestLog);
        // result的值就是被攔截方法的返回值
        Object result = joinPoint.proceed();
        logger.info(timestamp + " , " + result.toString());
    }

    private String getIp(HttpServletRequest request) {
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getRemoteAddr();
        }
        return ip;
    }

}

四  pom.xml中的maven依賴

 <dependency>

    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.7.18</version>
</dependency>

<dependency>
    <groupId>eu.bitwalker</groupId>
    <artifactId>UserAgentUtils</artifactId>
    <version>1.21</version>
</dependency>

五 請求測試

 

 可以看到，分別記錄下了requestparameter以及requestbody的所傳進來的所有參數信息，方便后續業務中進行BUG定位。