Spring AOP是如何運行的

什么是 AOP

AOP(Aspect-Oriented Programming), 即 面向切面編程 , 它與 OOP( Object-Oriented Programming, 面向對象編程) 相輔相成, 提供了與 OOP 不同的抽象軟件結構的視角. 在 OOP 中, 我們以類(class)作為我們的基本單元, 而 AOP 中的基本單元是 Aspect(切面)。

Aspect(切面)

aspect 由 pointcount 和 advice 組成, 它既包含了橫切邏輯的定義, 也包括了連接點的定義. Spring AOP就是負責實施切面的框架, 它將切面所定義的橫切邏輯織入到切面所指定的連接點中. AOP的工作重心在于如何將增強織入目標對象的連接點上, 這里包含兩個工作:

1. 如何通過 pointcut 和 advice 定位到特定的 joinpoint 上。

2. 如何在 advice 中編寫切面代碼。

可以簡單地認為, 使用 @Aspect 注解的類就是切面。

advice(增強)

由 aspect 添加到特定的 join point(即滿足 point cut 規則的 join point) 的一段代碼. 許多 AOP框架, 包括 Spring AOP, 會將 advice 模擬為一個攔截器(interceptor), 并且在 join point 上維護多個 advice, 進行層層攔截. 例如 HTTP 鑒權的實現, 我們可以為每個使用 RequestMapping 標注的方法織入 advice, 當 HTTP 請求到來時, 首先進入到 advice 代碼中, 在這里我們可以分析這個 HTTP 請求是否有相應的權限, 如果有, 則執行 Controller, 如果沒有, 則拋出異常. 這里的 advice 就扮演著鑒權攔截器的角色了。

連接點(join point)

a point during the execution of a program, such as the execution of a method or the handling of an exception. In Spring AOP, a join point always represents a method execution.

程序運行中的一些時間點, 例如一個方法的執行, 或者是一個異常的處理.在 Spring AOP 中, join point 總是方法的執行點, 即只有方法連接點。

切點(point cut)

匹配 join point 的謂詞(a predicate that matches join points). Advice 是和特定的 point cut 關聯的, 并且在 point cut 相匹配的 join point 中執行.在 Spring 中, 所有的方法都可以認為是 joinpoint, 但是我們并不希望在所有的方法上都添加 Advice, 而 pointcut 的作用就是提供一組規則(使用 AspectJ pointcut expression language 來描述) 來匹配joinpoint, 給滿足規則的 joinpoint 添加 Advice。

關于join point 和 point cut 的區別

在 Spring AOP 中, 所有的方法執行都是 join point. 而 point cut 是一個描述信息, 它修飾的是 join point, 通過 point cut, 我們就可以確定哪些 join point 可以被織入 Advice. 因此 join point 和 point cut 本質上就是兩個不同緯度上的東西.advice 是在 join point 上執行的, 而 point cut 規定了哪些 join point 可以執行哪些 advice。

introduction

為一個類型添加額外的方法或字段. Spring AOP 允許我們為 目標對象 引入新的接口(和對應的實現). 例如我們可以使用 introduction 來為一個 bean 實現 IsModified 接口, 并以此來簡化 caching 的實現。

目標對象(Target)

織入 advice 的目標對象. 目標對象也被稱為 advised object.因為 Spring AOP 使用運行時代理的方式來實現 aspect, 因此 adviced object 總是一個代理對象(proxied object)注意, adviced object 指的不是原來的類, 而是織入 advice 后所產生的代理類。

AOP proxy

一個類被 AOP 織入 advice, 就會產生一個結果類, 它是融合了原類和增強邏輯的代理類. 在 Spring AOP 中, 一個 AOP 代理是一個 JDK 動態代理對象或 CGLIB 代理對象。

織入(Weaving)

將 aspect 和其他對象連接起來, 并創建 adviced object 的過程. 根據不同的實現技術, AOP織入有三種方式:

編譯器織入, 這要求有特殊的Java編譯器。

• 類裝載期織入, 這需要有特殊的類裝載器。

• 動態代理織入, 在運行期為目標類添加增強(Advice)生成子類的方式. Spring 采用動態代理織入, 而AspectJ采用編譯器織入和類裝載期織入。

advice 的類型

• before advice, 在 join point 前被執行的 advice. 雖然 before advice 是在 join point 前被執行, 但是它并不能夠阻止 join point 的執行, 除非發生了異常(即我們在 before advice 代碼中, 不能人為地決定是否繼續執行 join point 中的代碼)。

• after return advice, 在一個 join point 正常返回后執行的 advice。

• after throwing advice, 當一個 join point 拋出異常后執行的 advice。

