AOP 打印请求日志(代码可直接 copy 版)

943 阅读2分钟

注意,如果是非 URL 请求拿不到 body 的。如果定时任务也调用到了请根据自己的业务调整,写个帖子知识方便大家直接用。

@Aspect
@Component
@Slf4j
public class WebLogAspect {

    /**
     * 进入方法时间戳
     */
    private Long startTime;
    /**
     * 方法结束时间戳(计时)
     */
    private Long endTime;

    public WebLogAspect() {
    }


    @Pointcut("execution(* com.xxx.api..*.*(..))")
    public void api() {
    }

    @Pointcut("execution(* com.xxx.controller..*.*(..))")
    public void controller() {
    }

    @Pointcut("api() || controller()")
    public void webLogPointcut() {
    }

    /*
     * 前置通知:
     * 1. 在执行目标方法之前执行,比如请求接口之前的登录验证;
     * 2. 在前置通知中设置请求日志信息,如开始时间,请求参数,注解内容等
     *
     */
    @Before("webLogPointcut()")
    public void doBefore(JoinPoint joinPoint) {

        // 接收到请求,记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (attributes == null) {
            log.info("attributes 为null,不记录");
            return;
        }
        HttpServletRequest request = attributes.getRequest();
        //获取请求头中的User-Agent
//     UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
        //打印请求的内容
        startTime = System.currentTimeMillis();
        log.info("请求开始时间-->{},请求Url-->{},请求方式-->{},请求ip-->{},请求方法-->{},请求参数-->{}",
                LocalDateTime.now(), request.getRequestURL().toString(), request.getMethod(), request.getRemoteAddr(), joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName(),
                Arrays.toString(joinPoint.getArgs()));
        // 系统信息
//     log.info("浏览器:{}", userAgent.getBrowser().toString());
//     log.info("浏览器版本:{}", userAgent.getBrowserVersion());
//     log.info("操作系统: {}", userAgent.getOperatingSystem().toString());
    }

    /*
     * 返回通知:
     * 1. 在目标方法正常结束之后执行
     * 1. 在返回通知中补充请求日志信息,如返回时间,方法耗时,返回值,并且保存日志信息
     */
    @AfterReturning(returning = "ret", pointcut = "webLogPointcut()")
    public void doAfterReturning(Object ret) {
        endTime = System.currentTimeMillis();
        log.info("请求结束时间:{},请求耗时:{},请求返回 : {}", LocalDateTime.now(), endTime - startTime, ret);
    }

    /*
     * 异常通知:
     * 1. 在目标方法非正常结束,发生异常或者抛出异常时执行
     * 1. 在异常通知中设置异常信息,并将其保存
     *
     * @param throwable
    @AfterThrowing(value = "webLogPointcut()", throwing = "throwable")
    public void doAfterThrowing(Throwable throwable) {
    // 保存异常日志记录
    log.error("发生异常时间:{}" + LocalDateTime.now());
    log.error("抛出异常:{}" + throwable.getMessage());
    }

   /**
    * 在执行方法前后调用Advice,这是最常用的方法,相当于@Before和@AfterReturning全部做的事儿

    @Around("webLogPointcut()")
    public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
        // 接收到请求,记录请求内容
        Object ret = pjp.proceed();
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (attributes == null) {
            log.info("attributes 为null,不记录,pjp-->{}", pjp);
            return ret;
        }
        HttpServletRequest request = attributes.getRequest();
        //获取请求头中的User-Agent
        UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
        //打印请求的内容
        startTime = System.currentTimeMillis();
        log.info("请求Url-->{},请求方式-->{},请求ip-->{},请求方法-->{},请求参数-->{},浏览器-->{},浏览器版本-->{},操作系统-->{},请求结束时间-->{},请求耗时-->{},请求返回-->{}",
                request.getRequestURL().toString(), request.getMethod(), request.getRemoteAddr(), pjp.getSignature().getDeclaringTypeName() + "." + pjp.getSignature().getName(),
                Arrays.toString(pjp.getArgs()), userAgent.getBrowser().toString(), userAgent.getBrowserVersion(), userAgent.getOperatingSystem().toString(), LocalDateTime.now(),
                (System.currentTimeMillis() - startTime), ret);
        return ret;
    }*/
}

原理不用说了吧,只要不在里面加业务一般没问题的。