此前對於AOP的使用僅限於宣告式事務，除此之外在實際開發中也沒有遇到過與之相關的問題。最近專案中遇到了以下幾點需求，仔細思考之後，覺得采用AOP來解決。一方面是為了以更加靈活的方式來解決問題，另一方面是藉此機會深入學習SpringAOP相關的內容。本文是權當本人的自己AOP學習筆記，以下需求不用AOP肯定也能解決，至於是否牽強附會，仁者見仁智者見智。

1. 對部分函式的呼叫進行日誌記錄，用於觀察特定問題在執行過程中的函式呼叫情況
2. 監控部分重要函式，若丟擲指定的異常，需要以簡訊或郵件方式通知相關人員
3. 金控部分重要函式的執行時間

    事實上，以上需求沒有AOP也能搞定，只是在實現過程中比較鬱悶擺了。

1. 需要列印日誌的函式分散在各個包中，只能找到所有的函式體，手動新增日誌。然而這些日誌都是臨時的，待問題解決之後應該需要清除列印日誌的程式碼，只能再次手動清除^_^!
2. 類似1的情況，需要捕獲異常的地方太多，如果手動新增時想到很可能明天又要手動清除，只能再汗。OK，該需求相對比較固定，屬於長期監控的範疇，並不需求臨時新增後再清除。然而，客戶某天要求，把其中20%的異常改為簡訊提醒，剩下的80%改用郵件提醒。改之，兩天後，客戶抱怨簡訊太多，全部改成郵件提醒...
3. 該需求通常用於監控某些函式的執行時間，用以判斷系統執行慢的瓶頸所在。瓶頸被解決之後，煩惱同情況1

終於下定決心，採用AOP來解決！程式碼如下：

    切面類TestAspect

Java程式碼  

1. package com.spring.aop;  
2. /** 
3.  * 切面 
4.  * 
5.  */
6. publicclass TestAspect {  
7.     publicvoid doAfter(JoinPoint jp) {  
8.         System.out.println("log Ending method: "
9.                 + jp.getTarget().getClass().getName() + "."
10.                 + jp.getSignature().getName());  
11.     }  
12.     public Object doAround(ProceedingJoinPoint pjp) throws Throwable {  
13.         long time = System.currentTimeMillis();  
14.         Object retVal = pjp.proceed();  
15.         time = System.currentTimeMillis() - time;  
16.         System.out.println("process time: "
     + time + " ms");  
17.         return retVal;  
18.     }  
19.     publicvoid doBefore(JoinPoint jp) {  
20.         System.out.println("log Begining method: "
21.                 + jp.getTarget().getClass().getName() + "."
22.                 + jp.getSignature().getName());  
23.     }  
24.     publicvoid doThrowing(JoinPoint jp, Throwable ex) {  
25.         System.out.println("method " + jp.getTarget().getClass().getName()  
26.                 + "." + jp.getSignature().getName() + " throw exception");  
27.         System.out.println(ex.getMessage());  
28.     }  
29.     privatevoid sendEx(String ex) {  
30.         //TODO 傳送簡訊或郵件提醒
31.     }  
32. }   

Java程式碼  

1. package com.spring.service;  
2. /** 
3.  * 介面A 
4.  */
5. publicinterface AService {  
6.     publicvoid fooA(String _msg);  
7.     publicvoid barA();  
8. }  

  Java程式碼  

1. package com.spring.service;  
2. /** 
3.  *介面A的實現類 
4.  */
5. publicclass AServiceImpl implements AService {  
6.     publicvoid barA() {  
7.         System.out.println("AServiceImpl.barA()");  
8.     }  
9.     publicvoid fooA(String _msg) {  
10.         System.out.println("AServiceImpl.fooA(msg:"+_msg+")");  
11.     }  
12. }  

Java程式碼  

1. package com.spring.service;  
2. /** 
3.  *   Service類B 
4.  */
5. publicclass BServiceImpl {  
6.     publicvoid barB(String _msg, int _type) {  
7.         System.out.println("BServiceImpl.barB(msg:"+_msg+" type:"+_type+")");  
8.         if(_type == 1)  
9.             thrownew IllegalArgumentException("測試異常");  
10.     }  
11.     publicvoid fooB() {  
12.         System.out.println("BServiceImpl.fooB()");  
13.     }  
14. }  

 

    ApplicationContext

