Spring Boot使用AOP的正確姿勢


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

面向對象編程(OOP)的好處是顯而易見的,缺點也同樣明顯。當需要為多個不具有繼承關系的對象添加一個公共的方法的時候,例如日志記錄、性能監控等,如果采用面向對象編程的方法,需要在每個對象里面都添加相同的方法,這樣就產生了較大的重復工作量和大量的重復代碼,不利於維護。面向切面編程(AOP)是面向對象編程的補充,簡單來說就是統一處理某一“切面”的問題的編程思想。如果使用AOP的方式進行日志的記錄和處理,所有的日志代碼都集中於一處,不需要再每個方法里面都去添加,極大減少了重復代碼。

二、Spring AOP術語

Spring AOP術語

通知(Advice)包含了需要用於多個應用對象的橫切行為,完全聽不懂,沒關系,通俗一點說就是定義了“什么時候”和“做什么”。

連接點(Join Point)是程序執行過程中能夠應用通知的所有點。

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

切面(Aspect)是通知和切點的結合。通知和切點共同定義了切面的全部內容——是什么,何時,何地完成功能。

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

織入(Weaving)是把切面應用到目標對象並創建新的代理對象的過程,分為編譯期織入、類加載期織入和運行期織入。

三、Spring Boot AOP實戰

3.1 引入依賴

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

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

不需要再添加aspectjweaver的依賴了,因為spring-boot-starter-aop包含了aspectjweaver,並且版本是較新的版本,如果在添加老版本(如1.5.4)啟動會報錯。
Maven依賴

3.2 編寫用於攔截的bean

直接定義一個controller,代碼如下:

@RestController
public class AopController {

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

3.3 定義切面

Spring采用@AspectJ注解對POJO進行標注,該注解表明該類不僅僅是一個POJO,還是一個切面。切面是切點和通知的結合,那么定義一個切面就需要編寫切點和通知。在代碼中,只需要添加@Aspect注解即可。

3.3.1 定義切點

切點是通過@Pointcut注解和切點表達式定義的。

@Pointcut注解可以在一個切面內定義可重用的切點。

由於Spring切面粒度最小是達到方法級別,而execution表達式可以用於明確指定方法返回類型,類名,方法名和參數名等與方法相關的部件,並且實際中,大部分需要使用AOP的業務場景也只需要達到方法級別即可,因而execution表達式的使用是最為廣泛的。如圖是execution表達式的語法:

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

切點表達式

3.3.2 定義通知

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

前置通知(@Before):在目標方法調用之前調用通知

后置通知(@After):在目標方法完成之后調用通知

環繞通知(@Around):在被通知的方法調用之前和調用之后執行自定義的方法

返回通知(@AfterReturning):在目標方法成功執行之后調用通知

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

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

@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 啟動測試

完成之后的代碼結構如圖所示:

代碼結構

運行AopApplication,在瀏覽器訪問http://localhost:8080/hello,不出意外,控制台輸出如圖所示:

控制台輸出結果


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM