SpringBoot 日志切面

在 SpringBoot 中搞一下 AOP 切面，复习一下。太详细的概念就不用说了，直接看 Spring AOP实现吧，当时写的除了有点模糊也没什么大问题。

AOP 概念

在 SpringBoot 中使用 AOP，直接引入 spring-boot-starter-aop 的包即可：

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

再说一下几个关键概念，涉及到 AOP 注解的使用：

横切关注点 ：跨越程序多个模块的方法或功能。即与业务逻辑无关，但我们也要关注的部分，就是横切关注点。如日志、安全、缓存等。
切面（ Aspect ） ：将横切关注点模块化得到的特殊对象，即切面应是一个类，表现为 AOP 在哪干和干什么的集合。
连接点（ JoinPoint ） ：应用执行过程中能够插入切面的一个点，这个点可以是方法执行、方法调用、处理异常等，表现为 AOP 在哪干。
切入点（ PointCut ） ：切面通知执行的地点，即要插入增强处理的连接点，表现为 AOP 在哪干的集合。
通知（ Advice） ：切面要完成的增强处理，通知描述了切面何时执行以及如何执行增强处理，即通知应是切面中的方法，表现为 AOP 干什么。

在 Spring 中，通知分为五类：

@Before 前置通知：在方法执行前（紧邻切入点，后面会说）执行；
@Around 环绕通知：方法执行前后都有通知，通知在方法前还是后取决于其中的 ProceedingJoinPoint.proceed() 的位置；
@AfterThrowing 异常通知：方法抛出异常之后通知；
@AfterReturnning 返回通知：方法成功执行之后通知；
@After 最终通知：也叫后置通知，但感觉最终通知合适一点，在方法执行后执行。

当它们五个一起使用时，执行顺序为：

环绕通知的前置部分（ ProceedingJoinPoint.proceed() 之前的代码）；
前置通知；
目标方法；
异常通知（如果出现异常）；
返回通知（如果正常返回）；
最终通知；
环绕通知的异常部分（ try...catch 中的代码，如果出现异常）；
环绕通知的后置部分（ ProceedingJoinPoint.proceed() 之后的代码，如果正常返回）。

这个顺序时因为环绕通知的 ProceedingJoinPointproceed() 方法导致的，只有环绕通知可以使用 ProceedingJoinPoint，它是一个特殊的连接点 JoinPoint 参数，除了可以获取连接点的信息外，还能控制方法的执行。

日志切面

先放上完整代码：

@EnableAspectJAutoProxy
@Component
@Aspect
@Slf4j
public class LogAspect {

    @Pointcut("execution(* org.qiyuanc.service.*.*(..))")
    private void pointCut(){
        // Just a pointcut
    }

    @Before("pointCut()")
    public void doBefore(JoinPoint jp){
        String className = jp.getTarget().getClass().getSimpleName();
        String methodName = jp.getSignature().getName();
        log.info("==========前置通知 {}.{} 参数 {} ==========", className, methodName, jp.getArgs());
    }

    @Around("pointCut()")
    public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
        String className = pjp.getTarget().getClass().getSimpleName();
        String methodName = pjp.getSignature().getName();

        // 记录进入
        log.info("==========环绕通知 进入方法 {}.{} ==========", className, methodName);

        Object result = null;
        try {
            result = pjp.proceed();
        } catch (Throwable throwable) {
            // 记录异常，重新抛出，异常不应该在这里被吞没
            log.error("==========环绕通知 出现异常 {}.{} : {} ==========", className, methodName, throwable.getMessage());
            throw throwable;
        }

        // 记录退出
        log.info("==========环绕通知 退出方法 {}.{} ==========", className, methodName);
        return result;
    }

    @AfterReturning(pointcut = "pointCut()", returning = "result")
    public void doAfterReturning(JoinPoint jp, Object result){
        String className = jp.getTarget().getClass().getSimpleName();
        String methodName = jp.getSignature().getName();
        log.info("==========返回通知 {}.{} 返回值 {} ==========", className, methodName, result);
    }

    @AfterThrowing(pointcut = "pointCut()", throwing = "ex")
    public void doAfterThrowing(JoinPoint jp, Exception ex){
        String className = jp.getTarget().getClass().getSimpleName();
        String methodName = jp.getSignature().getName();
        log.info("==========异常通知 {}.{} 异常 {} ==========", className, methodName, ex.getMessage());
    }

    @After("pointCut()")
    public void doAfter(JoinPoint jp){
        String className = jp.getTarget().getClass().getSimpleName();
        String methodName = jp.getSignature().getName();
        log.info("==========最终通知 {}.{} ==========", className, methodName);
    }
}

说明一下其中的几个点：

@EnableAspectJAutoProxy 是一个 Spring 注解，用于启用基于注解的 Spring AOP 支持；此处只有一个切面类就写在上面了，不然一般写在配置类上比较好；
@Aspect 注解标记此类为一个切面类，Spring 才会将此类作为切面处理；
@PointCut 注解声明一个切入点，它下面的方法只是个皮套，这个注解写在方法上，使用通知注解时指定这个方法就可以了，相当于别名；不然就要在每个通知注解里指定切入点，很麻烦；
@Around 环绕通知里的 ProceedJoinPoint 参数可以控制方法的执行，只有环绕通知能用这个参数，其他的通知只能用 JoinPoint 类型的；
@AfterReturning 使用到了返回值参数，需要在注解中绑定，@AfterThrowing 同理。

最后附上执行时的日志，正常执行时：

2023-04-25 11:05:42.287  INFO 15752 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========环绕通知 进入方法 TestService.DataListRead ==========
2023-04-25 11:05:42.288  INFO 15752 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========前置通知 TestService.DataListRead 参数 [java.io.FileInputStream@22ddb664, test.xlsx] ==========
2023-04-25 11:05:42.537  INFO 15752 --- [nio-8080-exec-1] org.qiyuanc.service.TestService: 
==========TestService 读取数据==========
2023-04-25 11:05:42.537  INFO 15752 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========返回通知 TestService.DataListRead 返回值 [TestEntity(A=1A, B=1B, C=1C, D=1D, F=1E)] ==========
2023-04-25 11:05:42.537  INFO 15752 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========最终通知 TestService.DataListRead ==========
2023-04-25 11:05:42.537  INFO 15752 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========环绕通知 退出方法 TestService.DataListRead ==========

出现异常时：

2023-04-25 10:58:27.329  INFO 19208 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========环绕通知 进入方法 TestService.DataListRead ==========
2023-04-25 10:58:27.329  INFO 19208 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========前置通知 TestService.DataListRead 参数 [java.io.FileInputStream@50548568, test.xlsx] ==========
2023-04-25 10:58:27.581  INFO 19208 --- [nio-8080-exec-1] org.qiyuanc.service.TestService: 
==========TestService 读取数据==========
2023-04-25 10:58:27.581  INFO 19208 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========异常通知 TestService.DataListRead 异常 测试 ==========
2023-04-25 10:58:27.581  INFO 19208 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========最终通知 TestService.DataListRead ==========
2023-04-25 10:58:27.581 ERROR 19208 --- [nio-8080-exec-1] org.qiyuanc.aspect.LogAspect: 
==========环绕通知 出现异常 TestService.DataListRead : 测试 ==========

使用起来还是很简单的。