花了2个钟，终于搞清楚 AOP 未生效的原因了...

╰+哭是因爲堅強的太久メ 2022-08-31 04:55 217阅读 0赞

今天 4ye 来和小伙伴们分享一个小实战啦 ，冲冲冲~ **(。・∀・)ノ**

![9b056d7be2333674893baa8d124c8fc8.png][]

### 实战回顾 ###

（我居然拖到现在才写了这文章…… ????）

主要是在一个周日（2020.6.6）在技术群里看到一个老哥在问

**“怎么用切面来捕获自定义异常？”** (￣▽￣)"

我当时想的是，**捕获异常**不是很常见的吗，平时经常用到这个**全局异常捕获** ，于是就把自己 `GitHub` 上的小例子发给他（主要是这个 `ControllerAdvice` 注解），如图 ????

![5bea0774969e277ff276cbcfd034b0a0.png][]

结果老哥过了一段时候就加了我，还问我有没有空帮忙看下，还想打电话问我，我当时的内心是

这么急的吗（瑟瑟发抖……）

![7f11d7dbbc5ea56becc1385a4f9180c3.png][]

不过刚好在外面没时间，就婉拒了，后来晚上回来，愣是花了两个钟，才看懂 **为啥这个`AOP` 没有生效？为啥没能捕获到异常？**

![18615fc0a251c325371a3c5e90a52754.png][]

下面进入主题????（**项目整体介绍**）

### maven项目结构图 ###

在该项目中，maven项目采用**多模块构建**，**父子结构**，由 **父maven** 来统一管理这些公共包，以及项目的整体版本属性配置等

里面有两个模块，`starter` 模块和 `core` 模块，其中 `starter` 模块**依赖** `core` 模块，整体如下图????

![8d639ad645550d88dd4f07e0d1e23fcf.png][]

### 子模块介绍 ###

不知道小伙伴们看到上面的 `starter` 有没有嗅到什么 ？

一开始我以为是常见的 **自定义starter** ，但是里面的内容却和我想的有点出入，居然只有一个 `spring.factories` 文件, 很明显这里使用到了 **Springboot 的 SPI 机制**。

这个在我们之前的  ???? [Springboot自动装配原理探索][Springboot]  一文中有介绍到，小伙伴们可以前去了解看看~????

对两个模块中的核心部分进行展开，结构如下????

![335c973ad8653f754a781c2447100f3c.png][]

**core项目描述**：**非web项目**里面只有 `service` ，没有启动类等

???? 由于 core 模块 **不是web项目**！！，所以这个 `ControllerAdvice` 是肯定不能用的，毕竟它是在 `web` 包中的，一般我们在 **web项目**中配合这个`@ExceptionHandler(Exception.class)` 实现全局异常捕获，然后进行统一处理的。

???? 从 **Springboot 的 SPI 机制** 中我们可以得知，`Springboot` 项目启动时，会去扫描各个项目中的  `META-INF/spring.factories` 文件（包括各个jar包），然后将其中的配置信息读取到内存中，而自动配置时会根据一定的条件对这些类进行筛选，最后创建符合的类，完成这个自动装配。

很明显，这里就是通过**自动配置**，来实现相关 `bean` 的注入。

### 配置类说明 ###

那么，在了解了这些基本信息后，我们可以把目光移到这个 `xxxConfig` 上，这里模仿了一个????

![19b44c777e1cc25393123521466ead57.png][]

紧接着就是项目中的切面配置了，例如以前写的小例子：????

代码在我的 `GitHub` ：

https://github.com/RyzeYang/springboot-demo-4ye.git

通过**异常通知**来捕获

![891d6338141f064afaeab4129f9e0a69.png][]

除了上面这两个之外，项目中没有用到其他配置了！

### 问题来了 ###

这个时候问题就来了，在定义了**切面**之后，发现根本没有在项目中起作用！而其他都可以正常运行!

![9e44bfd34f98d8a216c9d37400560f73.png][]

于是我一直在想，这是为啥呀，明明切面已经定义好了呀……

![352236ecc6747838936136de786a06fb.png][]

终于，我开始了尝试，在 `yaml` 配置文件中添加这个参数

spring:
     aop:
        auto: true

因为在印象中，这个默认是 `true` ，会默认使用这个 `@EnableAspectJAutoProxy` ， 不用我们手动去添加这个 `@EnableAspectJAutoProxy` 注解（之前一直没有手动添加这个注解）????

![f8dfba01b55356b4b5d262278dfe560b.png][]

结果也没什么效果……

于是乎，我决定手动添加到刚刚那个 `xxxConfig` 配置类上，结果也没有什么作用……

