spring——AOP面向切面编程——基于注解的AspectJ AOP开发（转载）

今天药忘吃喽~ 2024-03-31 17:41 141阅读 0赞

在 Spring 中，虽然我们可以使用 XML 配置文件可以实现 AOP 开发，但如果所有的配置都集中在 XML 配置文件中，就势必会造成 XML 配置文件过于臃肿，从而给维护和升级带来一定困难。  
为此，AspectJ 框架为 AOP 开发提供了一套 @AspectJ 注解。它允许我们直接在 Java 类中通过注解的方式对切面(Aspect)、切入点(Pointcut)和增强(Advice)进行定义，Spring 框架可以根据这些注解生成 AOP 代理。  
关于注解的介绍如表 1 所示。

<table>  表 1 Annotation 注解介绍  
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Aspect</td> 
   <td>用于定义一个切面。</td> 
  </tr> 
  <tr> 
   <td>@Pointcut</td> 
   <td>用于定义一个切入点。</td> 
  </tr> 
  <tr> 
   <td>@Before</td> 
   <td>用于定义前置通知，相当于 BeforeAdvice。</td> 
  </tr> 
  <tr> 
   <td>@AfterReturning</td> 
   <td>用于定义后置通知，相当于 AfterReturningAdvice。</td> 
  </tr> 
  <tr> 
   <td>@Around</td> 
   <td>用于定义环绕通知，相当于 MethodInterceptor。</td> 
  </tr> 
  <tr> 
   <td>@AfterThrowing</td> 
   <td>用于定义抛出通知，相当于 ThrowAdvice。</td> 
  </tr> 
  <tr> 
   <td>@After</td> 
   <td>用于定义最终通知，不管是否异常，该通知都会执行。</td> 
  </tr> 
  <tr> 
   <td>@DeclareParents</td> 
   <td>用于定义引介通知，相当于 IntroductionInterceptor(不要求掌握)。</td> 
  </tr> 
 </tbody> 
</table>

### 启用 @AspectJ 注解支持 ###

在使用 @AspectJ 注解进行 AOP 开发前，首先我们要先启用 @AspectJ 注解支持。  
我们可以通过以下 2 种方式来启用 @AspectJ 注解。

##### 1)使用 Java 配置类启用 #####

我们可以在 Java 配置类(标注了 @Configuration 注解的类)中，使用 @EnableAspectJAutoProxy 和 @ComponentScan 注解启用 @AspectJ 注解支持。

![a6e38f735bd9a06d95a70ed824622889.png][]

![9974d733b822c0585d2e8a5a06069988.png][]

![15f7b9ce270a8be7bec8cbb6ab821aa3.png][]

![b7b66b955219cdc2c5c1b505945419e6.png][]

![630fe5c2da1393d82fba88706e2a0cfe.png][]

### 定义通知 ###

AspectJ 为我们提供了以下 6 个注解，来定义 6 种不同类型的通知(Advice)，如下表。

<table>  &nbsp;  
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Before</td> 
   <td>用于定义前置通知，相当于 BeforeAdvice。</td> 
  </tr> 
  <tr> 
   <td>@AfterReturning</td> 
   <td>用于定义后置通知，相当于 AfterReturningAdvice。</td> 
  </tr> 
  <tr> 
   <td>@Around</td> 
   <td>用于定义环绕通知，相当于 MethodInterceptor。</td> 
  </tr> 
  <tr> 
   <td>@AfterThrowing</td> 
   <td>用于定义抛出通知，相当于 ThrowAdvice。</td> 
  </tr> 
  <tr> 
   <td>@After</td> 
   <td>用于定义最终通知，不管是否异常，该通知都会执行。</td> 
  </tr> 
  <tr> 
   <td>@DeclareParents</td> 
   <td>用于定义引介通知，相当于 IntroductionInterceptor(不要求掌握)。</td> 
  </tr> 
 </tbody> 
</table>

以上这些通知注解中都有一个 value 属性，这个 value 属性的取值就是这些通知(Advice)作用的切点(PointCut)，它既可以是切入点表达式，也可以是切入点的引用(切入点对应的方法名称)，示例代码如下。

![f48db8e14fc7a95643e0d61c71f82b6e.png][]

### 示例 ###

下面，我们就通过一个完整的实例，来演示下如何通过注解的方式实现 AspectJ AOP 开发。  
1. 新建一个名为 my-spring-asepctj-demo2 的 Java 项目，并将以下依赖 Jar 包导入到该项目中。

*  commons-logging-1.2.jar
 *  spring-aop-5.3.13.jar
 *  spring-aspects-5.3.13.jar
 *  spring-beans-5.3.13.jar
 *  spring-context-5.3.13.jar
 *  spring-core-5.3.13.jar
 *  spring-expression-5.3.13.jar
 *  aspectjweaver-1.9.7.jar

2. 在 net.biancheng.c.dao 包下，创建一个名为 UserDao 的接口，代码如下。

![37848296aaa411dc0c87cc0cd994a999.png][]

![c4c669773ba229f50c6bf60f7c6aa1a7.png][]

![883af331d453aa91eadec2306e4a3a79.png][]

5. 在 net.biancheng.c 包下，创建一个名为 MyAspect 的切面类，代码如下。

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div> 
    <div>
      15 
    </div> 
    <div>
      16 
    </div> 
    <div>
      17 
    </div> 
    <div>
      18 
    </div> 
    <div>
      19 
    </div> 
    <div>
      20 
    </div> 
    <div>
      21 
    </div> 
    <div>
      22 
    </div> 
    <div>
      23 
    </div> 
    <div>
      24 
    </div> 
    <div>
      25 
    </div> 
    <div>
      26 
    </div> 
    <div>
      27 
    </div> 
    <div>
      28 
    </div> 
    <div>
      29 
    </div> 
    <div>
      30 
    </div> 
    <div>
      31 
    </div> 
    <div>
      32 
    </div> 
    <div>
      33 
    </div> 
    <div>
      34 
    </div> 
    <div>
      35 
    </div> 
    <div>
      36 
    </div> 
    <div>
      37 
    </div> 
    <div>
      38 
    </div> 
    <div>
      39 
    </div> 
    <div>
      40 
    </div> 
    <div>
      41 
    </div> 
    <div>
      42 
    </div> 
    <div>
      43 
    </div> 
    <div>
      44 
    </div> 
    <div>
      45 
    </div> 
    <div>
      46 
    </div> 
    <div>
      47 
    </div> 
    <div>
      48 
    </div> 
    <div>
      49 
    </div> 
    <div>
      50 
    </div> 
    <div>
      51 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>package</code>&nbsp; 
      <code>net.biancheng.c;</code> 
     </div> 
     <div> 
      <code>import</code>&nbsp; 
      <code>org.aspectj.lang.JoinPoint;</code> 
     </div> 
     <div> 
      <code>import</code>&nbsp; 
      <code>org.aspectj.lang.ProceedingJoinPoint;</code> 
     </div> 
     <div> 
      <code>import</code>&nbsp; 
      <code>org.aspectj.lang.annotation.*;</code> 
     </div> 
     <div> 
      <code>import</code>&nbsp; 
      <code>org.springframework.stereotype.Component;</code> 
     </div> 
     <div> 
      <code>@Component</code>&nbsp; 
      <code>// 定义成 Bean</code> 
     </div> 
     <div> 
      <code>@Aspect</code>&nbsp; 
      <code>//定义为切面</code> 
     </div> 
     <div> 
      <code>public</code>&nbsp; 
      <code>class</code>&nbsp; 
      <code>MyAspect { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>@Before</code> 
      <code>(</code> 
      <code>"execution(* net.biancheng.c.dao.UserDao.add(..))"</code> 
      <code>)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code>&nbsp; 
      <code>void</code>&nbsp; 
      <code>before(JoinPoint joinPoint) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(</code> 
      <code>"前置增强……"</code>&nbsp; 
      <code>+ joinPoint);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>@After</code> 
      <code>(</code> 
      <code>"execution(* net.biancheng.c.dao.UserDao.get(..))"</code> 
      <code>)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code>&nbsp; 
      <code>void</code>&nbsp; 
      <code>after(JoinPoint joinPoint) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(</code> 
      <code>"最终增强……"</code>&nbsp; 
      <code>+ joinPoint);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>/**</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>* 将 net.biancheng.c.dao包下的 UserDao 类中的 get() 方法 定义为一个切点</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>*/</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>@Pointcut</code> 
      <code>(value =&nbsp;</code> 
      <code>"execution(* net.biancheng.c.dao.UserDao.get(..))"</code> 
      <code>)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code>&nbsp; 
      <code>void</code>&nbsp; 
      <code>pointCut1() { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>/**</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>* 将 net.biancheng.c.dao包下的 UserDao 类中的 delete() 方法 定义为一个切点</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>*/</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>@Pointcut</code> 
      <code>(value =&nbsp;</code> 
      <code>"execution(* net.biancheng.c.dao.UserDao.delete(..))"</code> 
      <code>)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code>&nbsp; 
      <code>void</code>&nbsp; 
      <code>pointCut2() { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>//使用切入点引用</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>@Around</code> 
      <code>(</code> 
      <code>"MyAspect.pointCut2()"</code> 
      <code>)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code>&nbsp; 
      <code>void</code>&nbsp; 
      <code>around(ProceedingJoinPoint proceedingJoinPoint)&nbsp;</code> 
      <code>throws</code>&nbsp; 
      <code>Throwable { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(</code> 
      <code>"环绕增强……1"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>proceedingJoinPoint.proceed();</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(</code> 
      <code>"环绕增强……2"</code> 
      <code>);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>//使用切入点表达式</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>@AfterReturning</code> 
      <code>(value =&nbsp;</code> 
      <code>"execution(* net.biancheng.c.dao.UserDao.modify(..))"</code> 
      <code>, returning =&nbsp;</code> 
      <code>"returnValue"</code> 
      <code>)</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code>&nbsp; 
      <code>void</code>&nbsp; 
      <code>afterReturning(Object returnValue) { </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>System.out.println(</code> 
      <code>"后置返回增强……,方法返回值为："</code>&nbsp; 
      <code>+ returnValue);</code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>}</code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

![96b36d75aa5bf059b59fedafc6b77138.png][]

![e678526d9b41f4dd556f04a5288f8b74.png][]

[a6e38f735bd9a06d95a70ed824622889.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/47d1e10c761d4ebeb5635b02ef513a18.png
[9974d733b822c0585d2e8a5a06069988.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/f62fb80007e143639c2d3fbd97fb393c.png
[15f7b9ce270a8be7bec8cbb6ab821aa3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/4d96fdc2013a47dbacdb8a87463acf3f.png
[b7b66b955219cdc2c5c1b505945419e6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/0fc57233f7464f39932ddaf104464127.png
[630fe5c2da1393d82fba88706e2a0cfe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/c66b648f827d4b408365e1d137b4ab30.png
[f48db8e14fc7a95643e0d61c71f82b6e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/738656b309e1445a9d6c1cdab88efdca.png
[37848296aaa411dc0c87cc0cd994a999.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/2d816c09ac364bb7a6058e6320a473e8.png
[c4c669773ba229f50c6bf60f7c6aa1a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/7c400d3ca47c4a8493fe3e8d1a1e374d.png
[883af331d453aa91eadec2306e4a3a79.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/5631d1a981404ed99b9dad2e52894f5f.png
[96b36d75aa5bf059b59fedafc6b77138.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/c6dd8c7827d843b2831436a449689890.png
[e678526d9b41f4dd556f04a5288f8b74.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/b643ca71fb904c6f980dd7f5dd7fd591.png