• after(final) advice, 無論一個 join point 是正常退出還是發生了異常, 都會被執行的 advice。

• around advice, 在 join point 前和 joint point 退出后都執行的 advice. 這個是最常用的 advice。

關于 AOP Proxy

Spring AOP 默認使用標準的 JDK 動態代理(dynamic proxy)技術來實現 AOP 代理, 通過它, 我們可以為任意的接口實現代理.如果需要為一個類實現代理, 那么可以使用 CGLIB 代理. 當一個業務邏輯對象沒有實現接口時, 那么Spring AOP 就默認使用 CGLIB 來作為 AOP 代理了. 即如果我們需要為一個方法織入 advice, 但是這個方法不是一個接口所提供的方法, 則此時 Spring AOP 會使用 CGLIB 來實現動態代理. 鑒于此, Spring AOP 建議基于接口編程, 對接口進行 AOP 而不是類。

徹底理解 aspect, join point, point cut, advice

@AspectJ 支持

@AspectJ 是一種使用 Java 注解來實現 AOP 的編碼風格. @AspectJ 風格的 AOP 是 AspectJ Project 在 AspectJ 5 中引入的, 并且 Spring 也支持@AspectJ 的 AOP 風格。

使能 @AspectJ 支持

@AspectJ 可以以 XML 的方式或以注解的方式來使能, 并且不論以哪種方式使能@ASpectJ, 我們都必須保證 aspectjweaver.jar 在 classpath 中。

使用 Java Configuration 方式使能@AspectJ

@Configuration

@EnableAspectJAutoProxypublic class AppConfig {}

使用 XML 方式使能@AspectJ

<aop:aspectj-autoproxy/>

定義 aspect(切面) 

當使用注解 @Aspect 標注一個 Bean 后, 那么 Spring 框架會自動收集這些 Bean, 并添加到 Spring AOP 中, 例如:

@Component@Aspectpublicclass MyTest {
}

注意, 僅僅使用@Aspect 注解, 并不能將一個 Java 對象轉換為 Bean, 因此我們還需要使用類似 @Component 之類的注解.注意, 如果一個 類被@Aspect 標注, 則這個類就不能是其他 aspect 的 advised object 了, 因為使用 @Aspect 后, 這個類就會被排除在 auto-proxying 機制之外。

聲明 pointcut

一個 pointcut 的聲明由兩部分組成:

• 一個方法簽名, 包括方法名和相關參數。

• 一個 pointcut 表達式, 用來指定哪些方法執行是我們感興趣的(即因此可以織入 advice)。

在@AspectJ 風格的 AOP 中, 我們使用一個方法來描述 pointcut, 即:

@Pointcut("execution(* com.xys.service.UserService.*(..))") // 切點表達式private void dataAccessOperation() {} // 切點前面

這個方法必須無返回值.這個方法本身就是 pointcut signature, pointcut 表達式使用@Pointcut 注解指定.上面我們簡單地定義了一個 pointcut, 這個 pointcut 所描述的是: 匹配所有在包 com.xys.service.UserService 下的所有方法的執行。

切點標志符(designator)

AspectJ5 的切點表達式由標志符(designator)和操作參數組成. 如 "execution( greetTo(..))" 的切點表達式, execution 就是 標志符, 而圓括號里的 greetTo(..) 就是操作參數。

execution

匹配 join point 的執行, 例如 "execution(* hello(..))" 表示匹配所有目標類中的 hello() 方法. 這個是最基本的 pointcut 標志符。

within

匹配特定包下的所有 join point, 例如 within(com.xys.*) 表示 com.xys 包中的所有連接點, 即包中的所有類的所有方法。 而 within(com.xys.service.*Service) 表示在 com.xys.service 包中所有以 Service 結尾的類的所有的連接點。

this 與 target

this 的作用是匹配一個 bean, 這個 bean(Spring AOP proxy) 是一個給定類型的實例(instance of). 而 target 匹配的是一個目標對象(target object, 即需要織入 advice 的原始的類), 此對象是一個給定類型的實例(instance of)。

bean

匹配 bean 名字為指定值的 bean 下的所有方法, 例如:

bean(*Service) // 匹配名字后綴為 Service 的 bean 下的所有方法

bean(myService) // 匹配名字為 myService 的 bean 下的所有方法

args

匹配參數滿足要求的的方法. 例如:

@Pointcut("within(com.xys.demo2.*)")public void pointcut2() {


}@Before(value = "pointcut2() && args(name)")public void doSomething(String name){
  logger.info("---page: {}---",
             name);}@Servicepublic class NormalService {    private Logger logger = LoggerFactory.getLogger(getClass());    public void someMethod() {        logger.info("---NormalService: someMethod invoked---");    }    public String test(String name) {        logger.info("---NormalService: test invoked---");        return "服務一切正常";    }}

