[[346655]]

前言

公司這兩個月啟動了全新的項目，項目排期滿滿當當，不過該學習還是要學習。這不，給公司搭項目的時候，。

本文內容重點：

• 問題描述
• Spring AOP執行順序
• 探究順序錯誤的真相
• 代碼驗證
• 結論

問題描述

公司新項目需要搭建一個新的前后分離HTTP服務，我選擇了目前比較熟悉的SpringBoot Web來快速搭建一個可用的系統。

魯迅說過，不要隨便升級已經穩定使用的版本。我偏不信這個邪，仗著自己用了這么久Spring，怎么能不沖呢。不說了，直接引入了最新的SprinBoot 2.3.4.RELEASE版本，開始給項目搭架子。

起初，大多數的組件引入都一切順利，本以為就要大功告成了，沒想到在搭建日志切面時栽了跟頭。

作為一個接口服務，為了方便查詢接口調用情況和定位問題，一般都會將請求日志打印出來，而Spring的AOP作為切面支持，完美的切合了日志記錄的需求。

之前的項目中，運行正確的切面日志記錄效果如下圖：

 

可以看到圖內的一次方法調用，會輸出請求url，出入參，以及請求IP等等，之前為了好看，還加入了分割線。

我把這個實現類放入新項目中，執行出來卻是這樣的：

 

我揉了揉眼睛，仔細看了看復制過來的老代碼，精簡版如下：

/** 
 * 在切點之前織入 
 * @param joinPoint 
 * @throws Throwable 
 */ 
@Before("webLog()") 
public void doBefore(JoinPoint joinPoint) throws Throwable { 
    // 開始打印請求日志 
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); 
    HttpServletRequest request = attributes.getRequest(); 
 
    // 初始化traceId 
    initTraceId(request); 
 
    // 打印請求相關參數 
    LOGGER.info("========================================== Start =========================================="); 
    // 打印請求 url 
    LOGGER.info("URL            : {}", request.getRequestURL().toString()); 
    // 打印 Http method 
    LOGGER.info("HTTP Method    : {}", request.getMethod()); 
    // 打印調用 controller 的全路徑以及執行方法 
    LOGGER.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName()); 
    // 打印請求的 IP 
    LOGGER.info("IP             : {}", IPAddressUtil.getIpAdrress(request)); 
    // 打印請求入參 
    LOGGER.info("Request Args   : {}", joinPoint.getArgs()); 
} 
 
/** 
 * 在切點之后織入 
 * @throws Throwable 
 */ 
@After("webLog()") 
public void doAfter() throws Throwable { 
    LOGGER.info("=========================================== End ==========================================="); 
} 
 
/** 
 * 環繞 
 * @param proceedingJoinPoint 
 * @return 
 * @throws Throwable 
 */ 
@Around("webLog()") 
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable { 
    long startTime = System.currentTimeMillis(); 
    Object result = proceedingJoinPoint.proceed(); 
    // 打印出參 
    LOGGER.info("Response Args  : {}", result); 
    // 執行耗時 
    LOGGER.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime); 
    return result; 
} 

代碼感覺完全沒有問題，難道新版本的SpringBoot出Bug了。

顯然，成熟的框架不會在這種大方向上犯錯誤，那會不會是新版本的SpringBoot把@After和@Around的順序反過來了?

其實事情也沒有那么簡單。

Spring AOP執行順序

我們先來回顧下Spring AOP執行順序。

我們在網上查找關于SpringAop執行順序的的資料，大多數時候，你會查到如下的答案：

正常情況

 

異常情況

 

多個切面的情況

 

所以@Around理應在@After之前，但是在SprinBoot 2.3.4.RELEASE版本中，@Around切切實實執行在了@After之后。

當我嘗試切換回2.2.5.RELEASE版本后，執行順序又回到了@Around-->@After

探究順序錯誤的真相

既然知道了是SpringBoot版本升級導致的問題(或者說順序變化)，那么就要來看看究竟是哪個庫對AOP執行的順序進行了變動，畢竟，SpringBoot只是“形”，真正的內核在Spring。

我們打開pom.xml文件，使用插件查看spring-aop的版本，發現SpringBoot 2.3.4.RELEASE 版本使用的AOP是spring-aop-5.2.9.RELEASE。

而2.2.5.RELEASE對應的是spring-aop-5.2.4.RELEASE

于是我去官網搜索文檔，不得不說Spring由于過于龐大，官網的文檔已經到了冗雜的地步，不過最終還是找到了：

https://docs.spring.io/spring-framework/docs/5.2.9.RELEASE/spring-framework-reference/core.html#aop-ataspectj-advice-ordering

 

As of Spring Framework 5.2.7, advice methods defined in the same @Aspect class that need to run at the same join point are assigned precedence based on their advice type in the following order, from highest to lowest precedence: @Around, @Before, @After, @AfterReturning, @AfterThrowing.

我粗淺的翻譯一下重點：

從Spring5.2.7開始，在相同@Aspect類中，通知方法將根據其類型按照從高到低的優先級進行執行：@Around，@Before ，@After，@AfterReturning，@AfterThrowing。

這樣看其實對比不明顯，我們再回到老版本，也就是2.2.5.RELEASE對應的spring-aop-5.2.4.RELEASE，當時的文檔是這么寫的：

What happens when multiple pieces of advice all want to run at the same join point? Spring AOP follows the same precedence rules as AspectJ to determine the order of advice execution. The highest precedence advice runs first "on the way in" (so, given two pieces of before advice, the one with highest precedence runs first). "On the way out" from a join point, the highest precedence advice runs last (so, given two pieces of after advice, the one with the highest precedence will run second).

簡單翻譯：在相同@Aspect類中Spring AOP遵循與AspectJ相同的優先級規則來確定advice執行的順序。

再挖深一點，那么AspectJ的優先級規則是什么樣的?

我找了AspectJ的文檔：

https://www.eclipse.org/aspectj/doc/next/progguide/semantics-advice.html

 

At a particular join point, advice is ordered by precedence.

A piece of around advice controls whether advice of lower precedence will run by calling proceed. The call to proceed will run the advice with next precedence, or the computation under the join point if there is no further advice.

A piece of before advice can prevent advice of lower precedence from running by throwing an exception. If it returns normally, however, then the advice of the next precedence, or the computation under the join pint if there is no further advice, will run.

Running after returning advice will run the advice of next precedence, or the computation under the join point if there is no further advice. Then, if that computation returned normally, the body of the advice will run.

Running after throwing advice will run the advice of next precedence, or the computation under the join point if there is no further advice. Then, if that computation threw an exception of an appropriate type, the body of the advice will run.

Running after advice will run the advice of next precedence, or the computation under the join point if there is no further advice. Then the body of the advice will run.

大伙又要說了，哎呀太長不看!簡短地說，Aspectj的規則就是上面我們能夠在網上查閱到的順序圖展示的那樣，依舊是老的順序。

代碼驗證

我把業務邏輯從代碼中刪除，只驗證下這幾個advice的執行順序：

/** 
 * 日志切面 
 */ 
@Aspect 
@Component 
public class WebLogAspect { 
 
    private final static Logger LOGGER = LoggerFactory.getLogger(WebLogAspect.class); 
 
    /** 以 controller 包下定義的所有請求為切入點 */ 
    @Pointcut("execution(public * com.xx.xxx.xxx.controller..*.*(..))") 
    public void webLog() {} 
 
    /** 
     * 在切點之前織入 
     * @param joinPoint 
     * @throws Throwable 
     */ 
    @Before("webLog()") 
    public void doBefore(JoinPoint joinPoint) throws Throwable { 
        LOGGER.info("-------------doBefore-------------"); 
    } 
 
    @AfterReturning("webLog()") 
    public void afterReturning() { 
        LOGGER.info("-------------afterReturning-------------"); 
    } 
    @AfterThrowing("webLog()") 
    public void afterThrowing() { 
        LOGGER.info("-------------afterThrowing-------------"); 
    } 
 
    /** 
     * 在切點之后織入 
     * @throws Throwable 
     */ 
    @After("webLog()") 
    public void doAfter() throws Throwable { 
        LOGGER.info("-------------doAfter-------------"); 
    } 
 
    /** 
     * 環繞 
     * @param proceedingJoinPoint 
     * @return 
     * @throws Throwable 
     */ 
    @Around("webLog()") 
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable { 
        long startTime = System.currentTimeMillis(); 
        LOGGER.info("-------------doAround before proceed-------------"); 
        Object result = proceedingJoinPoint.proceed(); 
        LOGGER.info("-------------doAround after proceed-------------"); 
        return result; 
    } 

我們將版本改為2.2.5.RELEASE，結果如圖：

 

我們將版本改為2.3.4.RELEASE，結果如圖：

 

結論

經過上面的資料文檔查閱，我能給出的結論是：

從Spring5.2.7開始，Spring AOP不再嚴格按照AspectJ定義的規則來執行advice，而是根據其類型按照從高到低的優先級進行執行：@Around，@Before ，@After，@AfterReturning，@AfterThrowing。

這次的研究思考十分倉促，如果結論有誤請大家踴躍指正，也歡迎大家自己嘗試，畢竟口說無憑，實驗室檢驗真理的唯一標準!

參考

https://www.cnblogs.com/dennyLee2025/p/13724981.html

 

https://segmentfault.com/a/1190000011283029

本文轉載自微信公眾號「后端技術漫談」，可以通過以下二維碼關注。轉載本文請聯系后端技術漫談公眾號。