Sping项目AOP通知类型

本是古典何须时尚 2024-04-01 11:57 26阅读 0赞

@Before("ptSelect()")

它所代表的含义是将`通知`添加到`切入点`方法执行的前面。

除了这个注解外，还有没有其他的注解，换个问题就是除了可以在前面加，能不能在其他的地方加?

### 1. 类型介绍 ###

回顾下AOP通知:

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

通知具体要添加到切入点的哪里?

共提供了5种通知类型:

*  前置通知
 *  后置通知
 *  **环绕通知(重点)**
 *  返回后通知(了解)
 *  抛出异常后通知(了解)

为了更好的理解这几种通知类型，我们来看一张图

![在这里插入图片描述][149629413f014334b38c43ee3f1c9f8b.png_pic_center]

(1)前置通知，追加功能到方法执行前,类似于在代码1或者代码2添加内容；

(2)后置通知,追加功能到方法执行后,不管方法执行的过程中有没有抛出异常都会执行，类似于在代码5添加内容；

(3)返回后通知,追加功能到方法执行后，只有方法正常执行结束后才进行,类似于在代码3添加内容，如果方法执行抛出异常，返回后通知将不会被添加；

(4)抛出异常后通知,追加功能到方法抛出异常后，只有方法执行出异常才进行,类似于在代码4添加内容，只有方法抛出异常后才会被添加；

(5)环绕通知,环绕通知功能比较强大，它可以追加功能到方法执行的前后，这也是比较常用的方式，它可以实现其他四种通知类型的功能，具体是如何实现的，下面就可以介绍。

### 2. 环境准备 ###

*  创建一个Maven项目
 *  pom.xml添加Spring依赖
    
        <dependencies>
                <dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-context</artifactId>
                    <version>5.2.15.RELEASE</version>
                </dependency>
                <dependency>
                    <groupId>org.aspectj</groupId>
                    <artifactId>aspectjweaver</artifactId>
                    <version>1.9.6</version>
                </dependency>
            </dependencies>
 *  添加UserDao和UserDaoImpl类
    
        public interface UserDao {
              
            public void select();
            public void update();
        }
        
        @Repository
        public class UserDaoImpl implements UserDao {
              
        
        
            public String  select() {
              
                System.out.println("UserDao select, running .....");
                return "UserDao select";
            }
        
            public String update() {
              
                System.out.println("UserDao update, running ......");
                return "UserDao update";
            }
        }
 *  创建Spring的配置类
    
        @Configuration
        @ComponentScan("com.dcxuexi")
        @EnableAspectJAutoProxy
        public class SpringConfig {
              
        }
 *  创建通知类
    
        @Component
        @Aspect
        public class MyAdvice {
              
            @Pointcut("execution(void com.dcxuexi.dao.UserDao.select())")
            public void ptSelect(){
              }
        
            @Before("ptSelect()")
            public void before(){
              
                System.out.println("MyAdvice before() , running .....");
            }
        
            public void after(){
              
                System.out.println("MyAdvice after() , running .....");
            }
        
            public void around(){
              
                System.out.println("MyAdvice around() , running .....");
            }
        
            public void afterReturning(){
              
                System.out.println("MyAdvice afterReturning() , running .....");
            }
        
            public void afterThowing(){
              
                System.out.println("MyAdvice afterThowing() , running .....");
            }
        
        
        }
 *  编写SpringAopAdviceType运行类
    
        public class SpringAopAdviceType {
              
        
            public static void main(String[] args) {
              
                ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
                UserDao userDao = context.getBean(UserDao.class);
                userDao.select();
            }
        }

最终创建好的项目结构如下:

![在这里插入图片描述][3de791b599614dff90a230df8e66d200.png_pic_center]

### 3. 通知类型的使用 ###

#### 前置通知 ####

修改MyAdvice,在before方法上添加`@Before注解`

![在这里插入图片描述][7625ad4a2cd74a07bd596aa9e5376c78.png_pic_center]

#### 后置通知 ####

![在这里插入图片描述][718d395755674dbfb8756f8cd4c7f0dc.png_pic_center]

#### 环绕通知 ####

##### 基本使用 #####

@Component
    @Aspect
    public class MyAdvice {
        
        @Pointcut("execution(void com.dcxuexi.dao.UserDao.select())")
        public void ptSelect(){
        }
    
        //此处也可以写成 @Before("MyAdvice.ptSelect()"),不建议
        @Before("ptSelect()")
        public void before(){
        
            System.out.println("MyAdvice before() , running .....");
        }
    
        @After("ptSelect()")
        public void after(){
        
            System.out.println("MyAdvice after() , running .....");
        }
    
        @Around("ptSelect()")
        public void around(){
        
            System.out.println("MyAdvice around() , running .....");
        }
    }

