1.AOP是什么？

1.是一种编程范式，不是编程语言
2.解决特定问题，不能解决所有问题
3.是OOP(Object Oriented Programming)的补充，不是替代

五个注解：

  • 前置通知（Before）：在目标方法被调用之前调用通知功能；
  • 后置通知（After）：在目标方法完成之后调用通知，此时不会关心方法的输出是什么；
  • 返回通知（After-returning）：在目标方法成功执行之后调用通知；
  • 异常通知（After-throwing）：在目标方法抛出异常后调用通知；
  • 环绕通知（Around）：通知包裹了被通知的方法，在被通知的方法调用之前和调用之后执行自定义的行为。

2.Aop使用前后对比

2.1 使用Aop前

所需要的依赖

  1. <dependency>
  2.   <groupId>org.springframework.boot</groupId>
  3.   <artifactId>spring-boot-starter-aop</artifactId>
  4. </dependency>

先看一下代码结构
image.png

  1. @Data
  2. public class Product {
  4.     private Long id;
  6.     private String name;
  8. }
  1. public class CurrentUserHolder {
  2.     private static final ThreadLocal<String> holder = new ThreadLocal<>();
  4.     public static String get() {
  5.         return holder.get() == null ? "unknown" : holder.get();
  6.     }
  8.     public static void set(String user) {
  9.         holder.set(user);
  10.     }
  11. }
  1. @Component
  2. public class AuthService {
  3.     public void checkAccess() {
  4.         String user = CurrentUserHolder.get();
  5.         if (!"admin".equals(user)) {
  6.             throw new RuntimeException("operation not allow");
  7.         }
  8.     }
  9. }

现在的需求是这两个方法都需要经过校验，身份是admin才能执行，这种写法相当于硬编码，假设我300个方法都需要校验的情况，那我需要一条条的添加到方法中去。

  1. @Service
  2. @Slf4j
  3. public class ProductService {
  4.     @Autowired
  5.     AuthService authService;
  7.     public void insert(Product product) {
  8.         authService.checkAccess();
  9.         log.info("insert product");
  10.     }
  12.     public void delete(Long id) {
  13.         authService.checkAccess();
  14.         log.info("delete product");
  15.     }
  16. }

执行测试看一下结果：

  1. @SpringBootTest
  2. class AopApplicationTests {
  3.     @Autowired
  4.     ProductService productService;
  6.     @Test
  7.     void contextLoads() {
  8.     }
  10.     @Test
  11.     public void anoInsertTest() {
  12.         CurrentUserHolder.set("tom");
  13.         productService.delete(1L);
  14.     }
  16.     @Test
  17.     public void adminInsert() {
  18.         CurrentUserHolder.set("admin");
  19.         productService.delete(1L);
  20.     }
  21. }

2.2使用Aop后

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.METHOD)
  3. public @interface AdminOnly {
  4. }
  1. @Aspect
  2. @Component
  3. public class SecurityAspect {
  4.     @Autowired
  5.     AuthService authService;
  7.     // 拦截标注AdminOnly的方法
  8.     @Pointcut("@annotation(AdminOnly)")
  9.     public void adminOnly(){
  11.     }
  13.     // 在执行前插入这行代码
  14.     @Before("adminOnly()")
  15.     public void check(){
  16.         authService.checkAccess();
  17.     }
  18. }

去掉这种硬编码的方式加上注解。

  1. @Service
  2. @Slf4j
  3. public class ProductService {
  5.     @AdminOnly
  6.     public void insert(Product product) {
  7.         log.info("insert product");
  8.     }
  10.     @AdminOnly
  11.     public void delete(Long id) {
  12.         log.info("delete product");
  13.     }
  14. }

总结：执行后的结果是一致的，很显然使用aop幸福感更高

3.切面表达式

image.png

  1. 任意公共方法的执行：
  2. execution(public * *(..))
  3. 任何一个以“set”开始的方法的执行：
  4. execution(* set*(..))
  5. AccountService 接口的任意方法的执行：
  6. execution(* com.xyz.service.AccountService.*(..))
  7. 定义在service包里的任意方法的执行：
  8. execution(* com.xyz.service.*.*(..))
  9. 定义在service包和所有子包里的任意类的任意方法的执行：
  10. execution(* com.xyz.service..*.*(..))
  11. 定义在pointcutexp包和所有子包里的JoinPointObjP2类的任意方法的执行：
  12. execution(* com.test.spring.aop.pointcutexp..JoinPointObjP2.*(..))")
  13. ***> 最靠近(..)的为方法名,靠近.*(..))的为类名或者接口名,如上例的JoinPointObjP2.*(..))
  15. pointcutexp包里的任意类.
  16. within(com.test.spring.aop.pointcutexp.*)
  17. pointcutexp包和所有子包里的任意类.
  18. within(com.test.spring.aop.pointcutexp..*)
  19. 实现了MyInterface接口的所有类,如果MyInterface不是接口,限定MyInterface单个类.
  20. this(com.test.spring.aop.pointcutexp.MyInterface)
  21. ***> 当一个实现了接口的类被AOP的时候,用getBean方法必须cast为接口类型,不能为该类的类型.
  23. 带有@MyTypeAnnotation标注的所有类的任意方法.
  24. @within(com.elong.annotation.MyTypeAnnotation)
  25. @target(com.elong.annotation.MyTypeAnnotation)
  26. 带有@MyTypeAnnotation标注的任意方法.
  27. @annotation(com.elong.annotation.MyTypeAnnotation)
  28. ***> @within和@target针对类的注解,@annotation是针对方法的注解
  30. 参数带有@MyMethodAnnotation标注的方法.
  31. @args(com.elong.annotation.MyMethodAnnotation)
  32. 参数为String类型(运行是决定)的方法.
  33. args(String)

