Spring 之AOP AspectJ切入点语法详解

悠悠 2022-06-08 03:22 233阅读 0赞

一直依赖对aop的理解都是介入理论上的理解,在应用上,无非都是一些系统操作日志啥的应用,稍微复杂一点,或者使用场景较为特殊的例子,自己都未尝去使用和了解,对其内部,也是不知其根本,今天恰巧有机会,做自动化缓存更新,以及基于业务层的数据库读写分离,在实现的过程中,通过查资料和DEBUG,发现还是很有必要将这些东西,整理出一篇文章出来,以加深理解,方便自己和他人来学习,当然里面也是借鉴了很多其它文章里的经典(其实是Copy啦)!

**一、为什么写这个系列的博客**

Aspectj一个易用的、功能强大的aop编程语言。其官网地址是：http://www.eclipse.org/aspectj/，目前最新版本为：1.7.0 RC1。但关于他使用的中文资料少之又少，几乎没有比较完整的中文资料对其做介绍。笔者用Aspectj有段时间了，对其语法还是有些了解。故把自己的经验写出来与大家分享。学习过程主要是从官方网站学习，由于笔者英文水平有限（４级没有过），有理解不到位的地方也请大家多多指正。

**二、Aspectj是什么**

官方网站的的介绍是这样的：

*  a seamless aspect-oriented extension to the Javatm programming language（一种基于Java平台的面向切面编程的语言）
 *  Java platform compatible（兼容Java平台，可以无缝扩展）
 *  easy to learn and use（易学易用）

**三、Aspectj能做什么**

clean modularization of crosscutting concerns, such as error checking and handling, synchronization, context-sensitive behavior, performance optimizations, monitoring and logging, debugging support, and multi-object protocols。

大意是说：干净的模块化横切关注点（也就是说单纯，基本上无侵入），如错误检查和处理，同步，上下文敏感的行为，性能优化，监控和记录，调试支持，多目标的协议。

**四、还有那些常用的Aop**，**以及他们的区别**

*  Jboss Aop：我基本上没有用过，所以没有发言权
 *  Spring Aop：Spring自己原生的Aop，只能用一个词来形容：难用。　你需要实现大量的接口，继承大量的类，所以spring aop一度被千夫所指。这于他的无侵入，低耦合完全冲突。不过Spring对开源的优秀框架，组建向来是采用兼容，并入的态度。所以，后来的Spring 就提供了Aspectj支持，也就是我们后来所说的基于纯POJO的Aop。

区别：Spring Aop采用的动态织入，而Aspectj是静态织入。静态织入：指在编译时期就织入，即：编译出来的class文件，字节码就已经被织入了。动态织入又分静动两种，静则指织入过程只在第一次调用时执行；动则指根据代码动态运行的中间状态来决定如何操作，每次调用Target的时候都执行。有不清楚的同学，可以自己补下基础的代理知识。

五、**Aop术语解释**

基本上每篇Aop的文章都必讲的内容，不过笔者所将可能与他们不同，笔者不会照本宣科。

pointcut：　是一个（组）基于正则表达式的表达式，有点绕，就是说他本身是一个表达式，但是他是基于正则语法的。通常一个pointcut，会选取程序中的某些我们感兴趣的执行点，或者说是程序执行点的集合。

joinPoint：　通过pointcut选取出来的集合中的具体的一个执行点，我们就叫JoinPoint.

Advice：　在选取出来的JoinPoint上要执行的操作、逻辑。关于５种类型，我不多说，不懂的同学自己补基础。

aspect：　就是我们关注点的模块化。这个关注点可能会横切多个对象和模块，事务管理是横切关注点的很好的例子。它是一个抽象的概念，从软件的角度来说是指在应用程序不同模块中的某一个领域或方面。又pointcut 和　 advice组成。

Target：被aspectj横切的对象。我们所说的joinPoint就是Target的某一行，如方法开始执行的地方、方法类调用某个其他方法的代码

### 六、Spring AOP支持的AspectJ切入点指示符 ###

切入点指示符用来指示切入点表达式目的，在Spring AOP中目前只有执行方法这一个连接点，Spring AOP支持的AspectJ切入点指示符如下：

**execution：**用于匹配方法执行的连接点；

*         **within：**用于匹配指定类型内的方法执行；*

*         **this：**用于匹配当前AOP代理对象类型的执行方法；注意是AOP代理对象的类型匹配，这样就可能包括引入接口也类型匹配；*

*         **target：**用于匹配当前目标对象类型的执行方法；注意是目标对象的类型匹配，这样就不包括引入接口也类型匹配；*

*         **args：**用于匹配当前执行的方法传入的参数为指定类型的执行方法；*

*         **@within：**用于匹配所以持有指定注解类型内的方法；*

*         **@target：**用于匹配当前目标对象类型的执行方法，其中目标对象持有指定的注解；*

*         **@args：**用于匹配当前执行的方法传入的参数持有指定注解的执行；*

*         **@annotation：**用于匹配当前执行方法持有指定注解的方法；*

*         **bean：**Spring AOP扩展的，AspectJ没有对于指示符，用于匹配特定名称的Bean对象的执行方法；*

*         **reference pointcut：**表示引用其他命名切入点，只有@ApectJ风格支持，Schema风格不支持。*

AspectJ切入点支持的切入点指示符还有： call、get、set、preinitialization、staticinitialization、initialization、handler、adviceexecution、withincode、cflow、cflowbelow、if、@this、@withincode；但Spring AOP目前不支持这些指示符，使用这些指示符将抛出IllegalArgumentException异常。这些指示符Spring AOP可能会在以后进行扩展

### 七、命名及匿名切入点 ###

命名切入点可以被其他切入点引用，而匿名切入点是不可以的。

只有@AspectJ支持命名切入点，而Schema风格不支持命名切入点。

如下所示，@AspectJ使用如下方式引用命名切入点：

![Center][]

### 八. 类型匹配语法 ###

首先让我们来了解下AspectJ类型匹配的通配符：

\*：匹配任何数量字符；

..：匹配任何数量字符的重复，如在类型模式中匹配任何数量子包；而在方法参数模式中匹配任何数量参数。

**+：**匹配指定类型的子类型；仅能作为后缀放在类型模式后边。

java.lang.String    匹配String类型；  
    java.*.String       匹配java包下的任何“一级子包”下的String类型；  
    如匹配java.lang.String，但不匹配java.lang.ss.String  
    java..*            匹配java包及任何子包下的任何类型;  
                      如匹配java.lang.String、java.lang.annotation.Annotation  
    java.lang.*ing      匹配任何java.lang包下的以ing结尾的类型；  
    java.lang.Number+  匹配java.lang包下的任何Number的自类型；  
                       如匹配java.lang.Integer，也匹配java.math.BigInteger

*  **注解：**可选，方法上持有的注解，如@Deprecated；
 *  **修饰符：**可选，如public、protected；
 *  **返回值类型：**必填，可以是任何类型模式；“\*”表示所有类型；
 *  **类型声明：**可选，可以是任何类型模式；
 *  **方法名：**必填，可以使用“\*”进行模式匹配；
 *  **参数列表：**“()”表示方法没有任何参数；“(..)”表示匹配接受任意个参数的方法，“(..,java.lang.String)”表示匹配接受java.lang.String类型的参数结束，且其前边可以接受有任意个参数的方法；“(java.lang.String,..)” 表示匹配接受java.lang.String类型的参数开始，且其后边可以接受任意个参数的方法；“(\*,java.lang.String)” 表示匹配接受java.lang.String类型的参数结束，且其前边接受有一个任意类型参数的方法；
 *  **异常列表：**可选，以“throws 异常全限定名列表”声明，异常全限定名列表如有多个以“，”分割，如throws java.lang.IllegalArgumentException, java.lang.ArrayIndexOutOfBoundsException。

**匹配Bean名称：**可以使用Bean的id或name进行匹配，并且可使用通配符“\*”；

### 8.1 组合切入点表达式 ###

AspectJ使用 且（&&）、或（||）、非（！）来组合切入点表达式。

在Schema风格下，由于在XML中使用“&&”需要使用转义字符“&&”来代替之，所以很不方便，因此Spring ASP 提供了and、or、not来代替&&、||、！

### 6.5.3  切入点使用示例 ###