![在这里插入图片描述][d829022ce62f4204aa85fc62c1f78e5d.png_pic_center]

运行结果中，通知的内容打印出来，但是原始方法的内容却没有被执行。

因为环绕通知需要在原始方法的前后进行增强，所以环绕通知就必须要能对原始操作进行调用，具体如何实现?

@Component
    @Aspect
    public class MyAdvice {
        
        @Pointcut("execution(void com.dcxuexi.dao.UserDao.select())")
        public void ptSelect(){
        }
    
        //此处也可以写成 @Before("MyAdvice.ptSelect()"),不建议
        @Before("ptSelect()")
        public void before(){
        
            System.out.println("MyAdvice before() , running .....");
        }
    
        @After("ptSelect()")
        public void after(){
        
            System.out.println("MyAdvice after() , running .....");
        }
    
        @Around("ptSelect()")
        public void around(ProceedingJoinPoint proceedingJoinPointp) throws Throwable {
        
            System.out.println("MyAdvice around() , running .....");
            System.out.println("Before ....");
            //表示对原始操作的调用
            proceedingJoinPointp.proceed();
            System.out.println("End ......");
        }
    }

\*\*说明:\*\*proceed()为什么要抛出异常?

原因很简单，看下源码就知道了

![在这里插入图片描述][eee07549d9d3484fab4d7ef9ccd3b3e5.png_pic_center]

再次运行，程序可以看到原始方法已经被执行了

![在这里插入图片描述][9d9f4ae48bf6470d9746262239847b79.png_pic_center]

##### 注意事项 #####

(1)原始方法有返回值的处理

*  修改MyAdvice,对UserDao中的update方法添加环绕通知，

@Component
    @Aspect
    public class MyAdvice {
        
        @Pointcut("execution(void com.dcxuexi.dao.UserDao.select())")
        public void ptSelect(){
        }
    
        @Pointcut("execution(void com.dcxuexi.dao.UserDao.update())")
        public void ptUpdate(){
        }
    
    
        @Around("ptUpdate()")
        public void around(ProceedingJoinPoint proceedingJoinPointp) throws Throwable {
        
            System.out.println("MyAdvice around() , running .....");
            System.out.println("Before ....");
            proceedingJoinPointp.proceed();
            System.out.println("End ......");
        }
    }

*  修改SpringAopAdviceType类，调用select方法

public class SpringAopAdviceType {
        
    
        public static void main(String[] args) {
        
            ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
            UserDao userDao = context.getBean(UserDao.class);
            String result = userDao.select();
            System.out.println(result);
        }
    }

运行后会报错，错误内容为:

![在这里插入图片描述][614afeea7a5a45a6b021ef3da3601eb8.png_pic_center]

`Exception in thread "main" org.springframework.aop.AopInvocationException: Null return value from advice does not match primitive return type for: public abstract int com.dcxuexi.dao.UserDao.update() at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:226) at com.sun.proxy.$Proxy19.update(Unknown Source) at com.dcxuexi.SpringAopAdviceType.main(SpringAopAdviceType.java:22)`

错误大概的意思是:`空的返回不匹配原始方法的int返回`

*  void就是返回Null
 *  原始方法就是UserDao下的update方法

所以如果我们使用环绕通知的话，要根据原始方法的返回值来设置环绕通知的返回值，具体解决方案为:

**说明:**

为什么返回的是Object而不是int的主要原因是Object类型更通用。

在环绕通知中是可以对原始方法返回值就行修改的。

#### 返回后通知 ####

![在这里插入图片描述][6b65c880d4a54a36852429c85b5a430f.png_pic_center]

\*\*注意：\*\*返回后通知是需要在原始方法`select`正常执行后才会被执行，如果`select()`方法执行的过程中出现了异常，那么返回后通知是不会被执行。后置通知是不管原始方法有没有抛出异常都会被执行。

#### 异常后通知 ####

![在这里插入图片描述][efc5ff1b44b344adb761623f4f35a78e.png_pic_center]

\*\*注意：\*\*异常后通知是需要原始方法抛出异常，可以在`update()`方法中添加一行代码`int i = 10/0`即可。如果没有抛异常，异常后通知将不会被执行。

介绍完完这5种通知类型，我们来思考下环绕通知是如何实现其他通知类型的功能的?

