【第六章】 AOP 之 6.5 AspectJ切入点语法详解 ——跟我学spring3

 

6.5.1  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可能会在以后进行扩展。

6.5.1  命名及匿名切入点

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

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

 

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

6.5.2        ；类型匹配语法

首先让我们来了解下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；
• 类的全限定名：必填，可以是任何类全限定名。

         匹配方法执行：使用如下方式匹配：

	注解？ 修饰符? 返回值类型 类型声明?方法名(参数列表) 异常列表？

 

 

 

• 
  
• 注解：可选，方法上持有的注解，如@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进行匹配，并且可使用通配符“*”；

 

6.5.3  组合切入点表达式

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

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

 

 

6.5.4  切入点使用示例

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

 

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

 

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

模式	描述
within(cn.javass..*)	cn.javass包及子包下的任何方法执行
within(cn.javass..IPointcutService+)	cn.javass包或所有子包下IPointcutService类型及子类型的任何方法
within(@cn.javass..Secure *)	持有cn.javass..Secure注解的任何类型的任何方法 必须是在目标对象上声明这个注解，在接口上声明的对它不起作用

 

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

 

模式	描述
this(cn.javass.spring.chapter6.service.IPointcutService)	当前AOP对象实现了 IPointcutService接口的任何方法
this(cn.javass.spring.chapter6.service.IIntroductionService)	当前AOP对象实现了 IIntroductionService接口的任何方法 也可能是引入接口

 

 

 

 

 

 

 

 

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

模式	描述
target(cn.javass.spring.chapter6.service.IPointcutService)	当前目标对象（非AOP对象）实现了 IPointcutService接口的任何方法
target(cn.javass.spring.chapter6.service.IIntroductionService)	当前目标对象（非AOP对象） 实现了IIntroductionService 接口的任何方法 不可能是引入接口

 

 

 

 

 

 

 

 

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

模式	描述
args (java.io.Serializable,..)	任何一个以接受“传入参数类型为 java.io.Serializable” 开头，且其后可跟任意个任意类型的参数的方法执行，args指定的参数类型是在运行时动态匹配的

 

 

 

 

 

 

 

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

模式	描述
@within cn.javass.spring.chapter6.Secure)	任何目标对象对应的类型持有Secure注解的类方法； 必须是在目标对象上声明这个注解，在接口上声明的对它不起作用

 

 

 

 

 

 

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

模式	描述
@target (cn.javass.spring.chapter6.Secure)	任何目标对象持有Secure注解的类方法； 必须是在目标对象上声明这个注解，在接口上声明的对它不起作用

 

 

 

 

 

 

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

模式	描述
@args (cn.javass.spring.chapter6.Secure)	任何一个只接受一个参数的方法，且方法运行时传入的参数持有注解 cn.javass.spring.chapter6.Secure；动态切入点，类似于arg指示符；

 

 

 

 

 

 

 

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

模式	描述
@annotation(cn.javass.spring.chapter6.Secure )	当前执行方法上持有注解 cn.javass.spring.chapter6.Secure将被匹配

 

 

 

 

 

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

模式	描述
bean(*Service)	匹配所有以Service命名（id或name）结尾的Bean

 

 

 

 

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

       比如我们定义如下切面：

 

java代码：

package cn.javass.spring.chapter6.aop;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
@Aspect
public class ReferencePointcutAspect {
    @Pointcut(value="execution(* *())")
    public void pointcut() {}
}

 

       可以通过如下方式引用：

 

java代码：

@Before(value = "cn.javass.spring.chapter6.aop.ReferencePointcutAspect.pointcut()")
public void referencePointcutTest2(JoinPoint jp) {}

 

       除了可以在@AspectJ风格的切面内引用外，也可以在Schema风格的切面定义内引用，引用方式与@AspectJ完全一样。

 

       到此我们切入点表达式语法示例就介绍完了，我们这些示例几乎包含了日常开发中的所有情况，但当然还有更复杂的语法等等，如果以上介绍的不能满足您的需要，请参考AspectJ文档。

 

       由于测试代码相当长，所以为了节约篇幅本示例代码在cn.javass.spring.chapter6. PointcutTest文件中，需要时请参考该文件。

 

 

原创内容，转自请注明出处【http://sishuok.com/forum/blogPost/list/0/2472.html】

评论

7 楼 dagger9527 2019-08-16  

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