**       一、execution：**使用“execution(方法表达式)”匹配方法执行；

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;"> 模式 </td> 
 <td style="vertical-align:top;"> 描述 </td> 
 </tr> 
 <tr> 
 <td> public * *(..) </td> 
 <td> 任何公共方法的执行 </td> 
 </tr> 
 <tr> 
 <td> * cn.javass..IPointcutService.*() </td> 
 <td> cn.javass包及所有子包下IPointcutService接口中的任何无参方法 </td> 
 </tr> 
 <tr> 
 <td> * cn.javass..*.*(..) </td> 
 <td> cn.javass包及所有子包下任何类的任何方法 </td> 
 </tr> 
 <tr> 
 <td> * cn.javass..IPointcutService.*(*) </td> 
 <td> cn.javass包及所有子包下IPointcutService接口的任何只有一个参数方法 </td> 
 </tr> 
 <tr> 
 <td> * (!cn.javass..IPointcutService+).*(..) </td> 
 <td> 非“cn.javass包及所有子包下IPointcutService接口及子类型”的任何方法 </td> 
 </tr> 
 <tr> 
 <td> * cn.javass..IPointcutService+.*() </td> 
 <td> cn.javass包及所有子包下IPointcutService接口及子类型的的任何无参方法 </td> 
 </tr> 
 <tr> 
 <td> * cn.javass..IPointcut*.test*(java.util.Date) </td> 
 <td> cn.javass包及所有子包下IPointcut前缀类型的的以test开头的只有一个参数类型为java.util.Date的方法，注意该匹配是根据方法签名的参数类型进行匹配的，而不是根据执行时传入的参数类型决定的 如定义方法：public void test(Object obj);即使执行时传入java.util.Date，也不会匹配的； </td> 
 </tr> 
 <tr> 
 <td> * cn.javass..IPointcut*.test*(..)&nbsp; throws &nbsp;IllegalArgumentException, ArrayIndexOutOfBoundsException </td> 
 <td> cn.javass包及所有子包下IPointcut前缀类型的的任何方法，且抛出IllegalArgumentException和ArrayIndexOutOfBoundsException异常 </td> 
 </tr> 
 <tr> 
 <td> * (cn.javass..IPointcutService+ &amp;&amp; java.io.Serializable+).*(..) </td> 
 <td> 任何实现了cn.javass包及所有子包下IPointcutService接口和java.io.Serializable接口的类型的任何方法 </td> 
 </tr> 
 <tr> 
 <td> @java.lang.Deprecated * *(..) </td> 
 <td> 任何持有@java.lang.Deprecated注解的方法 </td> 
 </tr> 
 <tr> 
 <td> @java.lang.Deprecated @cn.javass..Secure &nbsp;* *(..) </td> 
 <td> 任何持有@java.lang.Deprecated和@cn.javass..Secure注解的方法 </td> 
 </tr> 
 <tr> 
 <td> @(java.lang.Deprecated || cn.javass..Secure) * *(..) </td> 
 <td> 任何持有@java.lang.Deprecated或@ cn.javass..Secure注解的方法 </td> 
 </tr> 
 <tr> 
 <td> (@cn.javass..Secure &nbsp;*)&nbsp; *(..) </td> 
 <td> 任何返回值类型持有@cn.javass..Secure的方法 </td> 
 </tr> 
 <tr> 
 <td> * &nbsp;(@cn.javass..Secure *).*(..) </td> 
 <td> 任何定义方法的类型持有@cn.javass..Secure的方法 </td> 
 </tr> 
 <tr> 
 <td> * *(@cn.javass..Secure (*) , @cn.javass..Secure (*)) </td> 
 <td> 任何签名带有两个参数的方法，且这个两个参数都被@ Secure标记了， 如public void test(@Secure String str1, &nbsp;@Secure String str1); </td> 
 </tr> 
 <tr> 
 <td> * *((@ cn.javass..Secure *))或 * *(@ cn.javass..Secure *) </td> 
 <td> 任何带有一个参数的方法，且该参数类型持有@ cn.javass..Secure； 如public void test(Model model);且Model类上持有@Secure注解 </td> 
 </tr> 
 <tr> 
 <td> * *( @cn.javass..Secure (@cn.javass..Secure *) , @ cn.javass..Secure (@cn.javass..Secure *)) </td> 
 <td> 任何带有两个参数的方法，且这两个参数都被@ cn.javass..Secure标记了；且这两个参数的类型上都持有@ cn.javass..Secure； &nbsp; </td> 
 </tr> 
 <tr> 
 <td> * *( java.util.Map&lt;cn.javass..Model, cn.javass..Model&gt; , ..) </td> 
 <td> 任何带有一个java.util.Map参数的方法，且该参数类型是以&lt; cn.javass..Model, cn.javass..Model &gt;为泛型参数；注意只匹配第一个参数为java.util.Map,不包括子类型； 如public void test(HashMap&lt;Model, Model&gt; map, String str);将不匹配，必须使用“* *( java.util.HashMap&lt;cn.javass..Model,cn.javass..Model&gt; , ..)”进行匹配； 而public void test(Map map, int i);也将不匹配，因为泛型参数不匹配 </td> 
 </tr> 
 <tr> 
 <td> * *(java.util.Collection&lt;@cn.javass..Secure *&gt;) </td> 
 <td> 任何带有一个参数（类型为java.util.Collection）的方法，且该参数类型是有一个泛型参数，该泛型参数类型上持有@cn.javass..Secure注解； 如public void test(Collection&lt;Model&gt; collection);Model类型上持有@cn.javass..Secure </td> 
 </tr> 
 <tr> 
 <td> * *(java.util.Set&lt;? extends HashMap&gt;) </td> 
 <td> 任何带有一个参数的方法，且传入的参数类型是有一个泛型参数，该泛型参数类型继承与HashMap； Spring AOP目前测试不能正常工作 </td> 
 </tr> 
 <tr> 
 <td> * *(java.util.List&lt;? super HashMap&gt;) </td> 
 <td> 任何带有一个参数的方法，且传入的参数类型是有一个泛型参数，该泛型参数类型是HashMap的基类型；如public voi test(Map map)； Spring AOP目前测试不能正常工作 </td> 
 </tr> 
 <tr> 
 <td> * *(*&lt;@cn.javass..Secure *&gt;) </td> 
 <td> 任何带有一个参数的方法，且该参数类型是有一个泛型参数，该泛型参数类型上持有@cn.javass..Secure注解； Spring AOP目前测试不能正常工作 </td> 
 </tr> 
 </tbody> 