3.1within表达式

  1. @Component
  2. @Aspect
  3. @Slf4j
  4. public class PkgTypeAspectConfig {
  5.     // 匹配类
  6. //    @Pointcut("within(com.example.aop.service.AuthService)")
  7. //    匹配包名下所有的类
  8.     @Pointcut("within(com.example.aop.service.*)")
  9.     public void matchType() {
  10.     }
  12.     @Before("matchType()")
  13.     public void before() {
  14.         log.info("PkgTypeAspectConfig");
  15.     }
  16. }

3.2对象匹配

this匹配实现接口下的所有类

  1. public interface Work {
  2.     void working();
  3. }
  1. @Service
  2. public class MondayWorkServiceImpl implements Work {
  3.     @Override
  4.     public void working() {
  6.     }
  7. }
  1. @Component
  2. @Aspect
  3. @Slf4j
  4. public class ObjectiveAspectConfig {
  6.     // 匹配Work接口下的所有类
  7.     @Pointcut("this(com.example.aop.service.Work)")
  8.     public void matchCondition() {
  9.     }
  11.     @Before("matchCondition()")
  12.     public void before() {
  13.         log.info("matchCondition");
  14.     }
  15. }

在没有引入Introduction的情况下this和target结果是一样的

  1. @Component
  2. @Aspect
  3. @Slf4j
  4. public class ObjectiveAspectConfig {
  6.     // 匹配Work接口下的所有类
  7.     @Pointcut("target(com.example.aop.service.Work)")
  8.     public void matchCondition() {}
  10.     @Before("matchCondition()")
  11.     public void before() {
  12.         log.info("matchCondition");
  13.     }
  14. }

匹配bean注意类名开头小写，我学习过程中因为没有小写导致排查了一小时

  1. @Component
  2. @Aspect
  3. @Slf4j
  4. public class ObjectiveAspectConfig {
  6.     // bean名称
  7.     @Pointcut("bean(mondayWorkServiceImpl))")
  8.     public void matchCondition() {}
  10.     @Before("matchCondition()")
  11.     public void before() {
  12.         log.info("matchCondition");
  13.     }
  14. }

3.3参数匹配

  1. @Aspect
  2. @Component
  3. public class ArgsAspectConfig {
  4.     // @Pointcut("args(Long,String) && within(com.example.aop.service.*)") 匹配Long,String
  5.     // @Pointcut("args(Long,..) && within(com.example.aop.service.*)") 匹配Long,和任意类型
  6.     // @Pointcut("args(..) && within(com.example.aop.service.*)") 匹配任意类型
  7.     // 匹配long类型
  8.     @Pointcut("args(*) && within(com.example.aop.service.*)")
  9.     public void matchArgs() {
  10.     }
  12.     @Before("matchArgs()")
  13.     public void before() {
  14.         System.out.println("###before");
  15.     }
  16. }

3.4注解方式匹配

  1. @Component
  2. @Aspect
  3. @Slf4j
  4. public class AnoAspectConfig {
  6.     @Pointcut("@annotation(com.example.aop.security.AdminOnly)")
  7.     public void matchAno(){}
  9.     @Before("matchAno()")
  10.     public void before(){
  11.         System.out.println("AnoAspectConfig");
  12.     }
  13. }
  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.METHOD)
  3. public @interface AdminOnly {
  4. }

添加注解到方法上即可实现拦截

  1. @AdminOnly
  2.     public void delete(Long id) {
  3.         log.info("delete product");
  4.     }

可被继承的注解

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.TYPE)
  3. @Inherited //支持继承
  4. public @interface NeedSecured {
  5. }

父类

  1. @Service
  2. @Slf4j
  3. @NeedSecured
  4. public class ProductService {
  6.     @AdminOnly
  7.     public void insert(Product product) {
  8.         log.info("insert product");
  9.     }
  11.     @AdminOnly
  12.     public void delete(Long id) {
  13.         log.info("delete product");
  14.     }
  16.     public void withinTest(){
  17.         log.info("withinTest");
  18.     }
  19. }

