Spring AOP_02

53 阅读8分钟

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第21天,点击查看活动详情


⭐️前面的话⭐️

✉️坚持和努力一定能换来诗与远方!
💭推荐书籍:📚《王道408》,📚《深入理解 Java 虚拟机-周志明》,📚《Java 核心技术卷》
💬算法刷题:✅力扣🌐牛客网
🎈Github
🎈码云Gitee


17 AOP入门案例

需求分析

 # 案例设定:测算接口执行效率,但是这个案例稍微复杂了点,我们对其进行简化。
 # 简化设定:在方法执行前输出当前系统时间。
 ​
 对于SpringAOP的开发有两种方式,XML 和 注解,我们使用哪个呢?
 因为现在注解使用的比较多,所以本次课程就采用注解完成AOP的开发。
 ​
 # 总结需求为:使用SpringAOP的注解方式完成在方法执行前打印出当前系统时间。

思路分析

 1.导入坐标(pom.xml)
 2.制作连接点(原始操作,Dao接口与实现类)
 3.制作共性功能(通知类与通知)
 4.定义切入点
 5.绑定切入点与通知关系(切面)
 ​
 6.将通知类配给容器并标识其为切面类
 7.开启注解格式AOP功能

环境准备和AOP实现

  • 依赖

    • 因为 spring-context 中已经导入了 spring-aop ,所以不需要再单独导入spring-aop。

    • 直接采用Spring整合ApsectJ的方式进行AOP开发。

      • 导入AspectJ的jar包,AspectJ 是 AOP 思想的一个具体实现,Spring有自己的AOP实现,但是相比于AspectJ来说比较麻烦。
 <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-context</artifactId>
     <version>5.2.10.RELEASE</version>
 </dependency>
 <dependency>
     <groupId>org.aspectj</groupId>
     <artifactId>aspectjweaver</artifactId>
     <version>1.9.4</version>
 </dependency>
  • 通知类与通知
 public class MyAdvice {
     public void method(){
         System.out.println(System.currentTimeMillis());
     }
 }
  • 切入点
 // 【核心概念2,切入点Pointcut(哪些方法要追加功能)(匹配连接点的式子)】
 // 设置切入点,要求配置在方法上方
 @Pointcut("execution(void com.itheima.dao.BookDao.update())")
 private void pt(){}
  • 将通知类配给容器并标识其为切面类

    • @Component
    • @Aspect
 // 通知类必须配置成Spring管理的bean
 @Component
 // 设置当前类为切面类
 @Aspect
 ​
 //【核心概念4,通知类(通知方法所在的类)】
 public class MyAdvice {
     //【核心概念2,切入点Pointcut(哪些方法要追加功能)(匹配连接点的式子)】
     //设置切入点,要求配置在方法上方
     @Pointcut("execution(void com.itheima.dao.BookDao.update())")
     private void pt(){}
 ​
     //【核心概念5,切面Aspect(通知和切入点之间的关系描述)】
     //设置在切入点pt()的前面运行当前操作(前置通知)
     // @Before("pt()")
 ​
     //【核心概念3,通知Advice(存放共性功能的方法)】
     public void method(){
         System.out.println(System.currentTimeMillis());
     }
 }
  • 开启注解格式AOP功能:@EnableAspectJAutoProxy
 @Configuration
 @ComponentScan("com.itheima")
 //开启注解开发AOP功能
 @EnableAspectJAutoProxy
 public class SpringConfig {
 }

AOP工作流程

由于AOP是基于Spring容器管理的bean做的增强,所以整个工作过程需要从Spring加载bean说起:

 # 流程1:Spring容器启动
 容器启动就需要去加载bean,哪些类需要被加载呢?
 需要被增强的类,如:BookServiceImpl
 通知类,如:MyAdvice
 注意此时bean对象还没有创建成功
 ​
 # 流程2:读取所有切面配置中的切入点
 上面这个例子中有两个切入点的配置,但是第一个ptx()并没有被使用,所以不会被读取。
 ​
 # 流程3:初始化bean,判定bean对应的类中的方法是否匹配到任意切入点
 - 注意第1步在容器启动的时候,bean对象还没有被创建成功。
 - 要被实例化bean对象的类中的方法和切入点进行匹配
   - 匹配失败,创建原始对象,如UserDao
     - 匹配失败说明不需要增强,直接调用原始对象的方法即可。
   - 匹配成功,创建原始对象(目标对象)的代理对象,如: BookDao
     - 匹配成功说明需要对其进行增强
     - 对哪个类做增强,这个类对应的对象就叫做目标对象
     - 因为要对目标对象进行功能增强,而采用的技术是动态代理,所以会为其创建一个代理对象
     - 最终运行的是代理对象的方法,在该方法中会对原始方法进行功能增强
 ​
 # 流程4:获取bean执行方法
 获取的bean是原始对象时,调用方法并执行,完成操作
 获取的bean是代理对象时,根据代理对象的运行模式运行原始方法与增强的内容,完成操作
 ​
 # 验证容器中是否为代理对象
 为了验证IOC容器中创建的对象和我们刚才所说的结论是否一致,首先先把结论理出来:
 ​
 如果目标对象中的方法会被增强,那么容器中将存入的是目标对象的代理对象
 如果目标对象中的方法不被增强,那么容器中将存入的是目标对象本身。

通过这一节中,我们需要掌握的内容有:

 能说出AOP的工作流程
 AOP的核心概念
 - 目标对象、连接点、切入点
 - 通知类、通知
 - 切面
 - 代理
 SpringAOP的本质或者可以说底层实现是通过代理模式。

AOP配置管理

