Spring中基于注解的AOP配置

清疚 2022-02-20 15:49 291阅读 0赞

*  一、环境搭建
 *  二、基于注解的AOP配置通知类的两种方式
    
     *  2.1 在增强的方法上使用注解配置通知【不推荐】
        
         *  @Before
         *  @AfterReturning
         *  @AfterThrowing
         *  @After
         *  @Pointcut
     *  2.2 环绕通知注解配置【推荐】
        
         *  @Around

# 一、环境搭建 #

#### 第一步 ####

创建Maven工程，在 `pom.xml`中导入所需 Spring 的jar包坐标：  
`spring-context`Spring 的 jar 包  
`aspectjweaver`解析切入点表达式

<dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.0.2.RELEASE</version>
        </dependency>
        
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.7</version>
        </dependency>
    </dependencies>

#### 第二步 ####

把资源使用注解配置

@Service("accountService")
    public class AccountServiceImpl implements AccountService { 
        @Override
        public void saveAccount() { 
            System.out.println("执行了保存");
    // int i = 1/0;
        }
    
        @Override
        public void updateAccount(int id)    { 
            System.out.println("执行了更新");
        }
    
        @Override
        public int deleteAccount() { 
            System.out.println("执行了删除");
            return 0;
        }
    }

#### 第三步 ####

创建通知类  
① 注解 `@Component`配置通知类，通过 Spring 框架创建该对象  
② 注解 `@Aspect`配置通知类，表明该类是一个**切面类**

#### 第四步 ####

创建 Spring 配置文件 `bean.xml`，在配置文件中导入 context 的名称空间。在名称空间中指定 Spring 要扫描的包、配置 Spring 开启注解 AOP 的支持

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
    
        
        <context:component-scan base-package="com.hxh"></context:component-scan>
    
        
        <aop:aspectj-autoproxy></aop:aspectj-autoproxy>
    </beans>

# 二、基于注解的AOP配置通知类的两种方式 #

### 2.1 在增强的方法上使用注解配置通知【不推荐】 ###

##### 在增强的方法上使用注解配置通知 #####

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>作用</th> 
   <th>属性</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Before</td> 
   <td>把当前方法看成是前置通知</td> 
   <td>value:用于指定切入点表达式，还可以指定切入点表达式的引用。</td> 
  </tr> 
  <tr> 
   <td>@AfterReturning</td> 
   <td>把当前方法看成是后置通知</td> 
   <td>value:用于指定切入点表达式，还可以指定切入点表达式的引用</td> 
  </tr> 
  <tr> 
   <td>@AfterThrowing</td> 
   <td>把当前方法看成是异常通知</td> 
   <td>value:用于指定切入点表达式，还可以指定切入点表达式的引用</td> 
  </tr> 
  <tr> 
   <td>@After</td> 
   <td>把当前方法看成是最终通知</td> 
   <td>value:用于指定切入点表达式，还可以指定切入点表达式的引用</td> 
  </tr> 
 </tbody> 
</table>

注意：如果通知注意引用切入点表达式，不要忘记写括号：切入点表达式名 + ()

##### 添加切入点表达式，通知注解可以直接引用该表达式 #####

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>作用</th> 
   <th>属性</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Pointcut</td> 
   <td>指定切入点表达式</td> 
   <td>value:指定表达式的内容</td> 
  </tr> 
 </tbody> 
</table>

@Pointcut("execution(* com.hxh.service.impl.*.*(..))")
    private void pointCut(){ }

##### 通知类实现代码 #####

@Component("logger")
    @Aspect// 表示当前类是一个切面类
    public class Logger { 
    
        /** * 配置切入点表达式 */
        @Pointcut("execution(* com.hxh.service.impl.*.*(..))")
        private void pointCut(){ }
    
        /** * 前置通知 */
        @Before("pointCut()")
        // @Before("execution(* com.hxh.service.impl.*.*(..))")
        public void beforePrintLog() { 
            System.out.println("前置通知....logger类中的pringLog方法开始记录日志了。。。。。。");
        }
    
        /** * 后置通知 */
        @AfterReturning("pointCut()")
        // @AfterReturning("execution(* com.hxh.service.impl.*.*(..))")
        public void afterReturnPrintLog() { 
            System.out.println("后置通知....logger类中的pringLog方法开始记录日志了。。。。。。");
        }
    
        /** * 异常通知 */
        @AfterThrowing("pointCut()")
        // @AfterThrowing("execution(* com.hxh.service.impl.*.*(..))")
        public void afterThrowingPrintLog() { 
            System.out.println("异常通知....logger类中的pringLog方法开始记录日志了。。。。。。");
        }
    
        /** * 最终通知 */
        @After("pointCut()")
        // @After("execution(* com.hxh.service.impl.*.*(..))")
        public void afterPrintLog() { 
            System.out.println("最终通知....logger类中的pringLog方法开始记录日志了。。。。。。");
        }
    }

注意：该方式存在一个问题，方法的执行顺序：前置通知 ——> 增强的方法 ——> 最终通知 ——> 后置通知或异常通知。  
方法执行顺序与期望的顺序不同，且无法控制。开发中，我们应该避免使用该种方式。

### 2.2 环绕通知注解配置【推荐】 ###

##### 环绕通知注解 #####

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>作用</th> 
   <th>属性</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Around</td> 
   <td>把当前方法看成是环绕通知</td> 
   <td>value:用于指定切入点表达式，还可以指定切入点表达式的引用</td> 
  </tr> 
 </tbody> 
</table>

@Component("logger")
    @Aspect
    public class Logger { 
        /** * 环绕通知 * 问题： * 当配置了环绕通知之后，切入点方法没有执行，而通知方法执行了。 * 分析： * 通过对比动态代理中的环绕通知代码，发现动态代理中的环绕通知有明确的业务层切入点方法调用，而我们代码中没有，所以出现如上问题。 * 解决： * Spring 框架为我们提供了一个接口：ProceedingJoinPoint。该接口有一个方法 prioceed(),此方法就相当于明确调用切入点方法。 * 该接口可以作为环绕通知的方法参数，在程序执行时，Spring框架会为我们提供该接口的实现类供我们使用 * * Spring 中的环绕通知： * 它是 Spring 框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方式。 */
        @Around()
        public Object arountPringLog(ProceedingJoinPoint pjp) { 
            Object returnValue = null;
            try { 
            	// 获取方法执行所需的参数
                Object[] args = pjp.getArgs(); 
    
                // 前置通知
                System.out.println("环绕通知....logger类中的arountPringLog方法开始记录日志了");
    
    			// 调用业务层方法（切入点方法）
                pjp.proceed(args); 
    
                // 后置通知
                System.out.println("环绕通知....logger类中的arountPringLog方法开始记录日志了");
    
                return returnValue;
            } catch (Throwable t) { 
                // 异常通知
                System.out.println("环绕通知....logger类中的arountPringLog方法开始记录日志了");
                throw new RuntimeException(t);
            } finally { 
                // 最后通知
                System.out.println("环绕通知....logger类中的arountPringLog方法开始记录日志了");
            }
        }
    }