SpringBoot請求日誌超完整版

主要代碼如下所示：

import com.alibaba.fastjson.JSONObject;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
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.aspectj.lang.reflect.CodeSignature;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.context.annotation.Configuration;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import java.util.*;
import java.util.concurrent.TimeUnit;

/**
 * 請求日誌
 **/
@Slf4j
@Aspect
@Configuration
@AllArgsConstructor
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
// 啓動日誌的開關
@ConditionalOnProperty(value = "oa.search.log.request.enabled", havingValue = "true", matchIfMissing = true)
public class ResponseLogAspect {

    @Resource
    private HttpServletRequest request;

    /**
     * 匹配controller層的方法
     */
    @Pointcut(value = "(execution(* com.aoke.oa.search..*.controller.*.*(..)))")
    private void controllerPointcut() {
    }

    @Around(value = "controllerPointcut()")
    public Object process(ProceedingJoinPoint point) throws Throwable {
        String requestUri = Objects.requireNonNull(request).getRequestURI();
        String requestMethod = request.getMethod();

        // 構建成一條長 日誌，避免併發下日誌錯亂
        StringBuilder beforeReqLog = new StringBuilder(300);
        // 日誌參數
        List<Object> beforeReqArgs = new ArrayList<>();

        beforeReqLog.append("\n\n================  Request Start  ================\n");
        // 打印路由
        beforeReqLog.append("===> {}: {}");
        beforeReqArgs.add(requestMethod);
        beforeReqArgs.add(requestUri);

        Map<String, Object> paraMap = getNameAndValue(point);

        // 請求參數
        if (paraMap.isEmpty()) {
            beforeReqLog.append("\n");
        } else {
            beforeReqLog.append(" Parameters: {}\n");
            beforeReqArgs.add(JSONObject.toJSON(paraMap));
        }
        // 打印請求頭
        Enumeration<String> headers = request.getHeaderNames();
        while (headers.hasMoreElements()) {
            String headerName = headers.nextElement();
            String headerValue = request.getHeader(headerName);
            beforeReqLog.append("===Headers===  {} : {}\n");
            beforeReqArgs.add(headerName);
            beforeReqArgs.add(headerValue);
        }
        beforeReqLog.append("================  Request  End   ================\n");
        // 打印執行時間
        long startNs = System.nanoTime();
        log.info(beforeReqLog.toString(), beforeReqArgs.toArray());
        // aop 執行後的日誌
        StringBuilder afterReqLog = new StringBuilder(200);
        // 日誌參數
        List<Object> afterReqArgs = new ArrayList<>();
        afterReqLog.append("\n\n================  Response Start  ===============\n");
        try {
            Object result = point.proceed();
            // 打印返回結構體
            afterReqLog.append("===Result===  {}\n");
            afterReqArgs.add(JSONObject.toJSON(result));
            return result;
        } finally {
            long tookMs = TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNs);
            afterReqLog.append("<=== {}: {} ({} ms)\n");
            afterReqArgs.add(requestMethod);
            afterReqArgs.add(requestUri);
            afterReqArgs.add(tookMs);
            afterReqLog.append("================  Response  End   ===============\n");
            log.info(afterReqLog.toString(), afterReqArgs.toArray());
        }
    }

    /**
     * 獲取參數Map集合
     */
    private Map<String, Object> getNameAndValue(ProceedingJoinPoint joinPoint) {
        Map<String, Object> param = new HashMap<>(8);

        Object[] paramValues = joinPoint.getArgs();
        String[] paramNames = ((CodeSignature) joinPoint.getSignature()).getParameterNames();

        for (int i = 0; i < paramNames.length; i++) {
            param.put(paramNames[i], paramValues[i]);
        }

        if (log.isDebugEnabled()) {
            log.debug("param: {}", JSONObject.toJSONString(param));
        }
        return param;
    }
}