</table>

**二***、***within：使用“within(类型表达式)”***匹配指定类型内的方法执行；*

**三***、**this：**使用“this(类型全限定名)”匹配当前AOP代理对象类型的执行方法；注意是AOP代理对象的类型匹配，这样就可能包括引入接口方法也可以匹配；注意this中使用的表达式必须是类型全限定名，不支持通配符；*

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;"> 模式 </td> 
 <td style="vertical-align:top;"> 描述 </td> 
 </tr> 
 <tr> 
 <td> this(cn.javass.spring.chapter6.service.IPointcutService) </td> 
 <td> 当前AOP对象实现了 IPointcutService接口的任何方法 </td> 
 </tr> 
 <tr> 
 <td> this(cn.javass.spring.chapter6.service.IIntroductionService) </td> 
 <td> 当前AOP对象实现了 IIntroductionService接口的任何方法 也可能是引入接口 </td> 
 </tr> 
 </tbody> 
</table>

* *

*四、**target：**使用“target(类型全限定名)”匹配当前目标对象类型的执行方法；注意是目标对象的类型匹配，这样就不包括引入接口也类型匹配；注意target中使用的表达式必须是类型全限定名，不支持通配符；*

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;"> 模式 </td> 
 <td style="vertical-align:top;"> 描述 </td> 
 </tr> 
 <tr> 
 <td> target(cn.javass.spring.chapter6.service.IPointcutService) </td> 
 <td> 当前目标对象（非AOP对象）实现了 IPointcutService接口的任何方法 </td> 
 </tr> 
 <tr> 
 <td> target(cn.javass.spring.chapter6.service.IIntroductionService) </td> 
 <td> 当前目标对象（非AOP对象） 实现了IIntroductionService 接口的任何方法 不可能是引入接口 </td> 
 </tr> 
 </tbody> 
</table>

* *

