aop打印请求日志

十万光年丶

已于 2024-05-16 09:31:30 修改

阅读量290

点赞数 1

文章标签： java 开发语言

于 2023-06-07 11:04:37 首次发布

本文链接：https://blog.youkuaiyun.com/u010200239/article/details/131083700

版权

该代码示例展示了如何使用SpringAOP进行接口日志打印，特别是如何在切点参数中过滤请求和响应对象以避免序列化异常。它定义了一个切点在@RestController注解的类中，然后在方法调用前后记录时间戳，处理请求和响应参数，并利用Hutool库的JSONUtil将参数转换为JSON字符串进行日志输出。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

point 切点参数中如果包含请求或者响应对象, 不能进行序列化, 以下代码做了过滤

package com.deloitte.crm.config;

import cn.hutool.core.util.StrUtil;
import cn.hutool.json.JSONUtil;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

/**
 * 打印系统日志
 *
 * @author -_-
 */
@Aspect
@Component
@Slf4j
@RequiredArgsConstructor
public class ReqPrintAop {

    private static final String REQ_LOG =
            "\n" +
            "╔══════════════════════════════════════════════════════════════════════════════════════════════\n" +
            "  请求耗时: {}ms\n" +
            "  请求方式: {}\n" +
            "  请求地址: {}\n" +
            "  方法路径: {}\n" +
            "  请求参数: {}\n" +
            "  响应数据: {}\n" +
            "╚══════════════════════════════════════════════════════════════════════════════════════════════";

    private final HttpServletRequest request;
    private static final ThreadLocal<Long> apiThreadLocal = new ThreadLocal<>();

    /**
     * 打印接口日志
     */
    @Pointcut("@within(org.springframework.web.bind.annotation.RestController)")
    public void api() {
    }

    @Before(value = "api()")
    public void beforeApi() {
        apiThreadLocal.set(System.currentTimeMillis());
    }


    /**
     * 返回前通知
     *
     * @param point 切点
     * @param res   返回体
     */
    @AfterReturning(returning = "res", pointcut = "api()")
    public void doAfterReturning(JoinPoint point, Object res) {
        try {
            long reqTime = Long.MAX_VALUE;
            if (apiThreadLocal.get() != null) {
                reqTime = System.currentTimeMillis() - apiThreadLocal.get();
                apiThreadLocal.remove();
            }

            String methodWay = StrUtil.format("{}.{}",
                    point.getSignature().getDeclaringTypeName(),
                    point.getSignature().getName());
            ;
            String url = String.valueOf(request.getRequestURL());
            String method = request.getMethod();

            //过滤掉 请求和响应对象, 否则序列化会出现异常
            List<Object> reqParamList = Arrays.stream(point.getArgs())
                    .filter(x -> !(x instanceof ServletRequest || x instanceof ServletResponse))
                    .collect(Collectors.toList());

            String reqParams = JSONUtil.toJsonStr(reqParamList);
            String rspParams = JSONUtil.toJsonStr(res);
            log.debug(REQ_LOG, reqTime, method, url, methodWay, reqParams, rspParams);
        } catch (Exception e) {
            log.error("打印接口日志错误！", e);
        }
    }
}