一个Mybatisplus组件扫描不当引起的bug：弄巧成拙，认真的锅，自我怀疑

在我们系统基建层的业务组件包 sby-biz-component 中，最初，我写了两个业务组件，一个是 通道错误码组件，一个是 审核流水组件。
这两个业务组件都要依赖Mybatisplus来操作数据。

1. com.sby.bizcomponent
2.  ├── auditflow
3.  │ └── AuditMapper.java
4.  │ └── AuditService.java
5.  │ └── AuditAutoConfiguration.java
6.  │ └── MybatisPlusMapperScanConfig.java
7.  │ └── package-info.java
8.  └── payerrorcode
9.    └── PayErrorCodeMapper.java
10.    └── PayErrorCodeService.java
11.    └── PayErrorCodeAutoConfiguration.java
12.    └── MybatisPlusMapperScanConfig.java
13.    └── package-info.java

复制代码

其中的 AuditAutoConfiguration.java 和 PayErrorCodeAutoConfiguration.java实现组件的自动装配。以 payerrorcode/PayErrorCodeAutoConfiguration.java 为例，代码如下。

1. @Configuration
2. @ComponentScan(basePackageClasses = {PayErrorCodeAutoConfiguration.class})
3. @ConditionalOnProperty(name = "bizcomponent.payerrorcode.enable",havingValue = "true")
4. public class PayErrorCodeAutoConfiguration {
5. }

复制代码

这里要说的是两个 MybatisPlusMapperScanConfig.java，两者的职责都是用来指定 Mybatisplus的 @MapperScan 注解，来定义Mapper接口的扫描路径。

1. // payerrorcode/MybatisPlusMapperScanConfig.java
2. @Configuration
3. @MapperScan(value = {"com.serviceshare.bizcomponent.payerrorcode"})
4. public class MybatisPlusMapperScanConfig {
5. }
7. // auditflow/MybatisPlusMapperScanConfig.java
8. @Configuration
9. @MapperScan(value = {"com.serviceshare.bizcomponent.auditflow"})
10. public class MybatisPlusMapperScanConfig {
11. }

复制代码

显然，这两个类重复度极高。对于此类代码，我的一贯风格是，盘它！我一向比较认真地致力于构建易于维护的应用系统。
我的方案是，我在 sby-biz-component 里新增了一个名为“config”的package。

1. com.sby.bizcomponent
2.  ├── auditflow
3.  │ └── AuditMapper.java
4.  │ └── AuditService.java
5.  │ └── AuditAutoConfiguration.java
6.  │ └── package-info.java
7.  ├── config
8.  │ └── MybatisPlusMapperScanConfig.java
9.  └── payerrorcode
10.    └── PayErrorCodeMapper.java
11.    └── PayErrorCodeService.java
12.    └── PayErrorCodeAutoConfiguration.java
13.    └── package-info.java

复制代码

改动后的 config/MybatisPlusMapperScanConfig.java，代码如下：

1. @Configuration
2. @MapperScan(value = {"com.serviceshare.bizcomponent.*.**"})
3. public class MybatisPlusMapperScanConfig {
4. }

复制代码

同时，修改两个 AutoConfiguration类，增加对MybatisPlusMapperScanConfig的扫描。例如 payerrorcode/PayErrorCodeAutoConfiguration.java：

1. @Configuration
2. @ComponentScan(basePackageClasses = {PayErrorCodeAutoConfiguration.class,MybatisPlusMapperScanConfig.class})
3. @ConditionalOnProperty(name = "bizcomponent.payerrorcode.enable",havingValue = "true")
4. public class PayErrorCodeAutoConfiguration {
5. }

复制代码

调整后的代码投产后，依赖这个 sby-biz-component 组件的应用服务，没有问题。
不过，好景持续了一年之久。
最近，我在 sby-biz-component 中，新开发了记账的业务组件。
然后，问题出现了————我们的一个依赖了 sby-biz-component 的中台 zhongtai-base 服务，本地环境启动报错：org.springframework.boot.SpringApplication:837 - Application run failed：org.springframework.context.annotation.ConflictingBeanDefinitionException: Annotation-specified bean name 'accountMapper' for bean class [com.serviceshare.bizcomponent.accounting.service.AccountMapper] conflicts with existing, non-compatible bean definition of same name and class [org.mybatis.spring.mapper.MapperFactoryBean]
这个错误是说，sby-biz-component 里 AccountMapper 与当前 zhongtai-base 服务里的 AccountMapper 存在bean冲突。
错误中提到的 sby-biz-component 里的 AccountMapper，在我新开发的记账组件package中。
这令我和一个开发伙伴摸不着头脑。
经过进一步分析和思考后，发现症结所在。
这牵涉到我去年后来在sby-biz-component 中开发的 datamig 数据迁移组件。
与其他组件所不同的是，这个 datamig 组件是自动生效的，不需要@ConditionalOnProperty配置。见下方 datamig.TimeBasedDataMigAutoConfiguration 代码。