![c6336824fa0df2fbdcf59ac4c542abf3.png][]

终于，我才想起那个 **切面配置** 没有被加载到这个 `Spring` 中 ，于是我又在那个配置类 `xxxConfig` 上添加了这个包扫描注解 `@ComponentScan(basePackages = "com.xxx.xxx")`

结果终于成功了！

于是我赶在 **23:59** 将修改后的文件发给那位老哥后，却发现他居然睡着了 哈哈哈

![249b9f3841f7a418306312226aa35695.png][]

![bc44966e35344594b6832b40bebc41d1.png][]

### 问题剖析 ###

解决问题后，我们可以发现这个问题就下面两点????

1.  没有将切面注册到 `SpringIOC` 容器中
2.  没有使用这个 `@EnableAspectJAutoProxy`

**第一步**的解决也很简单，就是没有配置这个包扫描 `@ComponentScan(basePackages = "com.xxx.xxx")`

**第二步**的解决嘛，就有点一头雾水了当时，毕竟之前也不需要我手动去添加的，而且从配置的描述信息中可以发现，即使我们没有配置，他也是默认开启的，会自动使用这个注解的~

那么小伙伴们知道**第二步问题**的所在吗????

![b51934fa8cb0bcb6c890add211d20c8f.png][]

嘿嘿，答案就出在这个**自动配置** 身上，可以发现我们上面都没有使用到这个 `@EnableAutoConfiguration` 注解，而在我们的 `SpringBootApplication` 组合注解中，最重要的就是它了！通过它去开启了我们的这个**自动装配**。

这个时候又得把这文章搬出来了 ???? [Springboot自动装配原理探索][Springboot] 哈哈

那么我们再来看看这个 **AOP自动装配的配置类**

### AOP自动装配的配置类 ###

`AopAutoConfiguration` 源码如下????

![a2f705b63bd268f6662e459d823cfa30.png][]

开头有这么一个条件注解

@ConditionalOnProperty(prefix = "spring.aop", name = "auto", havingValue = "true", matchIfMissing = true)

`havingValue = "true"` 的意思是：值为 `true` 时才有效

`matchIfMissing = true` 的意思是：没有配置这个属性时也能加载

接着让我们把目光移到第一个静态内部类：`AspectJAutoProxyingConfiguration`

如图????：

![9aa149f27c87178298e45633bfafe410.png][]

这个我们也比较熟悉啦， `proxyTargetClass` 为 `true` 时表示使用 `cglib` ，`false` 使用 `JDK`动态代理

接着看最后的静态内部类：`ClassProxyingConfiguration`

![ab6bab1b75177f59d0ef1297036552b2.png][]

可以发现它这里的条件是和  `AspectJAutoProxyingConfiguration`  相反的，当没有这个 `Advice` 类时，帮我们去注册这个代理到 `IOC` 中

看完该AOP自动装配类后， 我们可以发现当我们使用 `@EnableAutoConfiguration` 自动装配注解时并引入 `AOP` 的包时，它会自动帮我们装配这个`AopAutoConfiguration` ，而它里面就使用到了 `@EnableAspectJAutoProxy` ，所以我们一般不用手动添加该注解。

![181aaad7fd39593a235af990f0282306.png][]

### 怎么测试 ###

嘿嘿，再出一个小问题考考小伙伴????

有没有细心的小伙伴发现上面的 `core` 模块是没有用到这个 `SpringBootApplication` 的，而且我们也没有用到这个 `@EnableAutoConfiguration` ，那么没有自动装配，这个 `SPI` 显然也没啥作用 ，那么，我们在项目中要怎么测试呢~

![c0564223883b9ef8c0efb05782d00a87.gif][]

答案就在 单元测试的注解身上 `@SpringBootTest(classes = xxxConfiguration.class)`

通过这个 `classes` ，我们直接指定并实例化这个配置类就可以了

我也是报错了才知道 哈哈????

![f9c443ab301e23f0d0b41b0b5ae3ace3.png][]

### 总结 ###

嘿嘿，老规矩，画个图总结下啦????

#### 排查思路 ####

![28a64601a70b6b7b3cc3bfab6c699f7f.png][]

#### 知识脑图 ####

![c47e35e4d5fc4a49caec1236a97b63b2.png][]

推荐好文

[强大，10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程！][10k_ SpringBoot]

[分享一套基于SpringBoot和Vue的企业级中后台开源项目，代码很规范！][SpringBoot_Vue]

[能挣钱的，开源 SpringBoot 商城系统，功能超全，超漂亮][SpringBoot]![9a6e8ea72ceb46615afef0e4f95dede8.png][]

