SpringBoot项目使用AOP实现接口调用日志

目录

简介

前置准备工作

开始使用AOP

总结

注意事项

简介

项目中，使用AOP是一种常见的设计方式，可以在不侵入业务代码的前提下，对业务进行增强，springboot中事务注解@Transactional就是使用了AOP进行动态代理去实现事务，常见的AOP方式比如前置通知（增强）、后置通知、异常通知、环绕通知、最终通知，合适的AOP方式可以极大降低业务代码的冗余与侵入性，是开发中必不可少的一环。

本文使用了AOP中的AROUND ADVICE（环绕通知）进行接口日志处理

前置准备工作

导入Sping整合AOP的场景依赖启动器，已整合了切入点表达式和AOP

<!--AOP启动器-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
    <version>2.5.6</version>
</dependency>

开始使用AOP

1.定义自定义注解 @AutoLog

@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
public @interface AutoLog {
    String value() default "";
}

2.定义切面类 LogAspect.java

@Component
@Aspect
@Slf4j
public class LogAspect{
    //自定义切入点 代理每一个打上@AutoLog注解的类
    @Pointcut(value = "@within(io.binarymei.annotation.AutoLog)")
    public void AutoLog(){}
}

3.使用环绕通知进行增强

//定义环绕通知 增强打上AutoLog注解的类中所有方法
@Aroud(value = "AutoLog()")
public Object AutoLogAround(ProceedingJoinPoint proceedingJoinPoint){
    try{
        //前置通知
        //执行被增强的方法
        Object proceed = proceedingJoinPoint.proceed();
        //后置通知
    }catch(Exception e){
        //异常通知
    }finally{
        //最终通知
    }
}

总结

        这样，一个使用AOP环绕通知进行接口调用日志记录的小例子就完成了，打上注释的那些都是可以自由填写自己所需要的业务，比如记录接口的调用时间，请求信息，参数信息，以及响应信息，调用状态等等。

注意事项

        若被增强的方法出现异常时，由于自己手动捕获了异常，会导致全局异常处理器失效，以及如果此方法使用了事务，则事务也会失效，这里可以去查看《SpringBoot事务失效的原因》得到结论，本博客只做简单的解决方式。

        如果手动捕获了异常，那么，在记录了异常日志以及接口调用情况时，可以手动在catch中抛出此异常，那么全局异常处理器和事务就会正常生效。

//定义环绕通知 增强打上AutoLog注解的类中所有方法
@Aroud(value = "AutoLog()")
public Object AutoLogAround(ProceedingJoinPoint proceedingJoinPoint){
    try{
        //前置通知
        //执行被增强的方法
        Object proceed = proceedingJoinPoint.proceed();
        //后置通知
    }catch(Exception e){
        //异常通知
        log.error("接口调用异常，原因：{}",e.getMessage());
        //手动抛出自定义的异常
        BaseException.businessRunTimeException(e);
    }finally{
        //最终通知
    }
}