1. // datamig/TimeBasedDataMigAutoConfiguration.java
3. @Configuration
4. @ComponentScan(basePackageClasses = {TimeBasedDataMigAutoConfiguration.class, MybatisPlusMapperScanConfig.class})
5. //@ConditionalOnProperty(name = "bizcomponent.datamig.enable",havingValue = "true")//**默认开启数据迁移组件
6. public class TimeBasedDataMigAutoConfiguration {
7. }

复制代码

问题就在于 datamig 的这个自动配置class，它扫描了 MybatisPlusMapperScanConfig， 这就导致 sby-biz-component 中所有的 Mapper接口类都作为spring容器的bean生效了。那么，这自然就包括新开发的记账组件package中的 AccountMapper。而 zhongtai-base 项目中自身有 AccountMapper， 就会出现 bean冲突异常，导致 zhongtai-base 服务无法启动。
这引起了我的自我反思。本意是为了降低重复，提升代码可维护性。结果却“弄巧成拙”了。生活中，对于我来说，也存在类似的情况。例如，刷完碗，为了控水，我会把一个碗倒扣在另外两个碗上，然后，自己在忙活中，不小心把碗碰到了地上，结果就碎碎平安了~

回归正题。我很快想到了fix这个问题的方案————
删掉 config.MybatisPlusMapperScanConfig.java，并由每个组件自己的自动配置类里，来指定Mybatisplus的 @MapperScan。

1. // payerrorcode/PayErrorCodeAutoConfiguration.java
2. @Configuration
3. @ComponentScan(basePackageClasses = {PayErrorCodeAutoConfiguration.class})
4. @MapperScan(basePackageClasses = {PayErrorCodeAutoConfiguration.class})
5. @ConditionalOnProperty(name = "bizcomponent.payerrorcode.enable",havingValue = "true")
6. public class PayErrorCodeAutoConfiguration {
7. }
9. // auditflow/AuditAutoConfiguration.java
10. @Configuration
11. @ComponentScan(basePackageClasses ={ AuditAutoConfiguration.class})
12. @MapperScan(basePackageClasses = {AuditAutoConfiguration.class})
13. @ConditionalOnProperty(name = "bizcomponent.audit.enable",havingValue = "true")
14. public class AuditAutoConfiguration {
15. }
17. // datamig/TimeBasedDataMigAutoConfiguration.java
18. @Configuration
19. @ComponentScan(basePackageClasses = {TimeBasedDataMigAutoConfiguration.class})
20. @MapperScan(basePackageClasses = {TimeBasedDataMigAutoConfiguration.class})
21. //@ConditionalOnProperty(name = "bizcomponent.datamig.enable",havingValue = "true")//默认开启数据迁移组件
22. public class TimeBasedDataMigAutoConfiguration {
23. }
25. // accounting/AccountingAutoConfiguration.java
26. @Configuration
27. @ComponentScan(basePackageClasses = {AccountingAutoConfiguration.class, DDLCreator.class})
28. @MapperScan(basePackageClasses = {AccountingAutoConfiguration.class})
29. @ConditionalOnProperty(name = "bizcomponent.accounting.enable",havingValue = "true")
30. public class AccountingAutoConfiguration {
31. }

复制代码

显然，这个方案既没有增加重复代码。如果我当初在解决重复代码时，使用这个方案，就不会遇到本文提到的这个问题了。
话说回来，在系统开发中，我常常为了追求一些自认为美好的东西，会认真地进行一些努力和实践。例如本文说的消除代码重复，再例如完善代码的javadoc，再例如优化异步调用方式，再例如更正数据类型、重命名变量/参数名，再例如使用enum提高可读性。
有时呢，后来证明，我的认真，反而让我犯了错。一些努力和实践带来了一些负面影响，然后我要为我的“认真”付出代价。当然，我始终认为这些是应该做的，应该致力于做。当然，有时候，也难免自我怀疑、自我否定。人大概就是在不断地自我摸索、自我怀疑、自我否定中成长吧！

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！