Java程式碼  

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans"
3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.     xmlns:aop="http://www.springframework.org/schema/aop"
5.     xsi:schemaLocation="  
6.             http://www.springframework.org/schema/beans
7.             http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
8.             http://www.springframework.org/schema/aop
9.             http://www.springframework.org/schema/aop/spring-aop-2.5.xsd"
10.     default-autowire="autodetect">  
11.     <aop:config>  
12.         <aop:aspect id="TestAspect" ref="aspectBean">  
13.             <!--配置com.spring.service包下所有類或介面的所有方法-->  
14.             <aop:pointcut id="businessService"
15.                 expression="execution(* com.spring.service.*.*(..))" />  
16.             <aop:before pointcut-ref="businessService" method="doBefore"/>  
17.             <aop:after pointcut-ref="businessService" method="doAfter"/>  
18.             <aop:around pointcut-ref="businessService" method="doAround"/>  
19.             <aop:after-throwing pointcut-ref="businessService" method="doThrowing" throwing="ex"/>  
20.         </aop:aspect>  
21.     </aop:config>  
22.     <bean id="aspectBean"class="com.spring.aop.TestAspect" />  
23.     <bean id="aService"class="com.spring.service.AServiceImpl"></bean>  
24.     <bean id="bService"class="com.spring.service.BServiceImpl"></bean>  
25. </beans>  

    測試類AOPTest

Java程式碼  

1. publicclass AOPTest extends AbstractDependencyInjectionSpringContextTests {  
2.     private AService aService;  
3.     private BServiceImpl bService;  
4.     protected String[] getConfigLocations() {  
5.         String[] configs = new String[] { "/applicationContext.xml"};  
6.         return configs;  
7.     }  
8.     /** 
9.      * 測試正常呼叫 
10.      */
11.     publicvoid testCall()  
12.     {  
13.         System.out.println("SpringTest JUnit test");  
14.         aService.fooA("JUnit test fooA");  
15.         aService.barA();  
16.         bService.fooB();  
17.         bService.barB("JUnit test barB",0);  
18.     }  
19.     /** 
20.      * 測試After-Throwing 
21.      */
22.     publicvoid testThrow()  
23.     {  
24.         try {  
25.             bService.barB("JUnit call barB",1);  
26.         } catch (IllegalArgumentException e) {  
27.         }  
28.     }  
29.     publicvoid setAService(AService service) {  
30.         aService = service;  
31.     }  
32.     publicvoid setBService(BServiceImpl service) {  
33.         bService = service;  
34.     }  
35. }  

    執行結果如下：

Java程式碼  

1. log Begining method: com.spring.service.AServiceImpl.fooA  
2. AServiceImpl.fooA(msg:JUnit test fooA)  
3. log Ending method: com.spring.service.AServiceImpl.fooA  
4. process time: 0 ms  
5. log Begining method: com.spring.service.AServiceImpl.barA  
6. AServiceImpl.barA()  
7. log Ending method: com.spring.service.AServiceImpl.barA  
8. process time: 0 ms  
9. log Begining method: com.spring.service.BServiceImpl.fooB  
10. BServiceImpl.fooB()  
11. log Ending method: com.spring.service.BServiceImpl.fooB  
12. process time: 0 ms  
13. log Begining method: com.spring.service.BServiceImpl.barB  
14. BServiceImpl.barB(msg:JUnit test barB type:0)  
15. log Ending method: com.spring.service.BServiceImpl.barB  
16. process time: 0 ms  
17. log Begining method: com.spring.service.BServiceImpl.barB  
18. BServiceImpl.barB(msg:JUnit call barB type:1)  
19. log Ending method: com.spring.service.BServiceImpl.barB  
20. method com.spring.service.BServiceImpl.barB throw exception  
21. 測試異常  

 

    《Spring參考手冊》中定義了以下幾個AOP的重要概念，結合以上程式碼分析如下：

