一、概念
AOP(Aspect Oriented Programming):面向切面編程。
面向切面編程(也叫面向方面編程),是目前軟件開發中的一個熱點,也是Spring框架中的一個重要內容。利用AOP可以對業務邏輯的各個部分進行隔離,從而使得業務邏輯各部分之間的耦合度降低,提高程序的可重用性,同時提高了開發的效率。
二、用途
日志記錄,性能統計,安全控制,權限管理,事務處理,異常處理,資源池管理。
三、詳解
注意:代碼請見下篇博文
1. 切面(Aspect)
官方的抽象定義為“一個關注點的模塊化,這個關注點可能會橫切多個對象”,在本例中,“切面”就是類TestAspect所關注的具體行為,例如:AServiceImpl.barA()的調用就是切面TestAspect所關注的行為之一。“切面”在ApplicationContext中<aop:aspect>來配置。
2. 連接點(Joinpoint)
程序執行過程中的某一行為,例如,AServiceImpl.barA()的調用或者BServiceImpl.barB(String _msg, int _type)拋出異常等行為。
3. 通知(Advice)
“切面”對於某個“連接點”所產生的動作,例如,TestAspect中對com.spring.service包下所有類的方法進行日志記錄的動作就是一個Advice。其中,一個“切面”可以包含多個“Advice”,例如TestAspect。Advice共有如下5種類型:
A 前置通知(Before advice) :在某連接點(JoinPoint)之前執行的通知,但這個通知不能阻止連接點前的執行。xml中在<aop:aspect>里面使用<aop:before>元素進行聲明;例如,TestAspect中的doBefore方法。注解中使用@Before聲明;例如,TestAnnotationAspect中的doBefore方法。
B 后通知(After advice) :當某連接點退出的時候執行的通知(不論是正常返回還是異常退出)。xml中在<aop:aspect>里面使用<aop:after>元素進行聲明。例如,TestAspect中的doAfter方法,所以AOPTest中調用BServiceImpl.barB拋出異常時,doAfter方法仍然執行。注解中使用@After聲明。
C 返回后通知(After return advice) :在某連接點正常完成后執行的通知,不包括拋出異常的情況。xml中在<aop:aspect>里面使用<after-returning>元素進行聲明。注解中使用@AfterReturning聲明;
D 環繞通知(Around advice) :包圍一個連接點的通知,類似Web中Servlet規范中的Filter的doFilter方法。可以在方法的調用前后完成自定義的行為,也可以選擇不執行。xml中在<aop:aspect>里面使用<aop:around>元素進行聲明。例如,TestAspect中的doAround方法。注解中使用@Around聲明。
E 拋出異常后通知(After throwing advice) : 在方法拋出異常退出時執行的通知。xml中在<aop:aspect>里面使用<aop:after-throwing>元素進行聲明。例如,TestAspect中的doThrowing方法。注解中使用@AfterThrowing聲明。
通知執行順序:前置通知→環繞通知連接點之前→連接點執行→環繞通知連接點之后→返回通知→后通知
→(如果發生異常)異常通知→后通知
4. 切入點(Pointcut)
匹配連接點的斷言,在AOP中通知和一個切入點表達式關聯。例如,TestAspect中的所有通知所關注的連接點,都由切入點表達式execution(* com.spring.service.*.*(..))來決定。
● 切入點表達式
execution:用於匹配方法執行的連接點;
within:用於匹配指定類型內的方法執行;
this:用於匹配當前AOP代理對象類型的執行方法;注意是AOP代理對象的類型匹配,這樣就可能包括引入接口也類型匹配;注意this中使用的表達式必須是完整類名,不支持通配符;
target:用於匹配當前目標對象類型的執行方法;注意是目標對象的類型匹配,這樣就不包括引入接口也類型匹配;注意target中使用的表達式必須是完整類名,不支持通配符;
args:用於匹配當前執行的方法傳入的參數為指定類型的執行方法;參數類型列表中的參數必須是完整類名,通配符不支持;args屬於動態切入點,這種切入點開銷非常大,非特殊情況最好不要使用;
@within:用於匹配所以持有指定注解類型內的方法;注解類型也必須是完整類名;
@target:用於匹配當前目標對象類型的執行方法,其中目標對象持有指定的注解;注解類型也必須是完整類名;
@args:用於匹配當前執行的方法傳入的參數持有指定注解的執行;注解類型也必須是完整類名;
@annotation:用於匹配當前執行方法持有指定注解的方法;注解類型也必須是完整類名;
bean:Spring AOP擴展的,AspectJ沒有對於指示符,用於匹配特定名稱的Bean對象的執行方法;
reference pointcut:表示引用其他命名切入點,只有注解風格支持,XML風格不支持。
● 匹配語法
- * 匹配任何數量字符;
- .. 匹配任何數量字符的重復,如在類型模式中匹配任何數量子包;而在方法參數模式中匹配任何數量參數。
- + 匹配指定類型的子類型;僅能作為后綴放在類型模式后邊。
例如:
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。
● 匹配種類
A 類
- 注解 類名
注解:可選,類上持有的注解,如@Deprecated;
類名:必填,任何類的完整名稱。
B 方法
- 注解 修飾符 返回值類型 類名 方法名(參數列表) 異常列表
注解:可選,方法上持有的注解,如@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。
C Bean
可以使用Bean的id或name進行匹配,並且可使用通配符“*”。
● 匹配邏輯運算
可以使用且(&&)、或(||)、非(!)來組合切入點表達式。由於在XML中使用“&&”需要使用轉義字符“&&”來代替之,所以很不方便,因此Spring ASP 提供了and、or、not來代替&&、||、!。
● 切入點表達式示例
A 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 |
B within
模式 | 描述 |
within(cn.javass..*) | cn.javass包及子包下的任何方法執行 |
within(cn.javass..IPointcutService+) | cn.javass包或所有子包下IPointcutService類型及子類型的任何方法 |
within(@cn.javass..Secure *) | 持有cn.javass..Secure注解的任何類型的任何方法必須是在目標對象上聲明這個注解,在接口上聲明的對它不起作用 |
C this
模式 | 描述 |
this(cn.javass.spring.chapter6.service.IPointcutService) | 當前AOP對象實現了 IPointcutService接口的任何方法 |
this(cn.javass.spring.chapter6.service.IIntroductionService) | 當前AOP對象實現了 IIntroductionService接口的任何方法也可能是引入接口 |
D target
模式 | 描述 |
target(cn.javass.spring.chapter6.service.IPointcutService) | 當前目標對象(非AOP對象)實現了 IPointcutService接口的任何方法 |
target(cn.javass.spring.chapter6.service.IIntroductionService) | 當前目標對象(非AOP對象) 實現了IIntroductionService 接口的任何方法不可能是引入接口 |
模式 | 描述 |
args (java.io.Serializable,..) | 任何一個以接受“傳入參數類型為 java.io.Serializable” 開頭,且其后可跟任意個任意類型的參數的方法執行,args指定的參數類型是在運行時動態匹配的 |
F @within
模式 | 描述 |
@within cn.javass.spring.chapter6.Secure) | 任何目標對象對應的類型持有Secure注解的類方法;必須是在目標對象上聲明這個注解,在接口上聲明的對它不起作用 |
G @target
模式 | 描述 |
@target (cn.javass.spring.chapter6.Secure) | 任何目標對象持有Secure注解的類方法;必須是在目標對象上聲明這個注解,在接口上聲明的對它不起作用 |
H @args
模式 | 描述 |
@args (cn.javass.spring.chapter6.Secure) | 任何一個只接受一個參數的方法,且方法運行時傳入的參數持有注解 cn.javass.spring.chapter6.Secure;動態切入點,類似於arg指示符; |
I @annotation
模式 | 描述 |
@annotation(cn.javass.spring.chapter6.Secure ) | 當前執行方法上持有注解 cn.javass.spring.chapter6.Secure將被匹配 |
J bean
模式 | 描述 |
bean(*Service) | 匹配所有以Service命名(id或name)結尾的Bean |
K reference pointcut
- @Pointcut(value="bean(*Service)")
- private void pointcut1(){}
- @Pointcut(value="@args(cn.javass.spring.chapter6.Secure)")
- private void pointcut2(){}
- @Pointcut(value="pointcut1()&&pointcut2()")
- private void pointcut3(){}
● 通知方法參數注入
在Spring AOP中,除了execution和bean指示符不能傳遞參數給通知方法,其他指示符都可以將匹配的相應參數或對象自動傳遞給通知方法。例如:
- @Before(value="execution(* test(*)) && args(param)", argNames="param")
- public void before1(String param) {
- System.out.println("===param:" + param);
- }
首先execution(* test(*))匹配任何方法名為test,且有一個任何類型的參數;
args(param)將首先查找通知方法上同名的參數,並在方法執行時(運行時)匹配傳入的參數是使用該同名參數類型,即java.lang.String;如果匹配將把該被通知參數傳遞給通知方法上同名參數。
其他指示符(除了execution和bean指示符)都可以使用這種方式進行參數綁定。
● 綜合示例
- @Before(value="args(param) && target(bean) && @annotation(secure)", argNames="jp,param,bean,secure")
- public void before5(JoinPoint jp, String param,
- IPointcutService pointcutService, Secure secure) {
- ……
- }
除了上邊介紹的普通方式,也可以對使用命名切入點自動獲取參數:
- @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) {
- ……
- }
5. 目標對象(Target Object)
被一個或者多個切面所通知的對象。例如,AServcieImpl和BServiceImpl,當然在實際運行時,Spring AOP采用代理實現,實際AOP操作的是TargetObject的代理對象。
6. AOP代理(AOP Proxy)
在Spring AOP中有兩種代理方式,JDK動態代理和CGLIB代理。默認情況下,TargetObject實現了接口時,則采用JDK動態代理,例如:AServiceImpl;反之,采用CGLIB代理,例如:BServiceImpl。強制使用CGLIB代理需要將 <aop:config>的 proxy-target-class屬性設為true。