Spring AOP详解

SmellyCat1024
198 阅读5分钟

Spring AOP详解

AOP（Aspect Oriented Programming），即面向切面编程。 是OOP（Object Oriented Programming，面向对象编程）的补充和完善。 AOP 要达到的效果是，在不修改源代码的前提下，为业务组件添加某种通用功能。所以AOP 的本质就是由 AOP 框架修改业务组件的源代码。 按照修改源代码的时机，AOP 框架分为静态 AOP 实现 和动态 AOP 实现两类。

  • 静态 AOP 实现，通常使用AspectJ。
  • 动态 AOP 实现，通常使用 JDK 动态代理，或CGlib 动态代理。

Spring AOP是基于动态代理实现的。Spring AOP会看看你的类有没有实现接口，有的话使用JDK 动态代理，没有的话使用CGlib。

1 AspectJ

AOP 框架在编译阶段对程序目标类进行修改，生成了静态的 AOP 代理类。使AOP 框架使用特定的编译器，使生成的 *.class 文件被改掉了。 AOP相关的代码，和目标类的结合过程叫做织入(weave)。AspectJ的织入过程，有可能发生在三个阶段：

  • 编译时织入(Compile-time weaving)
    用AspectJ的编译器ajc，在项目编译的阶段就将代码织入目标类
  • 编译后织入(Post-compile weaving)
    用AspectJ的编译器ajc，向javac编译出来的.class或者.jar织入代码
  • 加载时织入(Load-time weaving)
    类加载器将字节码加载到JVM前织入

2 AOP核心概念

2.1 AOP相关术语

  • 连接点(Joinpoint)
    Joinpoint是程序在运行过程中能够插入Aspect的地点，比如方法调用、异常抛出、字段修改等。 在 Spring AOP 中，连接点总是方法的调用。

  • 切入点(Pointcut)
    Pointcut用于定义Advice应该切入到哪些Joinpoint上， 根据Pointcut的通配或者正则表达式来定义要拦截的Joinpoint。

  • 通知(Advice)
    Advice定义了在Pointcut上执行的增强处理，是拦截到Joinpoint之后要执行的代码。

  • 切面(Aspect)
    Aspect通常是一个类，可以定义Pointcut和Advice。Aspect指明在哪个Pointcut执行什么Advice。

  • 目标对象(Target)
    Target是指代理的目标对象，是指要织入Advice的对象。

  • 织入(weaving)
    通过Pointcut切入，将Aspect应用到Target并创建代理对象创建。

image.png

2.2 通知Advice 的类型

Advice可以分为前置通知Before、后置通知AfterReturning、异常通知AfterThrowing、最终通知After、环绕通知Around五类。

  • 前置通知 before
    在Joinpoint前被执行的Advice
  • 后置通知 AfterReturning
    在一个Joinpoint 正常返回后执行的Advice
  • 异常通知 AfterThrowing
    当一个Joinpoint 抛出异常后执行的Advice
  • 最终通知 after
    Joinpoint 无论是正常退出还是发生了异常，都会被执行的 advice
  • 环绕通知 around
    在Joinpoint前和Joinpoint退出后都执行的Advice。 这个是最常用的 Advice

image.png

各个通知的执行顺序如图所示。

3 Spring AOP的代码demo

Spring借用了@AspectJ的注解来定义切面。AopAutoConfiguration会添加@EnableAspectJAutoProxy注解以开启AspectJ注解的使用，也就是说加了@Aspect注解的切面类，一放到容器中，Spring AOP就自动完成织入。
在Spring Boot中引入AOP Starter依赖：

     <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
     </dependency>
3.1 定义注解MyLogger
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyLogger {

}
3.2 定义服务接口接口和实现类
// 接口
public interface IService {
     void myMethod();
}