[9b056d7be2333674893baa8d124c8fc8.png]: /images/20220829/60b7f9a51f2648e6bc21cdaa6732fc91.png
[5bea0774969e277ff276cbcfd034b0a0.png]: /images/20220829/c6f543bf71714fdeacd54532b038d6b0.png
[7f11d7dbbc5ea56becc1385a4f9180c3.png]: /images/20220829/562794958c4c4b339f16eb3fcd6a652a.png
[18615fc0a251c325371a3c5e90a52754.png]: /images/20220829/a73b964fd22d4aad85414bc795354157.png
[8d639ad645550d88dd4f07e0d1e23fcf.png]: /images/20220829/5c035ef5ac5d400a869a55750763257f.png
[Springboot]: https://mp.weixin.qq.com/s?__biz=Mzg2MjUzODc5Mw%3D%3D&idx=1&mid=2247487780&scene=21&sn=618b88be9f5e81659a6a6ce4450972e8#wechat_redirect
[335c973ad8653f754a781c2447100f3c.png]: /images/20220829/da53d0459a19490bae8ce1d603c03ac6.png
[19b44c777e1cc25393123521466ead57.png]: /images/20220829/f45adbfb51a34a04aea977493bcb6260.png
[891d6338141f064afaeab4129f9e0a69.png]: /images/20220829/01222b8bba134420a185f8c28fc6c548.png
[9e44bfd34f98d8a216c9d37400560f73.png]: /images/20220829/1a2ff9056bce4d70a44a331e9cde9a9d.png
[352236ecc6747838936136de786a06fb.png]: /images/20220829/41b47101119948158fcf34bb142995bd.png
[f8dfba01b55356b4b5d262278dfe560b.png]: /images/20220829/7b6c4b27b94d423d9a8ee79b7fbca3e8.png
[c6336824fa0df2fbdcf59ac4c542abf3.png]: /images/20220829/8ff14e686ecf4dd38b16b48c10ea49d8.png
[249b9f3841f7a418306312226aa35695.png]: /images/20220829/8a16fc50626746178741cc836048d2ec.png
[bc44966e35344594b6832b40bebc41d1.png]: /images/20220829/54912f72036e4dde8f5012e0011e78fc.png
[b51934fa8cb0bcb6c890add211d20c8f.png]: /images/20220829/2c06afd55931498ab65a933d04e65ce2.png
[a2f705b63bd268f6662e459d823cfa30.png]: /images/20220829/a70249a0d992458b8b1a8534d1f1213e.png
[9aa149f27c87178298e45633bfafe410.png]: /images/20220829/ff934c9079864a0eaae5be9ea2b355a6.png
[ab6bab1b75177f59d0ef1297036552b2.png]: /images/20220829/bb0e21ca305443ca82dfe1f3a14b6661.png
[181aaad7fd39593a235af990f0282306.png]: /images/20220829/95c906c907d641e9a01bfc2c9ac3c977.png
[c0564223883b9ef8c0efb05782d00a87.gif]: /images/20220829/f82c8d307e7e4737b3eaac9512a732f0.png
[f9c443ab301e23f0d0b41b0b5ae3ace3.png]: /images/20220829/f2aae9dddd08405f98656c7f46f996e2.png
[28a64601a70b6b7b3cc3bfab6c699f7f.png]: /images/20220829/f297e7a595e6435ba544716c89f99161.png
[c47e35e4d5fc4a49caec1236a97b63b2.png]: /images/20220829/908c2638411e4d6caa147c1e703ed203.png
[10k_ SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzI4Njc5NjM1NQ%3D%3D&chksm=ebd5c411dca24d07446a4f22772cd12d2cc1143b62eb922a14500ae981cd57fb850ef74ca257&idx=2&mid=2247498557&scene=21&sn=84902d7030e174e152615d8fae3755cc#wechat_redirect
[SpringBoot_Vue]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799be6cb0e12f0b58479f8b031bc5ae79efdca1880ff9b19f0a107c3a88c37b9596dc73203&idx=2&mid=2247497288&scene=21&sn=65d7111a19e920df1e9416959594b2f4#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799a9ccb0e138a64a2671f31b8d4be1b3c061a288f7b0d1d4af02a60c45a72231446b91e00&idx=2&mid=2247497522&scene=21&sn=c5b4e596be4ac7d7f293e7e2f0ea0769#wechat_redirect
[9a6e8ea72ceb46615afef0e4f95dede8.png]: /images/20220829/8a77fb3cf6f84af5adfbce45bac3d193.png