AOP 切入点表达式

  • 语法格式

切入点:要进行增强的方法

切入点表达式:要进行增强的方法的描述

切入点表达式就是要找到需要增强的方法,所以它就是对一个具体方法的描述,但是方法的定义会有很多,所以如果每一个方法对应一个切入点表达式,很麻烦。

 execution(public User com.itheima.service.UserService.findById(int))
  • 通配符(切入点描述简化)
 // * 单个独立的任意符号,可以独立出现,也可以作为前缀或者后缀的匹配符出现
 execution(public * com.itheima.*.UserService.find*(*))
 匹配com.itheima包下的任意包中的UserService类或接口中所有find开头的带有一个参数的方法
 ​
 // .. 多个连续的任意符号,可以独立出现,常用于简化包名与参数的书写
 execution(public User com..UserService.findById(..))
 ​
 // 符合我们平常切入点表达式的编写规则  
 execution(* com.itheima.*.*Service.find*(..)) 
 将项目中所有业务层方法的以find开头的方法匹配 
 execution(* com.itheima.*.*Service.save*(..)) 
 将项目中所有业务层方法的以save开头的方法匹配  
  • 书写技巧✍🏻
 所有代码按照标准规范开发,否则以下技巧全部失效
 描述切入点通 【常描述接口】,而不描述实现类,如果描述到实现类,就出现紧耦合了
 访问控制修饰符针对接口开发均采用public描述(【可省略访问控制修饰符描述】)
 返回值类型对于增删改类使用精准类型加速匹配,对于查询类使用*通配快速描述
 ​
 包名书写【尽量不使用..匹配】,效率过低,常用*做单个包描述匹配,或精准匹配
 接口名/类名书写名称与模块相关的【采用*匹配】,例如UserService书写成*Service,绑定业务层接口名
 方法名书写【以动词进行精准匹配】,名词采用匹配,例如getById书写成getBy,selectAll书写成selectAll
 参数规则较为复杂,根据业务方法灵活调整
 通常不使用异常作为匹配规则

AOP通知类型

AOP通知描述了抽取的共性功能,根据共性功能抽取的位置不同,最终运行代码时要将其加入到合理的位置。

通知具体要添加到切入点的哪里?共提供了5种通知类型:

  • 前置通知:追加功能到方法执行前

  • 后置通知:追加功能到方法执行后,不管方法执行的过程中有没有抛出异常都会执行。

  • 环绕通知 [ 重点 ]:环绕通知功能比较强大,它可以追加功能到方法执行的前后,这也是比较常用的方式。

    • 它可以实现其他四种通知类型的功能
  • 返回后通知(了解):追加功能到方法执行后,只有方法正常执行结束后才进行。

  • 抛出异常后通知(了解):只有方法执行出异常才进行。

 @Component
 @Aspect
 public class MyAdvice {
     @Pointcut("execution(void com.itheima.dao.BookDao.update())")
     private void pt(){}
     @Pointcut("execution(int com.itheima.dao.BookDao.select())")
     private void pt2(){}
 ​
     // @Before:前置通知,在原始方法运行之前执行
   // @Before("pt()")
     public void before() {
         System.out.println("before advice ...");
     }
 ​
     // @After:后置通知,在原始方法运行之后执行
   // @After("pt2()")
     public void after() {
         System.out.println("after advice ...");
     }
 ​
     // @Around:环绕通知,在原始方法运行的前后执行
     // @Around("pt()")
     public Object around(ProceedingJoinPoint pjp) throws Throwable {
         System.out.println("around before advice ...");
         //表示对原始操作的调用
         Object ret = pjp.proceed();
         System.out.println("around after advice ...");
         return ret;
     }
 ​
     @Around("pt2()")
     public Object aroundSelect(ProceedingJoinPoint pjp) throws Throwable {
         System.out.println("around before advice ...");
         //表示对原始操作的调用
         Integer ret = (Integer) pjp.proceed();
         System.out.println("around after advice ...");
         return ret;
     }
 ​
     // @AfterReturning:返回后通知,在原始方法执行完毕后运行,且原始方法执行过程中未出现异常现象
   // @AfterReturning("pt2()")
     public void afterReturning() {
         System.out.println("afterReturning advice ...");
     }
 ​
     // @AfterThrowing:抛出异常后通知,在原始方法执行过程中出现异常后运行
     // @AfterThrowing("pt2()")
     public void afterThrowing() {
         System.out.println("afterThrowing advice ...");
     }
 }
  • 环绕通知(重点、注意事项)

    • 必须依赖形参 ProceedingJoinPoint 才能实现对原始方法的调用,进而实现原始方法调用前后同时添加通知
    • 通知中如果未使用 ProceedingJoinPoint 对原始方法进行调用将跳过原始方法的执行
    • 对原始方法的调用可以不接收返回值,通知方法设置成 void 即可,如果接收返回值,最好设定为 Object类型
    • 原始方法的返回值如果是void类型,通知方法的返回值类型可以设置成 void,也可以设置成 Object
    • 由于无法预知原始方法运行后是否会抛出异常,因此环绕通知方法必须要处理 Throwable异常
     //@Around:环绕通知,在原始方法运行的前后执行
     //@Around("pt()")
     public Object around(ProceedingJoinPoint pjp) throws Throwable {
         System.out.println("around before advice ...");
         //表示对原始操作的调用
         Object ret = pjp.proceed();
         System.out.println("around after advice ...");
         return ret;
     }

AOP总结

 # AOP的核心概念
 ​
 # 切入点表达式
 ​
 # 五种通知类型
 ​
 # 通知中获取参数