Spring AOP 詳解

時間 2019-11-09

標籤 spring aop 詳解欄目 Spring 简体版

原文原文鏈接

此前對於AOP的使用僅限於聲明式事務，除此以外在實際開發中也沒有遇到過與之相關的問題。最近項目中遇到了如下幾點需求，仔細思考以後，以爲採用AOP 來解決。一方面是爲了以更加靈活的方式來解決問題，另外一方面是藉此機會深刻學習Spring AOP相關的內容。本文是權當本人的本身AOP學習筆記，如下需求不用AOP確定也能解決，至因而否牽強附會，仁者見仁智者見智。spring

對部分函數的調用進行日誌記錄，用於觀察特定問題在運行過程當中的函數調用狀況express
監控部分重要函數，若拋出指定的異常，須要以短信或郵件方式通知相關人員app
金控部分重要函數的執行時間模塊化

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

須要打印日誌的函數分散在各個包中，只能找到全部的函數體，手動添加日誌。然而這些日誌都是臨時的，待問題解決以後應該須要清除打印日誌的代碼，只能再次手動清除^_^!學習
類似1的狀況，須要捕獲異常的地方太多，若是手動添加時想到極可能明天又要手動清除，只能再汗。OK，該需求相對比較固定，屬於長期監控的範疇，並不需求臨時添加後再清除。然而，客戶某天要求，把其中20%的異常改成短信提醒，剩下的80%改用郵件提醒。改之，兩天後，客戶抱怨短信太多，所有改爲郵件提醒...測試
該需求一般用於監控某些函數的執行時間，用以判斷系統執行慢的瓶頸所在。瓶頸被解決以後，煩惱同狀況1spa

終於下定決心，採用AOP來解決！代碼以下：代理

切面類TestAspect日誌

Java代碼

package com.spring.aop;
/**
* 切面
*
*/
public class TestAspect {
public void doAfter(JoinPoint jp) {
System.out.println("log Ending method: "
+ jp.getTarget().getClass().getName() + "."
+ jp.getSignature().getName());
}
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
long time = System.currentTimeMillis();
Object retVal = pjp.proceed();
time = System.currentTimeMillis() - time;
System.out.println("process time: " + time + " ms");
return retVal;
}
public void doBefore(JoinPoint jp) {
System.out.println("log Begining method: "
+ jp.getTarget().getClass().getName() + "."
+ jp.getSignature().getName());
}
public void doThrowing(JoinPoint jp, Throwable ex) {
System.out.println("method " + jp.getTarget().getClass().getName()
+ "." + jp.getSignature().getName() + " throw exception");
System.out.println(ex.getMessage());
}
private void sendEx(String ex) {
//TODO 發送短信或郵件提醒
}
}

Java代碼

package com.spring.service;
/**
* 接口A
*/
public interface AService {
public void fooA(String _msg);
public void barA();
}

Java代碼

package com.spring.service;
/**
*接口A的實現類
*/
public class AServiceImpl implements AService {
public void barA() {
System.out.println("AServiceImpl.barA()");
}
public void fooA(String _msg) {
System.out.println("AServiceImpl.fooA(msg:"+_msg+")");
}
}

Java代碼

package com.spring.service;
/**
* Service類B
*/
public class BServiceImpl {
public void barB(String _msg, int _type) {
System.out.println("BServiceImpl.barB(msg:"+_msg+" type:"+_type+")");
if(_type == 1)
throw new IllegalArgumentException("測試異常");
}
public void fooB() {
System.out.println("BServiceImpl.fooB()");
}
}

ApplicationContext

Java代碼

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-2.5.xsd"
default-autowire="autodetect">
<aop:config>
<aop:aspect id="TestAspect" ref="aspectBean">
<aop:pointcut id="businessService"
expression="execution(* com.spring.service.*.*(..))" />
<aop:before pointcut-ref="businessService" method="doBefore"/>
<aop:after pointcut-ref="businessService" method="doAfter"/>
<aop:around pointcut-ref="businessService" method="doAround"/>
<aop:after-throwing pointcut-ref="businessService" method="doThrowing" throwing="ex"/>
</aop:aspect>
</aop:config>
<bean id="aspectBean" class="com.spring.aop.TestAspect" />
<bean id="aService" class="com.spring.service.AServiceImpl"></bean>
<bean id="bService" class="com.spring.service.BServiceImpl"></bean>
</beans>

測試類AOPTest

Java代碼

public class AOPTest extends AbstractDependencyInjectionSpringContextTests {
private AService aService;
private BServiceImpl bService;
protected String[] getConfigLocations() {
String[] configs = new String[] { "/applicationContext.xml"};
return configs;
}
/**
* 測試正常調用
*/
public void testCall()
{
System.out.println("SpringTest JUnit test");
aService.fooA("JUnit test fooA");
aService.barA();
bService.fooB();
bService.barB("JUnit test barB",0);
}
/**
* 測試After-Throwing
*/
public void testThrow()
{
try {
bService.barB("JUnit call barB",1);
} catch (IllegalArgumentException e) {
}
}
public void setAService(AService service) {
aService = service;
}
public void setBService(BServiceImpl service) {
bService = service;
}
}

運行結果以下：

Java代碼

log Begining method: com.spring.service.AServiceImpl.fooA
AServiceImpl.fooA(msg:JUnit test fooA)
log Ending method: com.spring.service.AServiceImpl.fooA
process time: 0 ms
log Begining method: com.spring.service.AServiceImpl.barA
AServiceImpl.barA()
log Ending method: com.spring.service.AServiceImpl.barA
process time: 0 ms
log Begining method: com.spring.service.BServiceImpl.fooB
BServiceImpl.fooB()
log Ending method: com.spring.service.BServiceImpl.fooB
process time: 0 ms
log Begining method: com.spring.service.BServiceImpl.barB
BServiceImpl.barB(msg:JUnit test barB type:0)
log Ending method: com.spring.service.BServiceImpl.barB
process time: 0 ms
log Begining method: com.spring.service.BServiceImpl.barB
BServiceImpl.barB(msg:JUnit call barB type:1)
log Ending method: com.spring.service.BServiceImpl.barB
method com.spring.service.BServiceImpl.barB throw exception
測試異常

《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代碼

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代碼

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

TestAspect的doAfter方法中就能夠訪問msg參數，但這樣以來 AService中的barA()和BServiceImpl中的barB()就再也不是鏈接點，由於execution(* com.spring.service.*.*(String,..))只配置第一個參數爲String類型的方法。其中，doAfter方法定義以下：

Java代碼

public void doAfter(JoinPoint jp,String msg)

訪問當前的鏈接點

任何通知（Advice）方法能夠將第一個參數定義爲 org.aspectj.lang.JoinPoint 類型。JoinPoint 接口提供了一系列有用的方法，好比 getArgs()（返回方法參數）、getThis()（返回代理對象）、getTarget()（返回目標）、getSignature()（返回正在被通知的方法相關信息）和 toString()（打印出正在被通知的方法的有用信息。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。