*五、**args：**使用“args(参数类型列表)”匹配当前执行的方法传入的参数为指定类型的执行方法；注意是匹配传入的参数类型，不是匹配方法签名的参数类型；参数类型列表中的参数必须是类型全限定名，通配符不支持；args属于动态切入点，这种切入点开销非常大，非特殊情况最好不要使用；*

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;"> 模式 </td> 
 <td style="vertical-align:top;"> 描述 </td> 
 </tr> 
 <tr> 
 <td> args (java.io.Serializable,..) </td> 
 <td> 任何一个以接受“传入参数类型为 java.io.Serializable” 开头，且其后可跟任意个任意类型的参数的方法执行，args指定的参数类型是在运行时动态匹配的 </td> 
 </tr> 
 </tbody> 
</table>

*** ***

***六、@within：**使用“@within(注解类型)”匹配所以持有指定注解类型内的方法；注解类型也必须是全限定类型名；*

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;"> 模式 </td> 
 <td style="vertical-align:top;"> 描述 </td> 
 </tr> 
 <tr> 
 <td> @within cn.javass.spring.chapter6.Secure) </td> 
 <td> 任何目标对象对应的类型持有Secure注解的类方法； 必须是在目标对象上声明这个注解，在接口上声明的对它不起作用 </td> 
 </tr> 
 </tbody> 
</table>

*** ***

***七、@target：**使用“@target(注解类型)”匹配当前目标对象类型的执行方法，其中目标对象持有指定的注解；注解类型也必须是全限定类型名；*

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;"> 模式 </td> 
 <td style="vertical-align:top;"> 描述 </td> 
 </tr> 
 <tr> 
 <td> @target (cn.javass.spring.chapter6.Secure) </td> 
 <td> 任何目标对象持有Secure注解的类方法； 必须是在目标对象上声明这个注解，在接口上声明的对它不起作用 </td> 
 </tr> 
 </tbody> 
</table>

*** ***

***八、@args：**使用“@args(注解列表)”匹配当前执行的方法传入的参数持有指定注解的执行；注解类型也必须是全限定类型名；*

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;"> 模式 </td> 
 <td style="vertical-align:top;"> 描述 </td> 
 </tr> 
 <tr> 
 <td> @args (cn.javass.spring.chapter6.Secure) </td> 
 <td> 任何一个只接受一个参数的方法，且方法运行时传入的参数持有注解 cn.javass.spring.chapter6.Secure；动态切入点，类似于arg指示符； </td> 
 </tr> 
 </tbody> 
</table>

*** ***

***九、@annotation：**使用“@annotation(注解类型)”匹配当前执行方法持有指定注解的方法；注解类型也必须是全限定类型名；*

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;"> 模式 </td> 
 <td style="vertical-align:top;"> 描述 </td> 
 </tr> 
 <tr> 
 <td> @annotation(cn.javass.spring.chapter6.Secure ) </td> 
 <td> 当前执行方法上持有注解 cn.javass.spring.chapter6.Secure将被匹配 </td> 
 </tr> 
 </tbody> 
</table>

*** ***

***十、bean：**使用“bean(Bean id或名字通配符)”匹配特定名称的Bean对象的执行方法；Spring ASP扩展的，在AspectJ中无相应概念；*

** **

**十一、reference pointcut：**表示引用其他命名切入点，只有@ApectJ风格支持，Schema风格不支持，如下所示：

![Center 1][]

在Spring配置文件中，所以AOP相关定义必须放在<aop:config>标签下，该标签下可以有<aop:pointcut>、<aop:advisor>、<aop:aspect>标签，配置顺序不可变。

* <aop:pointcut>：用来定义切入点，该切入点可以重用；
 * <aop:advisor>：用来定义只有一个通知和一个切入点的切面；
 * <aop:aspect>：用来定义切面，该切面可以包含多个切入点和通知，而且标签内部的通知和切入点定义是无序的；和advisor的区别就在此，advisor只包含一个通知和一个切入点

![Center 2][]

[Center]: /images/20220608/4bfa522b0cf140e0bc749643fd2fe163.png
[Center 1]: /images/20220608/f9eb0b8afa2040a996ee3757965fa41c.png
[Center 2]: /images/20220608/eb9e98664a5c44a3a8d6c19ba9ba4dfb.png