• 切面（Aspect）：官方的抽象定義為“一個關注點的模組化，這個關注點可能會橫切多個物件”，在本例中，“切面”就是類TestAspect所關注的具體行為，例如，AServiceImpl.barA()的呼叫就是切面TestAspect所關注的行為之一。“切面”在ApplicationContext中<aop:aspect>來配置。
• 連線點（Joinpoint）：程式執行過程中的某一行為，例如，AServiceImpl.barA()的呼叫或者BServiceImpl.barB(String _msg, int _type)丟擲異常等行為。
• 通知（Advice）：“切面”對於某個“連線點”所產生的動作，例如，TestAspect中對com.spring.service包下所有類的方法進行日誌記錄的動作就是一個Advice。其中，一個“切面”可以包含多個“Advice”，例如TestAspect
• 切入點（Pointcut）：匹配連線點的斷言，在AOP中通知和一個切入點表示式關聯。例如，TestAspect中的所有通知所關注的連線點，都由切入點表示式execution(* com.spring.service.*.*(..))來決定
• 目標物件（Target Object）：被一個或者多個切面所通知的物件。例如，AServcieImpl和BServiceImpl，當然在實際執行時，Spring AOP採用代理實現，實際AOP操作的是TargetObject的代理物件。
• AOP代理（AOP Proxy）在Spring AOP中有兩種代理方式，JDK動態代理和CGLIB代理。預設情況下，TargetObject實現了介面時，則採用JDK動態代理，例如，AServiceImpl；反之，採用CGLIB代理，例如，BServiceImpl。強制使用CGLIB代理需要將 <aop:config> 的 proxy-target-class 屬性設為true

       通知（Advice）型別

• 前置通知（Before advice）：在某連線點（JoinPoint）之前執行的通知，但這個通知不能阻止連線點前的執行。ApplicationContext中在<aop:aspect>裡面使用<aop:before>元素進行宣告。例如，TestAspect中的doBefore方法
• 後通知（After advice）：當某連線點退出的時候執行的通知（不論是正常返回還是異常退出）。ApplicationContext中在<aop:aspect>裡面使用<aop:after>元素進行宣告。例如，TestAspect中的doAfter方法，所以AOPTest中呼叫BServiceImpl.barB丟擲異常時，doAfter方法仍然執行
• 返回後通知（After return advice）：在某連線點正常完成後執行的通知，不包括丟擲異常的情況。ApplicationContext中在<aop:aspect>裡面使用<after-returning>元素進行宣告。
• 環繞通知（Around advice）：包圍一個連線點的通知，類似Web中Servlet規範中的Filter的doFilter方法。可以在方法的呼叫前後完成自定義的行為，也可以選擇不執行。ApplicationContext中在<aop:aspect>裡面使用<aop:around>元素進行宣告。例如，TestAspect中的doAround方法。
• 丟擲異常後通知（After throwing advice）： 在方法丟擲異常退出時執行的通知。 ApplicationContext中在<aop:aspect>裡面使用<aop:after-throwing>元素進行宣告。例如，TestAspect中的doThrowing方法。

       切入點表示式

• 通常情況下，表示式中使用”execution“就可以滿足大部分的要求。表示式格式如下：

Java程式碼  

1. execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern) throws-pattern?)  

modifiers-pattern：方法的操作許可權

ret-type-pattern：返回值

declaring-type-pattern：方法所在的包

name-pattern：方法名

parm-pattern：引數名

throws-pattern：異常

其中，除ret-type-pattern和name-pattern之外，其他都是可選的。上例中，execution(* com.spring.service.*.*(..))表示com.spring.service包下，返回值為任意型別；方法名任意；引數不作限制的所有方法。

• 通知引數

可以通過args來繫結引數，這樣就可以在通知（Advice）中訪問具體引數了。例如，<aop:aspect>配置如下

Java程式碼  

1. <aop:config>  
2.     <aop:aspect id="TestAspect" ref="aspectBean">  
3.         <aop:pointcut id="businessService"
4.             expression="execution(* com.spring.service.*.*(String,..)) and args(msg,..)" />  
5.             <aop:after pointcut-ref="businessService" method="doAfter"/>  
6.     </aop:aspect>  
7. </aop:config>  

TestAspect的doAfter方法中就可以訪問msg引數，但這樣以來AService中的barA()和BServiceImpl中的barB()就不再是連線點，因為execution(* com.spring.service.*.*(String,..))只配置第一個引數為String型別的方法。其中，doAfter方法定義如下：

Java程式碼  

1. publicvoid doAfter(JoinPoint jp,String msg)  

•   訪問當前的連線點

任何通知（Advice）方法可以將第一個引數定義為 org.aspectj.lang.JoinPoint 型別。JoinPoint 介面提供了一系列有用的方法， 比如 getArgs()（返回方法引數）、getThis()（返回代理物件）、getTarget()（返回目標）、getSignature()（返回正在被通知的方法相關資訊）和 toString()（打印出正在被通知的方法的有用資訊。