AspectJ是一个面向切面的框架,它扩展了Java语言。AspectJ定义了AOP语法,所以它有一个专门的编译器用来生成遵守Java字节编码规范的Class文件。
SpringBoot中AOP的使用方式主要有两种:注解式拦截与方法规则拦截,具体使用如下文所示。
一、创建一个简单springboot 2.03项目,添加aop依赖
org.springframework.boot
spring-boot-starter-aop
此依赖已包含AspectJ相关依赖包。
二、编写拦截规则的注解
packagecom.cenobitor.aop.annotation;import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documentedpublic @interfaceAction {
String name();
}
注解说明:元注解是指注解的注解,包括@Retention @Target @Document @Inherited四种。
1.@Retention: 定义注解的保留策略
@Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中,在class字节码文件中不包含
@Retention(RetentionPolicy.CLASS) // 默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得,
@Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中存在,在运行时可以通过反射获取到
首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ,所以前者能作用的地方后者一定也能作用。一般如果需要在运行时去动态获取注解信息,那只能用 RUNTIME 注解;如果要在编译时进行一些预处理操作,比如生成一些辅助代码(如 ButterKnife),就用 CLASS注解;如果只是做一些检查性的操作,比如 @Override 和 @SuppressWarnings,则可选用 SOURCE 注解。
2.@Target:定义注解的作用目标 源码为:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)public @interfaceTarget {
ElementType[] value();
}
@Target(ElementType.TYPE) //接口、类、枚举、注解
@Target(ElementType.FIELD) //字段、枚举的常量
@Target(ElementType.METHOD) //方法
@Target(ElementType.PARAMETER) //方法参数
@Target(ElementType.CONSTRUCTOR) //构造函数
@Target(ElementType.LOCAL_VARIABLE)//局部变量
@Target(ElementType.ANNOTATION_TYPE)//注解
@Target(ElementType.PACKAGE) ///包
3.@Document:说明该注解将被包含在javadoc中4.@Inherited:说明子类可以继承父类中的该注解
三、编写使用注解的被拦截类
packagecom.cenobitor.aop.service;importcom.cenobitor.aop.annotation.Action;importorg.springframework.stereotype.Service;
@Servicepublic classDemoAnnotationService {
@Action(name= "注解式拦截的add操作")public voidadd(){}
}
四、编写使用方法规则被拦截类
packagecom.cenobitor.aop.service;importorg.springframework.stereotype.Service;
@Servicepublic classDemoMethodService {public voidadd(){}
}
五、编写切面
packagecom.cenobitor.aop.aspect;importcom.cenobitor.aop.annotation.Action;importorg.aspectj.lang.JoinPoint;importorg.aspectj.lang.annotation.After;importorg.aspectj.lang.annotation.Aspect;importorg.aspectj.lang.annotation.Before;importorg.aspectj.lang.annotation.Pointcut;importorg.aspectj.lang.reflect.MethodSignature;importorg.springframework.stereotype.Component;importjava.lang.reflect.Method;
@Aspect
@Componentpublic classLogAspect {
@Pointcut("@annotation(com.cenobitor.aop.annotation.Action)")public voidannotationPoinCut(){}
@After("annotationPoinCut()")public voidafter(JoinPoint joinPoint){
MethodSignature signature=(MethodSignature) joinPoint.getSignature();
Method method=signature.getMethod();
Action action= method.getAnnotation(Action.class);
System.out.println("注解式拦截 "+action.name());
}
@Before("execution(* com.cenobitor.aop.service.DemoMethodService.*(..))")public voidbefore(JoinPoint joinPoint){
MethodSignature signature=(MethodSignature) joinPoint.getSignature();
Method method=signature.getMethod();
System.out.println("方法规则式拦截,"+method.getName());
}
}
AOP注解说明:
@Aspect定义切面:切面由切点和增强(引介)组成(可以包含多个切点和多个增强),它既包括了横切逻辑的定义,也包括了连接点的定义,SpringAOP就是负责实施切面的框架,它将切面所定义的横切逻辑织入到切面所指定的链接点中。
@Pointcut定义切点:切点是一组连接点的集合。AOP通过“切点”定位特定的连接点。通过数据库查询的概念来理解切点和连接点的关系再适合不过了:连接点相当于数据库中的记录,而切点相当于查询条件。
@Before:在目标方法被调用之前做增强处理,@Before只需要指定切入点表达式即可。
@AfterReturning : 在目标方法正常完成后做增强,@AfterReturning除了指定切入点表达式后,还可以指定一个返回值形参名returning,代表目标方法的返回值。
@Afterthrowing: 主要用来处理程序中未处理的异常,@AfterThrowing除了指定切入点表达式后,还可以指定一个throwing的返回值形参名,可以通过该形参名来访问目标方法中所抛出的异常对象。
@After:在目标方法完成之后做增强,无论目标方法时候成功完成。@After可以指定一个切入点表达式。
@Around:环绕通知,在目标方法完成前后做增强处理,环绕通知是最重要的通知类型,像事务,日志等都是环绕通知,注意编程中核心是一个ProceedingJoinPoint。
六、运行
public classmain {public static voidmain(String[] args) {
AnnotationConfigApplicationContext context= new AnnotationConfigApplicationContext(AopApplication.class);
DemoAnnotationService demoAnnotationService= context.getBean(DemoAnnotationService.class);
DemoMethodService demoMethodService= context.getBean(DemoMethodService.class);
demoAnnotationService.add();
demoMethodService.add();
}
}
AopApplication.class为本项目的启动类。
运行结果如下:
注解式拦截 注解式拦截的add操作
方法规则式拦截,add
注:摘抄自《JavaEE开发的颠覆者SpringBoot 实战》,根据springboot 2.0.3做些许修改,省略一些配置项。