有一个问题不太明白
Schema只是不支持带参数的命名切入点吧。
像

<aop:pointcut id="pointcut" expression="execution(* cn.javass..*.*(..))"/>

这样的不是一个命名切入点吗

6 楼 oo1238912 2012-08-10  

oo1238912 写道

jinnianshilongnian 写道

oo1238912 写道

博主你好，跟着你的文章学习了AOP方面的知识，受益匪浅，同时我有个问题想请教下，AOP中的通知可否用在多个参数不同的切入点上？现在是因为种种历史原因，项目中大部分条件查询都是使用SQL拼接的方式直接写在DAO层中，所以面临SQL注入的问题，现在是希望不修改源代码，可以使用AOP去修改所有以DAO结尾的类的方法中的参数，替换掉其中的特殊字符，来解决这个SQL注入的问题，不知道这个办法是否有可行性？或者是否还有其他更好的方法呢？还希望博主不吝赐教。

可以！ 通过环绕通知即可

额，环绕通知的确可以，谢谢指导，另外我想问一个问题，如果我想定义的切入点是某个后缀名而且必须定义了某个注解的方法，应该怎么做？我写了如下的信息，但是不起作用。。。

execution(* (com.learn.spring..*Impl && @com.learn.spring.sqlconvert.SqlConvert *).*(..))

public @interface SqlConvert {

}

我希望他能起到的作用是所有spring包下以Impl为后缀名并且有SqlConvert这个注解的方法，该注解是自定义的，不过不起作用，求指教。。。

解决了。。。分开来写然后用pointcut1()&&pointcut2()的方式就好了。。。谢谢博主的文章。。。

5 楼 oo1238912 2012-08-10  

jinnianshilongnian 写道

oo1238912 写道

博主你好，跟着你的文章学习了AOP方面的知识，受益匪浅，同时我有个问题想请教下，AOP中的通知可否用在多个参数不同的切入点上？现在是因为种种历史原因，项目中大部分条件查询都是使用SQL拼接的方式直接写在DAO层中，所以面临SQL注入的问题，现在是希望不修改源代码，可以使用AOP去修改所有以DAO结尾的类的方法中的参数，替换掉其中的特殊字符，来解决这个SQL注入的问题，不知道这个办法是否有可行性？或者是否还有其他更好的方法呢？还希望博主不吝赐教。

可以！ 通过环绕通知即可

额，环绕通知的确可以，谢谢指导，另外我想问一个问题，如果我想定义的切入点是某个后缀名而且必须定义了某个注解的方法，应该怎么做？我写了如下的信息，但是不起作用。。。

execution(* (com.learn.spring..*Impl && @com.learn.spring.sqlconvert.SqlConvert *).*(..))

public @interface SqlConvert {

}

我希望他能起到的作用是所有spring包下以Impl为后缀名并且有SqlConvert这个注解的方法，该注解是自定义的，不过不起作用，求指教。。。

4 楼 jinnianshilongnian 2012-07-31  

oo1238912 写道

博主你好，跟着你的文章学习了AOP方面的知识，受益匪浅，同时我有个问题想请教下，AOP中的通知可否用在多个参数不同的切入点上？现在是因为种种历史原因，项目中大部分条件查询都是使用SQL拼接的方式直接写在DAO层中，所以面临SQL注入的问题，现在是希望不修改源代码，可以使用AOP去修改所有以DAO结尾的类的方法中的参数，替换掉其中的特殊字符，来解决这个SQL注入的问题，不知道这个办法是否有可行性？或者是否还有其他更好的方法呢？还希望博主不吝赐教。

可以！ 通过环绕通知即可

3 楼 oo1238912 2012-07-30  

博主你好，跟着你的文章学习了AOP方面的知识，受益匪浅，同时我有个问题想请教下，AOP中的通知可否用在多个参数不同的切入点上？现在是因为种种历史原因，项目中大部分条件查询都是使用SQL拼接的方式直接写在DAO层中，所以面临SQL注入的问题，现在是希望不修改源代码，可以使用AOP去修改所有以DAO结尾的类的方法中的参数，替换掉其中的特殊字符，来解决这个SQL注入的问题，不知道这个办法是否有可行性？或者是否还有其他更好的方法呢？还希望博主不吝赐教。

2 楼 jinnianshilongnian 2012-07-20  

zmr518 写道

研究的真透彻

谢谢

1 楼 zmr518 2012-07-19  

研究的真透彻