Spring AspectJ切入點語法詳解

 

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可能會在以后進行擴展。

 

2、命名及匿名切入點

　　命名切入點可以被其他切入點引用，而匿名切入點是不可以的。只有@AspectJ支持命名切入點，而Schema風格不支持命名切入點。

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

 

 

3、類型匹配語法　

　　首先讓我們來了解下AspectJ類型匹配的通配符：

         *：匹配任何數量字符；

         ..：匹配任何數量字符的重復，如在類型模式中匹配任何數量子包；而在方法參數模式中匹配任何數量參數。

         +：匹配指定類型的子類型；僅能作為后綴放在類型模式后邊。

　　例如：

ava.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。

 

4、組合切入點表達式

　　  AspectJ使用 且（&&）、或（||）、非（！）來組合切入點表達式。

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

　　　

切入點使用示例

 1、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目前測試不能正常工作

 

 

 

b、within：使用“within(類型表達式)”匹配指定類型內的方法執行；

 

模式	描述
within(cn.javass..*)	cn.javass包及子包下的任何方法執行
within(cn.javass..IPointcutService+)	cn.javass包或所有子包下IPointcutService類型及子類型的任何方法
within(@cn.javass..Secure *)	持有cn.javass..Secure注解的任何類型的任何方法必須是在目標對象上聲明這個注解，在接口上聲明的對它不起作用

 

 

c、this：使用“this(類型全限定名)”匹配當前AOP代理對象類型的執行方法；注意是AOP代理對象的類型匹配，這樣就可能包括引入接口方法也可以匹配；注意this中使用的表達式必須是類型全限定名，不支持通配符；

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

 

d、target ：使用“target(類型全限定名)”匹配當前目標對象類型的執行方法；注意是目標對象的類型匹配，這樣就不包括引入接口也類型匹配；注意target中使用的表達式必須是類型全限定名，不支持通配符；

模式	描述
target(cn.javass.spring.chapter6.service.IPointcutService)	當前目標對象（非AOP對象）實現了 IPointcutService接口的任何方法
target(cn.javass.spring.chapter6.service.IIntroductionService)	當前目標對象（非AOP對象） 實現了IIntroductionService 接口的任何方法不可能是引入接口

 

e、args：使用“args(參數類型列表)”匹配當前執行的方法傳入的參數為指定類型的執行方法；注意是匹配傳入的參數類型，不是匹配方法簽名的參數類型；參數類型列表中的參數必須是類型全限定名，通配符不支持；args屬於動態切入點，這種切入點開銷非常大，非特殊情況最好不要使用；

模式	描述
args (java.io.Serializable,..)	任何一個以接受“傳入參數類型為 java.io.Serializable” 開頭，且其后可跟任意個任意類型的參數的方法執行，args指定的參數類型是在運行時動態匹配的

 

 

 

 

 

 

f、@within：使用“@within(注解類型)”匹配所以持有指定注解類型內的方法；注解類型也必須是全限定類型名；

模式	描述
@within cn.javass.spring.chapter6.Secure)	任何目標對象對應的類型持有Secure注解的類方法； 必須是在目標對象上聲明這個注解，在接口上聲明的對它不起作用

 

 

 

 

 

 

g、@target：使用“@target(注解類型)”匹配當前目標對象類型的執行方法，其中目標對象持有指定的注解；注解類型也必須是全限定類型名； 

 

模式	描述
@target (cn.javass.spring.chapter6.Secure)	任何目標對象持有Secure注解的類方法； 必須是在目標對象上聲明這個注解，在接口上聲明的對它不起作用

 

 

 

 

 

 

h、@args：使用“@args(注解列表)”匹配當前執行的方法傳入的參數持有指定注解的執行；注解類型也必須是全限定類型名；

模式	描述
@args (cn.javass.spring.chapter6.Secure)	任何一個只接受一個參數的方法，且方法運行時傳入的參數持有注解 cn.javass.spring.chapter6.Secure；動態切入點，類似於arg指示符；

 

 

 

 

 

 

i、@annotation：使用“@annotation(注解類型)”匹配當前執行方法持有指定注解的方法；注解類型也必須是全限定類型名；

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

 

 

 

 

 

j、bean：使用“bean(Bean id或名字通配符)”匹配特定名稱的Bean對象的執行方法；Spring ASP擴展的，在AspectJ中無相應概念；

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

 

k、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文件中，需要時請參考該文件。

 

4、通知參數

　　前邊章節已經介紹了聲明通知，但如果想獲取被被通知方法參數並傳遞給通知方法，該如何實現呢？接下來我們將介紹兩種獲取通知參數的方式。

• 使用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文件中沒生成變量調試信息是獲取不到方法參數名字的。

所以我們可以使用策略來確定參數名：

1. 如果我們通過“argNames”屬性指定了參數名，那么就是要我們指定的；

Java代碼

@Before(value=" args(param)", argNames="param") //明確指定了  
public void before1(String param) {  
    System.out.println("===param:" + param);  
} 

1. 如果第一個參數類型是JoinPoint、ProceedingJoinPoint或JoinPoint.StaticPart類型，應該從“argNames”屬性省略掉該參數名（可選，寫上也對），這些類型對象會自動傳入的，但必須作為第一個參數；

 

java代碼：

@Before(value=" args(param)", argNames="param") //明確指定了  
public void before1(JoinPoint jp, String param) {  
    System.out.println("===param:" + param);  
}  

1. 如果“class文件中含有變量調試信息”將使用這些方法簽名中的參數名來確定參數名；

 

java代碼：

@Before(value=" args(param)") //不需要argNames了  
public void before1(JoinPoint jp, String param) {  
    System.out.println("===param:" + param);  
}  

1. 如果沒有“class文件中含有變量調試信息”，將嘗試自己的參數匹配算法，如果發現參數綁定有二義性將拋出AmbiguousBindingException異常；對於只有一個綁定變量的切入點表達式，而通知方法只接受一個參數，說明綁定參數是明確的，從而能配對成功。

 

java代碼：

@Before(value=" args(param)")   
public void before1(JoinPoint jp, String param) {  
    System.out.println("===param:" + param);  
}  

1. 以上策略失敗將拋出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) {  
……  
}  

 

 該示例的執行步驟如圖所示。

 

除了上邊介紹的普通方式，也可以對使用命名切入點自動獲取參數：

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只包含一個通知和一個切入點。