因为环绕通知是可以控制原始方法执行的，所以我们把增强的代码写在调用原始方法的不同位置就可以实现不同的通知类型的功能，如:

@Component
    @Aspect
    public class MyAdvice {
        
        @Pointcut("execution(void com.dcxuexi.dao.UserDao.select())")
        public void ptSelect(){
        }
    
        @Pointcut("execution(int com.dcxuexi.dao.UserDao.update())")
        public void ptUpdate(){
        }
        
        @Around("ptUpdate()")
        public Object around(ProceedingJoinPoint proceedingJoinPointp)  {
        
             // 代码1   ## 增强代码写在代码1位置就是前置通知 ，效果如 @Before("ptUpdate()")
             Object proceed = null;
             try {
        
                 // 代码2   ## 增强代码写在代码2位置就是前置通知 ，效果如 @Before("ptUpdate()")
    
                 //表示对原始操作的调用
                 proceed = proceedingJoinPointp.proceed();
    
                 // 代码3   ## 增强代码写在代码3位置就是返回后通知 ，效果如@AfterReturning("ptUpdate()")
    
             } catch (Throwable throwable) {
        
                 // 代码4   ## 增强代码写在代码4位置就是异常后通知 ，效果如 @AfterThrowing("ptUpdate()")
             }
             // 代码5   ## 增强代码写在代码5位置就是后置通知 ，效果如 @After("ptUpdate()")
             return proceed;
        }
    }

![在这里插入图片描述][8913c48d3453471fbf6239320b405aab.png_pic_center]

### 通知类型总结 ###

#### 知识点1：@After ####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@After</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>通知方法定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法后运行</td> 
  </tr> 
 </tbody> 
</table>

#### 知识点2：@AfterReturning ####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@AfterReturning</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>通知方法定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前通知方法与切入点之间绑定关系，当前通知方法在原始切入点方法正常执行完毕后执行</td> 
  </tr> 
 </tbody> 
</table>

#### 知识点3：@AfterThrowing ####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@AfterThrowing</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>通知方法定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前通知方法与切入点之间绑定关系，当前通知方法在原始切入点方法运行抛出异常后执行</td> 
  </tr> 
 </tbody> 
</table>

#### 知识点4：@Around ####

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@Around</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>方法注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>通知方法定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法前后运行</td> 
  </tr> 
 </tbody> 
</table>

#### 环绕通知注意事项 ####

1.  环绕通知必须依赖形参ProceedingJoinPoint才能实现对原始方法的调用，进而实现原始方法调用前后同时添加通知
2.  通知中如果未使用ProceedingJoinPoint对原始方法进行调用将跳过原始方法的执行
3.  对原始方法的调用可以不接收返回值，通知方法设置成void即可，如果接收返回值，最好设定为Object类型
4.  原始方法的返回值如果是void类型，通知方法的返回值类型可以设置成void,也可以设置成Object
5.  由于无法预知原始方法运行后是否会抛出异常，因此环绕通知方法必须要处理Throwable异常

### 项目代码 ###

*  [gitee 代码下载][gitee]
 *  [github 代码代码][github]

[149629413f014334b38c43ee3f1c9f8b.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/38d15e84f07f43ad8b8840bd03ae364d.png
[3de791b599614dff90a230df8e66d200.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/53d7768f9de443678b2dedb578b17327.png
[7625ad4a2cd74a07bd596aa9e5376c78.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/dbe196a6786b4fb3a079fbdd673b99ad.png
[718d395755674dbfb8756f8cd4c7f0dc.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/c87388987ebe435a9d3029910b6f1262.png
[d829022ce62f4204aa85fc62c1f78e5d.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/732ebfa958cd4416b6135d5085fc6201.png
[eee07549d9d3484fab4d7ef9ccd3b3e5.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/8de795ae5e1145aab5623050eab54502.png
[9d9f4ae48bf6470d9746262239847b79.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/1665f3b1591646a485ca27a2ea2c1833.png
[614afeea7a5a45a6b021ef3da3601eb8.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/813db34a142d4e3da0a96d6b41a50a11.png
[6b65c880d4a54a36852429c85b5a430f.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/c84c4d5bba824953be53fe9d7af8e382.png
[efc5ff1b44b344adb761623f4f35a78e.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/eca17c598d214efd9dabd367aabb23d8.png
[8913c48d3453471fbf6239320b405aab.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6e44f29bba9342c4b48311b5790c25d9.png
[gitee]: https://gitee.com/DchuangDB/sping-projeck
[github]: https://github.com/dcbut/spring