當 NormalService.test 執行時, 則 advice doSomething 就會執行, test 方法的參數 name 就會傳遞到 doSomething 中。

常用例子:

// 匹配只有一個參數 name 的方法@Before(value = "aspectMethod() && args(name)")
public void doSomething(String name) {
}// 匹配第一個參數為 name 的方法@Before(value = "aspectMethod() && args(name, ..)")
public void doSomething(String name) {
}// 匹配第二個參數為 name 的方法Before(value = "aspectMethod() && args(*, name, ..)")
public void doSomething(String name) {
}

@annotation

匹配由指定注解所標注的方法, 例如:

@Pointcut("@annotation(com.xys.demo1.AuthChecker)")
public void pointcut() {
}

則匹配由注解 AuthChecker 所標注的方法。

常見的切點表達式

匹配方法簽名

// 匹配指定包中的所有的方法
execution(* com.xys.service.*(..))// 匹配當前包中的指定類的所有方法execution(* UserService.*(..))// 匹配指定包中的所有 public 方法execution(public * com.xys.service.*(..))// 匹配指定包中的所有 public 方法, 并且返回值是 int 類型的方法execution(public int com.xys.service.*(..))// 匹配指定包中的所有 public 方法, 并且第一個參數是 String, 返回值是 int 類型的方法execution(public int com.xys.service.*(String name, ..))匹配類型簽名// 匹配指定包中的所有的方法, 但不包括子包within(com.xys.service.*)// 匹配指定包中的所有的方法, 包括子包within(com.xys.service..*)// 匹配當前包中的指定類中的方法within(UserService)// 匹配一個接口的所有實現類中的實現的方法within(UserDao+)匹配 Bean 名字// 匹配以指定名字結尾的 Bean 中的所有方法bean(*Service)切點表達式組合// 匹配以 Service 或 ServiceImpl 結尾的 beanbean(*Service || *ServiceImpl)// 匹配名字以 Service 結尾, 并且在包 com.xys.service 中的 beanbean(*Service) && within(com.xys.service.*)

聲明 advice

advice 是和一個 pointcut 表達式關聯在一起的, 并且會在匹配的 join point 的方法執行的前/后/周圍 運行. pointcut 表達式可以是簡單的一個 pointcut 名字的引用, 或者是完整的 pointcut 表達式. 下面我們以幾個簡單的 advice 為例子, 來看一下一個 advice 是如何聲明的。

Before advice

/**
* @author xiongyongshun 
* @version 1.0 
* @created 16/9/9 13:13
*/@Component@Aspectpublic class BeforeAspectTest {  // 定義一個 Pointcut, 使用 切點表達式函數 來描述對哪些 Join point 使用 advise.  
  @Pointcut("execution(* com.xys.service.UserService.*(..))")
  public void dataAccessOperation() {
  }
}@Component@Aspectpublic class AdviseDefine { 
  // 定義 advise    @Before("com.xys.aspect.PointcutDefine.dataAccessOperation()")
  public void doBeforeAccessCheck(JoinPoint joinPoint) {    System.out.println("*****Before advise, method: " + joinPoint.getSignature().toShortString() + " *****");
  }
}

這里, @Before 引用了一個 pointcut, 即 "com.xys.aspect.PointcutDefine.dataAccessOperation()" 是一個 pointcut 的名字。

如果我們在 advice 在內置 pointcut, 則可以:

@Component@Aspectpublic class AdviseDefine {  // 將 pointcut 和 advice 同時定義
  @Before("within(com.xys.service..*)")  public void doAccessCheck(JoinPoint joinPoint) {
    System.out.println("*****doAccessCheck, Before advise, method: " + joinPoint.getSignature().toShortString() + " *****"); 
  }
}


around advice
around advice 比較特別, 它可以在一個方法的之前之前和之后添加不同的操作, 并且甚至可以決定何時, 如何, 是否調用匹配到的方法.@Component@Aspectpublic class AdviseDefine {  // 定義 advise    @Around("com.xys.aspect.PointcutDefine.dataAccessOperation()")
  public Object doAroundAccessCheck(ProceedingJoinPoint pjp) throws Throwable {
    StopWatch stopWatch = new StopWatch(); 
    stopWatch.start();    // 開始
    Object retVal = pjp.proceed();
    stopWatch.stop(); 
    // 結束
    System.out.println("invoke method: " + pjp.getSignature().getName() + ", elapsed time: " + stopWatch.getTotalTimeMillis());    return retVal;    
  }
}

around advice 和前面的 before advice 差不多, 只是我們把注解 @Before 改為了 @Around 了。