AspectJ切入點語法詳解
6.5 AspectJ切入點語法詳解
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
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程式碼：
- 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
接下來再看一下具體的匹配表示式型別吧：
匹配型別：使用如下方式匹配
java程式碼：
- 註解？ 類的全限定名字
- 註解：可選，型別上持有的註解，如@Deprecated；
- 類的全限定名：必填，可以是任何類全限定名。
匹配方法執行：使用如下方式匹配：
java程式碼：
- 註解？ 修飾符? 返回值型別 型別宣告?方法名(引數列表) 異常列表？
- 註解：可選，方法上持有的註解，如@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.3 切入點使用示例
一、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檔案中，需要時請參考該檔案。
6.6 通知引數
前邊章節已經介紹了宣告通知，但如果想獲取被被通知方法引數並傳遞給通知方法，該如何實現呢？接下來我們將介紹兩種獲取通知引數的方式。
- 使用JoinPoint獲取：Spring AOP提供使用org.aspectj.lang.JoinPoint型別獲取連線點資料，任何通知方法的第一個引數都可以是JoinPoint(環繞通知是ProceedingJoinPoint，JoinPoint子類)，當然第一個引數位置也可以是JoinPoint.StaticPart型別，這個只返回連線點的靜態部分。
1) JoinPoint：提供訪問當前被通知方法的目標物件、代理物件、方法引數等資料：
java程式碼：
- package org.aspectj.lang;
- import org.aspectj.lang.reflect.SourceLocation;
- public interface JoinPoint {
- String toString(); //連線點所在位置的相關資訊
- String toShortString(); //連線點所在位置的簡短相關資訊
- String toLongString(); //連線點所在位置的全部相關資訊
- Object getThis(); //返回AOP代理物件
- Object getTarget(); //返回目標物件
- Object[] getArgs(); //返回被通知方法引數列表
- Signature getSignature(); //返回當前連線點簽名
- SourceLocation getSourceLocation();//返回連線點方法所在類檔案中的位置
- String getKind(); //連線點型別
- StaticPart getStaticPart(); //返回連線點靜態部分
- }
2）ProceedingJoinPoint：用於環繞通知，使用proceed()方法來執行目標方法：
java程式碼：
- public interface ProceedingJoinPoint extends JoinPoint {
- public Object proceed() throws Throwable;
- public Object proceed(Object[] args) throws Throwable;
- }
3) JoinPoint.StaticPart：提供訪問連線點的靜態部分，如被通知方法簽名、連線點型別等：
java程式碼：
- public interface StaticPart {
- Signature getSignature(); //返回當前連線點簽名
- String getKind(); //連線點型別
- int getId(); //唯一標識
- String toString(); //連線點所在位置的相關資訊
- String toShortString(); //連線點所在位置的簡短相關資訊
- String toLongString(); //連線點所在位置的全部相關資訊
- }
使用如下方式在通知方法上宣告，必須是在第一個引數，然後使用jp.getArgs()就能獲取到被通知方法引數：
java程式碼：
- @Before(value="execution(* sayBefore(*))")
- public void before(JoinPoint jp) {}
- @Before(value="execution(* sayBefore(*))")
- public void before(JoinPoint.StaticPart jp) {}
- 自動獲取：通過切入點表示式可以將相應的引數自動傳遞給通知方法，例如前邊章節講過的返回值和異常是如何傳遞給通知方法的。
在Spring AOP中，除了execution和bean指示符不能傳遞引數給通知方法，其他指示符都可以將匹配的相應引數或物件自動傳遞給通知方法。
java程式碼：
- @Before(value="execution(* test(*)) && args(param)", argNames="param")
- public void before1(String param) {
- System.out.println("===param:" + param);
- }
切入點表示式execution(* test(*)) && args(param) ：
1）首先execution(* test(*))匹配任何方法名為test，且有一個任何型別的引數；
2）args(param)將首先查詢通知方法上同名的引數，並在方法執行時（執行時）匹配傳入的引數是使用該同名引數型別，即java.lang.String；如果匹配將把該被通知引數傳遞給通知方法上同名引數。
其他指示符（除了execution和bean指示符）都可以使用這種方式進行引數繫結。
在此有一個問題，即前邊提到的類似於【3.1.2構造器注入】中的引數名注入限制：在class檔案中沒生成變數除錯資訊是獲取不到方法引數名字的。
所以我們可以使用策略來確定引數名：
- 如果我們通過“argNames”屬性指定了引數名，那麼就是要我們指定的；
java程式碼：
- @Before(value=" args(param)", argNames="param") //明確指定了
- public void before1(String param) {
- System.out.println("===param:" + param);
- }
- 如果第一個引數型別是JoinPoint、ProceedingJoinPoint或JoinPoint.StaticPart型別，應該從“argNames”屬性省略掉該引數名（可選，寫上也對），這些型別物件會自動傳入的，但必須作為第一個引數；
java程式碼：
- @Before(value=" args(param)", argNames="param") //明確指定了
- public void before1(JoinPoint jp, String param) {
- System.out.println("===param:" + param);
- }
- 如果“class檔案中含有變數除錯資訊”將使用這些方法簽名中的引數名來確定引數名；
java程式碼：
- @Before(value=" args(param)") //不需要argNames了
- public void before1(JoinPoint jp, String param) {
- System.out.println("===param:" + param);
- }
- 如果沒有“class檔案中含有變數除錯資訊”，將嘗試自己的引數匹配演算法，如果發現引數繫結有二義性將丟擲AmbiguousBindingException異常；對於只有一個繫結變數的切入點表示式，而通知方法只接受一個引數，說明繫結引數是明確的，從而能配對成功。
java程式碼：
- @Before(value=" args(param)")
- public void before1(JoinPoint jp, String param) {
- System.out.println("===param:" + param);
- }
- 以上策略失敗將丟擲IllegalArgumentException。
接下來讓我們示例一下組合情況吧：
java程式碼：
- @Before(args(param) && target(bean) && @annotation(secure)",
- argNames="jp,param,bean,secure")
- public void before5(JoinPoint jp, String param,
- IPointcutService pointcutService, Secure secure) {
- ……
- }
該示例的執行步驟如圖6-5所示。
圖6-5 引數自動獲取流程
除了上邊介紹的普通方式，也可以對使用命名切入點自動獲取引數：
java程式碼：
- @Pointcut(value="args(param)", argNames="param")
- private void pointcut1(String param){}
- @Pointcut(value="@annotation(secure)", argNames="secure")
- private void pointcut2(Secure secure){}
- @Before(value = "pointcut1(param) && pointcut2(secure)",
- argNames="param, secure")
- public void before6(JoinPoint jp, String param, Secure secure) {
- ……
- }
自此給通知傳遞引數已經介紹完了，示例程式碼在cn.javass.spring.chapter6.ParameterTest檔案中。
在Spring配置檔案中，所以AOP相關定義必須放在<aop:config>標籤下，該標籤下可以有<aop:pointcut>、<aop:advisor>、<aop:aspect>標籤，配置順序不可變。
- <aop:pointcut>：用來定義切入點，該切入點可以重用；
- <aop:advisor>：用來定義只有一個通知和一個切入點的切面；
- <aop:aspect>：用來定義切面，該切面可以包含多個切入點和通知，而且標籤內部的通知和切入點定義是無序的；和advisor的區別就在此，advisor只包含一個通知和一個切入點。
