本文我们自定义Spring AOP Annotation。首先介绍AOP的概念,了解其优点。接着通过实例一步步带你实现一个日志注解,让更深理解AOP Annotation。
什么是AOP Annotation
AOP即面向方面编程,本质上是给已存在的代码增加行为,而不需要修改原有代码。AOP更多细节包括 pointcut
和 advice
,读者可自己搜索更多内容,本文认为你已经了解这些基本概念。
我们实现的AOP是通过注解驱动,我们可能对事务注解 @Transactional
非常熟悉。
@Transactional
public void orderGoods(Order order) {
// A series of database calls to be performed in a transaction
}
关键是非侵入性,使用注解元数据,核心业务逻辑不会被事务代码污染。因此比较容易重构、测试。有时Spring开发者认为这非常神奇,不知道这是如何实现的。实际上原理不是很复杂,学习完本文,你就能创建自己注解,以理解和利用AOP。
增加依赖
引入Spring Boot和Aop依赖。
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.2.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
</dependencies>
创建自定义注解
我们定义注解用于实现记录方法执行时间,创建注解如下:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogExecutionTime {
}
@Target
注解确定注解应用范围,这里定义ElementType.METHOD,即只能在方法上使用。如果在其他地方使用代码会编译失败。这是有意义的,因为我们的注解是为了记录方法的执行时间。
@Retention
表明注解是否在JVM运行时有用。缺省不是,Spring Aop看不到该注解,因此需要重新配置。
创建Aspect
注解定义好了,下面创建aspect。它封装横切的概念,我们示例要实现对方法执行增加记录时间。在定义类上增加@Aspect 注解:
@Aspect
@Component
public class ExampleAspect {
}
同时也增加 @Component
注解,因为也需要Spring Bean检测到。下面我们将实现业务逻辑。
创建切点和通知
在上面类中增加方法,定义切点和通知:
@Around("@annotation(LogExecutionTime)")
public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
return joinPoint.proceed();
}
上面代码并没有改变任何行为,但仍需要分析下。
首先我们增加注解 @Around
,这是通知,即在执行方法之前和之后增加额外的代码。还有其他类型的通知,如之前,之后。这里不深入探究。
接下来, @Around
注解中增加切点参数。上面代码表示,应用我们的通知到所有增加了 LogExecutionTime
注解的方法。logExecutionTime 方法就是通知,它有单个参数 ProceedingJoinPoint
,我们场景中要执行标记了*@LogExecutionTime* 的方法。
最后,当我们的带注释的方法被调用时,将首先调用我们的通知。这就由通知来决定下一步该做什么。在我们的例子中,我们的通知除了调用proceed()之外什么也不做,而proceed()就是调用原始的带注释的方法。
记录执行时间
到目前已经有了骨架,下面增加额外的业务逻辑。记录调用原始方法的执行时间:
@Around("@annotation(LogExecutionTime)")
public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
long start = System.currentTimeMillis();
Object proceed = joinPoint.proceed();
long executionTime = System.currentTimeMillis() - start;
System.out.println(joinPoint.getSignature() + " executed in " + executionTime + "ms");
return proceed;
}
这里没有增加复杂的内容。仅仅记录当前时间,执行方法,最后在控制台打印花了多少时间。同时也通过使用joinpoint获取方法签名,当然还可以获取其他信息,比如方法参数。
现在,我们通过注解测试方法,然后执行方法看看是否和预期一致。
@LogExecutionTime
public void serve() throws InterruptedException {
Thread.sleep(2000);
}
总结
本文利用Spring Boot AOP创建自定义注解,通过注解可以在bean方法中插入额外的业务而不修改原来代码。
本文参考链接:https://blog.csdn.net/neweastsun/article/details/117371986