Spring AOP 的执行顺序详解

怼烎@ 2021-09-07 06:20 321阅读 0赞

本文内容重点：

*  问题描述
 *  Spring AOP执行顺序
 *  探究顺序错误的真相
 *  代码验证
 *  结论

# ** ** #

# **问题描述** #

公司新项目需要搭建一个新的前后分离HTTP服务，我选择了目前比较熟悉的SpringBoot Web来快速搭建一个可用的系统。

鲁迅说过，**不要随便升级已经稳定使用的版本**。我偏不信这个邪，仗着自己用了这么久Spring，怎么能不冲呢。不说了，直接引入了最新的SprinBoot 2.3.4.RELEASE版本，开始给项目搭架子。

起初，大多数的组件引入都一切顺利，本以为就要大功告成了，没想到在搭建**日志切面**时栽了跟头。

> 作为一个接口服务，为了方便查询接口调用情况和定位问题，一般都会将请求日志打印出来，而Spring的AOP作为切面支持，完美的切合了日志记录的需求。

之前的项目中，运行正确的切面日志记录效果如下图：

![485c6ed5991016bbc0d63c3b1cfb0690.png][]

可以看到图内的一次方法调用，会输出请求url，出入参，以及请求IP等等，之前为了好看，还加入了分割线。

我把这个实现类放入新项目中，执行出来却是这样的：

![44bce7b615f344a1460cce63d3c181bf.png][]

我揉了揉眼睛，仔细看了看复制过来的老代码，精简版如下：

/**
     * 在切点之前织入
     * @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执行顺序的的资料，大多数时候，你会查到如下的答案：

## **正常情况** ##

![ad08a9cd63cc65d97881ccf02d0b562f.png][]

## **异常情况** ##

![cf79d03def6da9eca0731e83b0ef0e10.png][]

## **多个切面的情况** ##

![8c84c26d64a657dfc332138a99fd4811.png][]

所以@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

![35e3d7d7aef4df046da14a48e2678ebc.png][]

> 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

![ff1a8ce9b941451b7d5385ea6645e56e.png][]

>   
> 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，结果如图：

![74de364ae74d391e110ef543d68c0c87.png][]

我们将版本改为2.3.4.RELEASE，结果如图：

![313a62a078aca3d6ba5476ec33ae9642.png][]

# **结论** #

经过上面的资料文档查阅，**我能给出的结论是**：

**从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

推荐阅读 
    1.  一份 Spring Boot 项目搭建模板
    2.  Spring Boot 实现应用监控和报警
    3.  Nginx 从入门到实战
    4.  一键式搭建分布式文件服务器
    5.  团队开发中 Git 最佳实践
    
    喜欢文章，点个在看

[485c6ed5991016bbc0d63c3b1cfb0690.png]: /images/20210730/b37a496baf3a43ba8b2fce6b277de709.png
[44bce7b615f344a1460cce63d3c181bf.png]: /images/20210730/0e42afb989d04b72944c11480b0f885a.png
[ad08a9cd63cc65d97881ccf02d0b562f.png]: /images/20210730/d4270a80575d4705a831dcf9fd623d0c.png
[cf79d03def6da9eca0731e83b0ef0e10.png]: /images/20210730/bfe1ed99bb9342a5bbf5b7e27bb5f5b5.png
[8c84c26d64a657dfc332138a99fd4811.png]: /images/20210730/37fdb4bf67a040cc8138f87cc6e3e9d1.png
[35e3d7d7aef4df046da14a48e2678ebc.png]: /images/20210730/8545803c2ce04f2d8d5c0dc3fdf3b174.png
[ff1a8ce9b941451b7d5385ea6645e56e.png]: /images/20210730/1deaef9183ea422ab6f12d033a1d386c.png
[74de364ae74d391e110ef543d68c0c87.png]: /images/20210730/399da305eec84daba6df209d5c704ac9.png
[313a62a078aca3d6ba5476ec33ae9642.png]: /images/20210730/7e0068d41cde46958e1c1f3a3a8aed30.png