// 实现类
@Slf4j
@Service
public class MyService implements IService{
    // 使用自定义日志注解对方法进行拦截
    @MyLogger
    @Override
    public void myMethod() {
        log.info("执行方法");
    }
}
3.3 定义Pointcut
   /**
     * 定义切点，匹配所有使用了@MyLogger注解的方法
     */
    @Pointcut("@annotation( com.dc.artemis.server.qian.MyLogger)")
    public void logPointcut() {
    }
3.4 定义Advice
 /**
     * 这里使用环绕通知
     */
   @Around("logPointcut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        log.info("@Around before");
        Object returnValue = joinPoint.proceed();
        log.info("@Around after");
        return returnValue;
    }
3.5 切面Aspect完整的代码
@Slf4j
@Aspect // 使用注解定义切面
@Component
@EnableAspectJAutoProxy // 开启AOP
public class LogAspect {
    
    /**
     * 定义切点，匹配所有使用了@MyLogger注解的方法
     */
    @Pointcut("@annotation( com.dc.artemis.server.qian.MyLogger)")
    public void logPointcut() {
    }

    @Around("logPointcut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        log.info("@Around before");

        Object returnValue = joinPoint.proceed();
        log.info("@Around after");
        return returnValue;
    }
}
3.6 测试

调用

  @Test
    void testMyService() {
        myService.myMethod();
    }

输出

2022-10-15 17:34:04.470  INFO 87770 --- [main] com.dc.artemis.server.qian.LogAspect : @Around before
2022-10-15 17:34:04.496  INFO 87770 --- [main] com.dc.artemis.server.qian.MyService: 执行方法
2022-10-15 17:34:04.497  INFO 87770 --- [main] com.dc.artemis.server.qian.LogAspect: @Around after

由于MyService没有实现接口，可以看到Spring使用了CGLIB生成代理对象

image.png

4 CGlib 动态代理代码demo

在Spring Boot中引入CGlib依赖：

     <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
     </dependency>
4.1 定义服务类
@Slf4j
@Service
public class CglibService {
    public void myMethod() {
        log.info("执行方法");
    }
}
4.2 定义拦截器

MethodInterceptor#intercept参数

  • object 表示要进行增强的对象
  • method 表示拦截的方法
  • objects 表示参数列表，基本数据类型需要传入其包装类型
  • methodProxy 表示对方法的代理，invokeSuper方法表示对被代理对象方法的调用
@Slf4j
public class LogInterceptor implements MethodInterceptor {
    @Override
    public Object intercept(Object object, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        log.info("intercept before...");
        // invokeSuper方法表示对被代理对象方法的调用
        Object result = methodProxy.invokeSuper(object, objects);  
        log.info("intercept after...");
        return result;
    }
}
4.3 定义代理类创建工厂
public class CglibProxyFactory {
    public static Object creteProxy(Object target, MethodInterceptor methodInterceptor) {
        // 创建Enhancer对象，类似于JDK动态代理的Proxy类
        Enhancer enhancer = new Enhancer();
        // 设置目标类的字节码文件
        enhancer.setSuperclass(target.getClass());
        // 设置回调函数
        enhancer.setCallback(methodInterceptor);
        // create方法正式创建代理类
        return enhancer.create();
    }
}
4.4 测试

调用

@Autowired
private CglibService cglibService;

@Test
void test() {
    LogInterceptor logInterceptor = new LogInterceptor();
    CglibService proxy = (CglibService)CglibProxyFactory.creteProxy(cglibService, logInterceptor);
    proxy.myMethod();
}

输出

2022-10-22 16:06:58.768  INFO 23040 --- [main] c.dc.artemis.server.qian.LogInterceptor  : intercept before...
2022-10-22 16:06:58.782  INFO 23040 --- [main] com.dc.artemis.server.qian.CglibService  : 执行方法
2022-10-22 16:06:58.783  INFO 23040 --- [main] c.dc.artemis.server.qian.LogInterceptor  : intercept after...
avatar
文章
阅读
粉丝