Spring AOP看這篇就夠了

點擊上方 IT牧場 ，選擇 置頂或者星標技術乾貨每日送達！

來源：sf.gg/a/1190000007469968

基本知識

其實, 接觸了這麼久的 AOP, 我感覺, AOP 給人難以理解的一個關鍵點是它的概念比較多, 而且坑爹的是, 這些概念經過了中文翻譯後, 變得面目全非, 相同的一個術語, 在不同的翻譯下, 含義總有着各種莫名其妙的差別. 鑑於此, 我在本章的開頭, 着重爲爲大家介紹一個 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

看完了上面的理論部分知識, 我相信還是會有不少朋友感覺到 AOP 的概念還是很模糊, 對 AOP 中的各種概念理解的還不是很透徹. 其實這很正常, 因爲 AOP 中的概念是在是太多了, 我當時也是花了老大勁才梳理清楚的. 下面我以一個簡單的例子來比喻一下 AOP 中 aspect, jointpoint, pointcut 與 advice 之間的關係.

讓我們來假設一下, 從前有一個叫爪哇的小縣城, 在一個月黑風高的晚上, 這個縣城中發生了命案. 作案的兇手十分狡猾, 現場沒有留下什麼有價值的線索. 不過萬幸的是, 剛從隔壁回來的老王恰好在這時候無意中發現了兇手行兇的過程, 但是由於天色已晚, 加上兇手蒙着面, 老王並沒有看清兇手的面目, 只知道兇手是個男性, 身高約七尺五寸. 爪哇縣的縣令根據老王的描述, 對守門的士兵下命令說: 凡是發現有身高七尺五寸的男性, 都要抓過來審問. 士兵當然不敢違背縣令的命令, 只好把進出城的所有符合條件的人都抓了起來.

來讓我們看一下上面的一個小故事和 AOP 到底有什麼對應關係. 首先我們知道, 在 Spring AOP 中 join point 指代的是所有方法的執行點, 而 point cut 是一個描述信息, 它修飾的是 join point, 通過 point cut, 我們就可以確定哪些 join point 可以被織入 Advice. 對應到我們在上面舉的例子, 我們可以做一個簡單的類比, join point 就相當於 爪哇的小縣城裏的百姓 , point cut 就相當於 老王所做的指控, 即兇手是個男性, 身高約七尺五寸 , 而 advice 則是施加在符合老王所描述的嫌疑人的動作: 抓過來審問 . 爲什麼可以這樣類比呢?

• join point --> 爪哇的小縣城裏的百姓: 因爲根據定義, join point 是所有可能被織入 advice 的候選的點, 在 Spring AOP中, 則可以認爲所有方法執行點都是 join point. 而在我們上面的例子中, 命案發生在小縣城中, 按理說在此縣城中的所有人都有可能是嫌疑人.
• point cut --> 男性, 身高約七尺五寸: 我們知道, 所有的方法(joint point) 都可以織入 advice, 但是我們並不希望在所有方法上都織入 advice, 而 pointcut 的作用就是提供一組規則來匹配joinpoint, 給滿足規則的 joinpoint 添加 advice. 同理, 對於縣令來說, 他再昏庸, 也知道不能把縣城中的所有百姓都抓起來審問, 而是根據 兇手是個男性, 身高約七尺五寸, 把符合條件的人抓起來. 在這裏  兇手是個男性, 身高約七尺五寸 就是一個修飾謂語, 它限定了兇手的範圍, 滿足此修飾規則的百姓都是嫌疑人, 都需要抓起來審問.
• advice --> 抓過來審問, advice 是一個動作, 即一段 Java 代碼, 這段 Java 代碼是作用於 point cut 所限定的那些 join point 上的. 同理, 對比到我們的例子中,  抓過來審問 這個動作就是對作用於那些滿足  男性, 身高約七尺五寸 的 爪哇的小縣城裏的百姓.
• aspect: aspect 是 point cut 與 advice 的組合, 因此在這裏我們就可以類比:  "根據老王的線索, 凡是發現有身高七尺五寸的男性, 都要抓過來審問" 這一整個動作可以被認爲是一個 aspect.

---

或則我們也可以從語法的角度來簡單類比一下. 我們在學英語時, 經常會接觸什麼 定語, 被動句 之類的概念, 那麼可以做一個不嚴謹的類比, 即 joinpoint 可以認爲是一個 賓語, 而 pointcut 則可以類比爲修飾 joinpoint 的定語, 那麼整個 aspect 就可以描述爲: 滿足 pointcut 規則的 joinpoint 會被添加相應的 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
@EnableAspectJAutoProxy
public class AppConfig {
}

使用 XML 方式使能@AspectJ

<aop:aspectj-autoproxy/>

定義 aspect(切面)

當使用註解 @Aspect 標註一個 Bean 後, 那麼 Spring 框架會自動收集這些 Bean, 並添加到 Spring AOP 中, 例如:

@Component
@Aspect
public class 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);
}
@Service
public 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 結尾的 bean
bean(*Service || *ServiceImpl)

// 匹配名字以 Service 結尾, 並且在包 com.xys.service 中的 bean
bean(*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
@Aspect
public class BeforeAspectTest {
    // 定義一個 Pointcut, 使用 切點表達式函數 來描述對哪些 Join point 使用 advise.
    @Pointcut("execution(* com.xys.service.UserService.*(..))")
    public void dataAccessOperation() {
    }
}
@Component
@Aspect
public 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
@Aspect
public 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
@Aspect
public 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 了.

乾貨分享

最近將個人學習筆記整理成冊，使用PDF分享。關注我，回覆如下代碼，即可獲得百度盤地址，無套路領取！

•001：《Java併發與高併發解決方案》學習筆記；•002：《深入JVM內核——原理、診斷與優化》學習筆記；•003：《Java面試寶典》•004：《Docker開源書》•005：《Kubernetes開源書》•006：《DDD速成（領域驅動設計速成）》•007：全部•008：加技術羣討論

近期熱文

•LinkedBlockingQueue vs ConcurrentLinkedQueue•解讀Java 8 中爲併發而生的 ConcurrentHashMap•Redis性能監控指標彙總•最全的DevOps工具集合，再也不怕選型了！•微服務架構下，解決數據庫跨庫查詢的一些思路•聊聊大廠面試官必問的 MySQL 鎖機制

關注我

喜歡就點個"在看"唄^_^

本文分享自微信公衆號 - IT牧場（itmuch_com）。
如有侵權，請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”，歡迎正在閱讀的你也加入，一起分享。