子类继承父类NeedSecured注解也被继承，所以都会匹配成功

  1. @Component
  2. public class SubProductService extends ProductService {
  4.     public void demo() {
  5.         System.out.println("SubProductService");
  6.     }
  7. }

在spring context的环境下,二者没有区别target和within

  1. @Component
  2. @Aspect
  3. @Slf4j
  4. public class AnoAspectConfig {
  6.     @Pointcut("@target(com.example.aop.security.NeedSecured)")
  7.     public void matchAno(){}
  9.     @Before("matchAno()")
  10.     public void before(){
  11.         System.out.println("AnoAspectConfig");
  12.     }
  13. }

在类上面添加NeedSecured注解调用改类就会被匹配

  1. @NeedSecured
  2. public class Product {
  3. }
  1. @Component
  2. @Aspect
  3. @Slf4j
  4. public class AnoAspectConfig {
  6.     @Pointcut("@args(com.example.aop.security.NeedSecured)")
  7.     public void matchAno(){}
  9.     @Before("matchAno()")
  10.     public void before(){
  11.         System.out.println("AnoAspectConfig");
  12.     }
  13. }

3.5 execution匹配（重点掌握）

  1. @Aspect
  2. @Component
  3. public class ExecutionAspectConfig {
  4.     // @Pointcut("execution(public String com.imooc.service..*(..))") 匹配service包含子包且只匹配无返回值
  5.     // @Pointcut("execution(public String com.imooc.service..*(..))") 匹配service包含子包且只匹配String的返回值
  6.     // @Pointcut("execution(public * com.imooc.service..*(..))") 匹配service包含子包任意返回值
  7.     // @Pointcut("execution(public * com.imooc.service..*())") 匹配service包含子包无参数
  8.     // @Pointcut("execution(public * com.imooc.service..*(Long))") 匹配service包含子包且拦截参数的Long类型
  9.     // @Pointcut("execution(public * com.imooc.service.*(..) throws java.lang.IllegalAccessException)") 只匹配抛出IllegalAccessException的类
  10.     // 匹配service下的包不包含子包
  11.     @Pointcut("execution(public * com.imooc.service.*(..))")
  12.     public void matchCondition() {
  13.     }
  15.     @Before("matchCondition()")
  16.     public void before() {
  17.         System.out.println("");
  18.         System.out.println("###before");
  19.     }
  20. }

还能这样写匹配Note开头的所有类除NoteWeiXinCodeController

  1. @Pointcut("execution(public * com.jideos.jnotes.controller.Note*.*(..))" +
  2.             "&& !execution(public * com.jideos.jnotes.controller.NoteWeiXinCodeController*.*(..))")
  3.     public void verify() {
  4.     }

3.6 advice注解

Around注解可以用来在调用一个具体方法前和调用后来完成一些具体的任务，如下就用获取方法执行时间

  1. @Aspect
  2. @Component
  3. @Slf4j
  4. public class TimeInterceptor {
  6.     // 一分钟，即60000ms
  7.     private static final long ONE_MINUTE = 60000;
  9.     // service层的统计耗时切面，类型必须为final String类型的,注解里要使用的变量只能是静态常量类型的
  10.     public static final String POINT = "execution (* com.example.aop.*.*(..))";
  12.     // 统计方法执行耗时Around环绕通知
  13.     @Around(POINT)
  14.     public Object timeAround(ProceedingJoinPoint joinPoint) {
  15.         // 定义返回对象、得到方法需要的参数
  16.         Object obj = null;
  17.         Object[] args = joinPoint.getArgs();
  18.         long startTime = System.currentTimeMillis();
  20.         try {
  21.             obj = joinPoint.proceed(args);
  22.         } catch (Throwable e) {
  23.             log.error("统计某方法执行耗时环绕通知出错", e);
  24.         }
  26.         // 获取执行的方法名
  27.         long endTime = System.currentTimeMillis();
  28.         MethodSignature signature = (MethodSignature) joinPoint.getSignature();
  29.         String methodName = signature.getDeclaringTypeName() + "." + signature.getName();
  31.         // 打印耗时的信息
  32.         this.printExecTime(methodName, startTime, endTime);
  34.         return obj;
  35.     }
  37.     // 打印方法执行耗时的信息，如果超过了一定的时间，才打印
  38.     private void printExecTime(String methodName, long startTime, long endTime) {
  39.         long diffTime = endTime - startTime;
  40.         if (diffTime > ONE_MINUTE) {
  41.             log.warn("-----" + methodName + " 方法执行耗时：" + diffTime + " ms");
  42.         }
  43.     }
  44. }