前期准备
这里的前期准备与XML配置类相同,核心的看如何通过注解实现AOP
以Spring为框架,只需要准备一个待加强的类。
以一个用户登录的例子,这个类中有两个方法,登录和登出。现在需要做一件事,在登录前
输出当前时刻,在登出前
也输出当前时刻。
public class UserService {
public void login(){
// 增强1
System.out.println("用户登录");
}
public void logOut(){
// 增强2
System.out.println("用户登出");
}
}
增强类
这里使用了日期模板,以及使用模板输出时间。
public class TimePrint {
SimpleDateFormat matter = new SimpleDateFormat("现在时间:yyyy年MM月dd日E HH时mm分ss秒");
public void printTime(){
System.out.println(matter.format(new Date()));
}
}
注意事项:
Spring底层还是使用的是aspectj
的方式,所以一定要再加上该依赖。
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.1</version>
</dependency>
使用注解的方式
我们不妨大胆设想一下,使用注解应该要有哪些内容:
- 【Bean注册,
@Component
】:待增强的类和增强的类都需要被Spring
容器管理。这一点毋庸置疑,那么就需要在两个类上加上@Component
注解. - 【切面类,
@Aspect
】:加上@Component
注解只表示将该类作为一个普通的Bean放到容器中,这对增强的类还不够。所以,我们还需要告诉容器增强的类是一个切面类(该增强类中的方法是抽取出来用来增强其他方法的)。那这就需要在增强类上添加@Aspect
注解。 - 【切面类的方法如何增强原方法】:也就是之前说5种增强类型:
- before 前置通知:目标对象的方法调用之前触发。
- after后置通知:目标对象的方法调用之后触发。
- afterReturning 返回通知:目标对象的方法调用完成,在返回结果值之后触发。
- afterThrowing 异常通知:目标对象的方法运行中抛出 / 触发异常后触发。
- around 环绕通知:编程式控制目标对象的方法调用。
在注解中分别对应为:
- before 前置通知:
@Before
- after后置通知:
@After
- afterReturning 返回通知:
@AfterReturning
- afterThrowing 异常通知:
@AfterThrowing
- around 环绕通知:
@Around
- 【切点的表达式】:和XML的表达式一样
- 【配置类,有一个注意事项!】...【启动类】...
OK,开始动手,我们从第二步和第三步开始。
声明切面类及切点表达式
一样的,先直接贴出代码,然后我们一步步解释。
@Component
@Aspect
public class TimePrint {
SimpleDateFormat matter = new SimpleDateFormat("现在时间:yyyy年MM月dd日E HH时mm分ss秒");
@Before("execution(public * juejin.aopAnnotation.bean.UserService.* (..))")
public void printTime(){
System.out.println(matter.format(new Date()));
}
}
将不重要的内容去除后,剩下
@Aspect
:表示TimePrint
是一个切面类。@Before
:表示printTime
是一个前置增强方法,将在目标对象执行方法前执行"execution(public * juejin.aopAnnotation.bean.UserService.* (..))"
:表示printTime
方法是给包名是juejin.aopAnnotation.bean
,类是UserService
中的所有返回值是任意的方法,并且参数个数任意。
配置类
这里的配置类有一个注意事项:
需要在配置类上额外加上@EnableAspectJAutoProxy
:表示自动装配支持AOP的内容。
@Configuration
@ComponentScan("juejin.aopAnnotation")
@EnableAspectJAutoProxy
public class AnnotationAopConfig {
}
启动类
就是正常的使用AnnotationConfigApplicationContext
读取配置类,然后拿Bean
执行方法。
public class AopAnnotationApplication {
public static void main(String[] args) throws InterruptedException {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(AnnotationAopConfig.class);
UserService userService = ctx.getBean(UserService.class);
userService.login();
Thread.sleep(1000);
userService.logOut();
}
}