Spring Boot實(shí)戰(zhàn)(十一):Spring Boot使用AOP的正確姿勢(shì)

一、為什么需要面向切面編程?

面向?qū)ο缶幊蹋∣OP)的好處是顯而易見的,缺點(diǎn)也同樣明顯。當(dāng)需要為多個(gè)不具有繼承關(guān)系的對(duì)象添加一個(gè)公共的方法的時(shí)候,例如日志記錄、性能監(jiān)控等,如果采用面向?qū)ο缶幊痰姆椒?,需要在每個(gè)對(duì)象里面都添加相同的方法,這樣就產(chǎn)生了較大的重復(fù)工作量和大量的重復(fù)代碼,不利于維護(hù)。面向切面編程(AOP)是面向?qū)ο缶幊痰难a(bǔ)充,簡(jiǎn)單來說就是統(tǒng)一處理某一“切面”的問題的編程思想。如果使用AOP的方式進(jìn)行日志的記錄和處理,所有的日志代碼都集中于一處,不需要再每個(gè)方法里面都去添加,極大減少了重復(fù)代碼。

二、Spring AOP術(shù)語

Spring AOP術(shù)語

通知(Advice)包含了需要用于多個(gè)應(yīng)用對(duì)象的橫切行為,完全聽不懂,沒關(guān)系,通俗一點(diǎn)說就是定義了“什么時(shí)候”和“做什么”。

連接點(diǎn)(Join Point)是程序執(zhí)行過程中能夠應(yīng)用通知的所有點(diǎn)。

切點(diǎn)(Poincut)是定義了在“什么地方”進(jìn)行切入,哪些連接點(diǎn)會(huì)得到通知。顯然,切點(diǎn)一定是連接點(diǎn)。

切面(Aspect)是通知和切點(diǎn)的結(jié)合。通知和切點(diǎn)共同定義了切面的全部?jī)?nèi)容——是什么,何時(shí),何地完成功能。

引入(Introduction)允許我們向現(xiàn)有的類中添加新方法或者屬性。

織入(Weaving)是把切面應(yīng)用到目標(biāo)對(duì)象并創(chuàng)建新的代理對(duì)象的過程,分為編譯期織入、類加載期織入和運(yùn)行期織入。

三、Spring Boot AOP實(shí)戰(zhàn)

3.1 引入依賴

Spring Boot使用AOP需要添加spring-boot-starter-aop依賴,如下:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

不需要再添加aspectjweaver的依賴了,因?yàn)閟pring-boot-starter-aop包含了aspectjweaver,并且版本是較新的版本,如果在添加老版本(如1.5.4)啟動(dòng)會(huì)報(bào)錯(cuò)。


Maven依賴

3.2 編寫用于攔截的bean

直接定義一個(gè)controller,代碼如下:

@RestController
public class AopController {

    @RequestMapping("/hello")
    public String sayHello(){
        System.out.println("hello");
        return "hello";
    }
}

3.3 定義切面

Spring采用@AspectJ注解對(duì)POJO進(jìn)行標(biāo)注,該注解表明該類不僅僅是一個(gè)POJO,還是一個(gè)切面。切面是切點(diǎn)和通知的結(jié)合,那么定義一個(gè)切面就需要編寫切點(diǎn)和通知。在代碼中,只需要添加@Aspect注解即可。

3.3.1 定義切點(diǎn)

切點(diǎn)是通過@Pointcut注解和切點(diǎn)表達(dá)式定義的。

@Pointcut注解可以在一個(gè)切面內(nèi)定義可重用的切點(diǎn)。

由于Spring切面粒度最小是達(dá)到方法級(jí)別,而execution表達(dá)式可以用于明確指定方法返回類型,類名,方法名和參數(shù)名等與方法相關(guān)的部件,并且實(shí)際中,大部分需要使用AOP的業(yè)務(wù)場(chǎng)景也只需要達(dá)到方法級(jí)別即可,因而execution表達(dá)式的使用是最為廣泛的。如圖是execution表達(dá)式的語法:

execution表示在方法執(zhí)行的時(shí)候觸發(fā)。以“”開頭,表明方法返回值類型為任意類型。然后是全限定的類名和方法名,“”可以表示任意類和任意方法。對(duì)于方法參數(shù)列表,可以使用“..”表示參數(shù)為任意類型。如果需要多個(gè)表達(dá)式,可以使用“&&”、“||”和“!”完成與、或、非的操作。

切點(diǎn)表達(dá)式

3.3.2 定義通知

通知有五種類型,分別是:

前置通知(@Before):在目標(biāo)方法調(diào)用之前調(diào)用通知

后置通知(@After):在目標(biāo)方法完成之后調(diào)用通知

環(huán)繞通知(@Around):在被通知的方法調(diào)用之前和調(diào)用之后執(zhí)行自定義的方法

返回通知(@AfterReturning):在目標(biāo)方法成功執(zhí)行之后調(diào)用通知

異常通知(@AfterThrowing):在目標(biāo)方法拋出異常之后調(diào)用通知

代碼中定義了三種類型的通知,使用@Before注解標(biāo)識(shí)前置通知,打印“beforeAdvice...”,使用@After注解標(biāo)識(shí)后置通知,打印“AfterAdvice...”,使用@Around注解標(biāo)識(shí)環(huán)繞通知,在方法執(zhí)行前和執(zhí)行之后分別打印“before”和“after”。這樣一個(gè)切面就定義好了,代碼如下:

@Aspect
@Component
public class AopAdvice {

    @Pointcut("execution (* com.shangguan.aop.controller.*.*(..))")
    public void test() {

    }

    @Before("test()")
    public void beforeAdvice() {
        System.out.println("beforeAdvice...");
    }

    @After("test()")
    public void afterAdvice() {
        System.out.println("afterAdvice...");
    }

    @Around("test()")
    public void aroundAdvice(ProceedingJoinPoint proceedingJoinPoint) {
        System.out.println("before");
        try {
            proceedingJoinPoint.proceed();
        } catch (Throwable t) {
            t.printStackTrace();
        }
        System.out.println("after");
    }

}

3.4 啟動(dòng)測(cè)試

完成之后的代碼結(jié)構(gòu)如圖所示:

代碼結(jié)構(gòu)

運(yùn)行AopApplication,在瀏覽器訪問http://localhost:8080/hello,不出意外,控制臺(tái)輸出如圖所示:

控制臺(tái)輸出結(jié)果
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容