Spring| AOP-AspectJ切入點語法詳解

6.5.0 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 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風格不支持,如下所示:
在這裏插入圖片描述
比如我們定義如下切面:

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() {}  
}  

可以通過如下方式引用:

@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#7144

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章