SpringBoot AOP日志切面

AOP切面

AOP(Aspect-Oriented Programming，面向切面编程)，它利用一种”横切”的技术，将那些多个类的共同行为封装到一个可重用的模块。便于减少系统的重复代码，降低模块之间的耦合度，并有利于未来的可操作性和可维护性。

AOP相关概念

Aspect（切面）：声明类似于Java中的类声明，在Aspect中会包含一些Pointcut及相应的Advice。

Joint point（连接点）：表示在程序中明确定义的点。包括方法的调用、对类成员的访问等。

Pointcut（切入点）：表示一个组Joint point，如方法名、参数类型、返回类型等等。

Advice（通知）：Advice定义了在Pointcut里面定义的程序点具体要做的操作，它通过(before、around、after(return、throw)、finally来区别实在每个Joint point之前、之后还是执行前后要调用的代码。

Before：在执行方法前调用Advice，比如请求接口之前的登录验证。

Around：在执行方法前后调用Advice，这是最常用的方法。

After：在执行方法后调用Advice，after、return是方法正常返回后调用，after\throw是方法抛出异常后调用。

Finally：方法调用后执行Advice，无论是否抛出异常还是正常返回。

AOP proxy：AOP proxy也是Java对象，是由AOP框架创建，用来完成上述动作，AOP对象通常可以通过JDK dynamic proxy完成，或者使用CGLIb完成。

Weaving：实现上述切面编程的代码织入，可以在编译时刻，也可以在运行时刻，Spring和其它大多数Java框架都是在运行时刻生成代理。

代码示例

POM引入

<!-- SpringBoot Aop组件-->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- 分析客户端信息的工具类-->
<dependency>
   <groupId>eu.bitwalker</groupId>
   <artifactId>UserAgentUtils</artifactId>
   <version>1.21</version>
</dependency>

切面：LogAspect代码

/**
 * 添加aop日志打印
 *
 * @author yanqs
 * @date   2020/1/13 14:42
 */
@Aspect
@Component
@Slf4j
public class LogAspect {
    /**
     * 进入方法时间戳
     */
    private Long startTime;
    /**
     * 方法结束时间戳(计时)
     */
    private Long endTime;

    public LogAspect() {

    }

    /**
     * 定义请求日志切入点，其切入点表达式有多种匹配方式,这里是指定路径
     */
    @Pointcut("execution(public * com.springboot.logaop.controller.*.*(..))")
    public void logPointcut() {
    }

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

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

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

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

@Before和@AfterReturning部分也可使用以下代码替代

/**
 * 在执行方法前后调用Advice，这是最常用的方法，相当于@Before和@AfterReturning全部做的事儿
 *
 * @param pjp
 * @return
 * @throws Throwable
 */
@Around("logPointcut()")
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
    // 接收到请求，记录请求内容
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    HttpServletRequest request = attributes.getRequest();
    //获取请求头中的User-Agent
    UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
    //打印请求的内容
    startTime = System.currentTimeMillis();
    log.info("请求Url : {}", request.getRequestURL().toString());
    log.info("请求方式 : {}", request.getMethod());
    log.info("请求ip : {}", request.getRemoteAddr());
    log.info("请求方法 : ", pjp.getSignature().getDeclaringTypeName(), ".", pjp.getSignature().getName());
    log.info("请求参数 : {}", Arrays.toString(pjp.getArgs()));
    // 系统信息
    log.info("浏览器：{}", userAgent.getBrowser().toString());
    log.info("浏览器版本：{}", userAgent.getBrowserVersion());
    log.info("操作系统: {}", userAgent.getOperatingSystem().toString());
    // pjp.proceed()：当我们执行完切面代码之后，还有继续处理业务相关的代码。proceed()方法会继续执行业务代码，并且其返回值，就是业务处理完成之后的返回值。
    Object ret = pjp.proceed();
    log.info("请求结束时间：" + LocalDateTime.now());
    log.info("请求耗时：{}", (System.currentTimeMillis() - startTime));
    // 处理完请求，返回内容
    log.info("请求返回 : ", ret);
    return ret;
}

测试结果

2021-12-13 15:58:16.219  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 请求开始时间：2021-12-13T15:58:16.219
2021-12-13 15:58:16.220  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 请求Url : http://localhost:8080/test/getGetId
2021-12-13 15:58:16.220  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 请求方式 : GET
2021-12-13 15:58:16.220  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 请求ip : 0:0:0:0:0:0:0:1
2021-12-13 15:58:16.221  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 请求方法 : 
2021-12-13 15:58:16.221  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 请求参数 : [zhangsan]
2021-12-13 15:58:16.221  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 浏览器：CHROME9
2021-12-13 15:58:16.221  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 浏览器版本：96.0.4664.55
2021-12-13 15:58:16.221  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 操作系统: WINDOWS_10
2021-12-13 15:58:16.229  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 请求结束时间：2021-12-13T15:58:16.229
2021-12-13 15:58:16.229  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 请求耗时：14
2021-12-13 15:58:16.229  INFO 21528 --- [nio-8080-exec-1] c.s.logaop.config.aspect.LogAspect       : 请求返回 : zhangsan