MyBatis-Plus多数据源插件升级问题解析与解决方案

背景介绍

在使用MyBatis-Plus及其动态数据源插件时，开发者经常会遇到版本升级带来的兼容性问题。本文以一个实际案例为基础，详细分析从MyBatis-Plus 3.4.x升级到3.5.6版本后出现的多数据源配置问题，并提供完整的解决方案。

问题现象

在Spring Boot插件框架环境下，开发者使用MyBatis-Plus的动态数据源功能时，从3.4.x版本升级到3.5.6后出现以下问题：

1. 启动时抛出"dynamic-datasource can not find primary datasource"错误
2. 手动添加数据源的操作未生效
3. 数据源切换功能失效

核心问题分析

版本变更带来的行为变化

MyBatis-Plus 3.5.x版本对动态数据源的初始化逻辑进行了调整：

1. 严格的主数据源检查：新版本在启动阶段就会验证主数据源是否存在，而旧版本允许后续动态添加
2. 配置加载时机变化：数据源配置的加载和验证提前到了应用上下文初始化阶段
3. 类型转换变更：count()方法返回值从int变为long，影响大量业务代码

插件环境特殊性

在Spring Boot插件框架中：

1. 类加载器采用父子关系而非隔离模式
2. 需要显式配置允许共存的自动配置类
3. 插件与主程序共享部分上下文但又有独立配置

解决方案

方案一：预配置主数据源

在插件配置文件中预先定义主数据源：

spring:
  datasource:
    dynamic:
      primary: master
      datasource:
        master:
          driver-class-name: xxx
          url: xxx
          username: xxx
          password: xxx

方案二：自定义数据源初始化

通过实现ApplicationListener接口，控制数据源初始化时机：

@Component
public class DataSourceInitializer implements ApplicationListener<ApplicationReadyEvent> {
    
    @Autowired
    private DataSource dataSource;
    
    @Autowired
    private DataSourceCreator dataSourceCreator;

    @Override
    public void onApplicationEvent(ApplicationReadyEvent event) {
        DynamicRoutingDataSource ds = (DynamicRoutingDataSource) dataSource;
        // 添加主数据源
        DataSourceProperty master = createDataSourceProperty("master", ...);
        ds.addDataSource("master", dataSourceCreator.createDataSource(master));
        // 添加其他数据源
        // ...
    }
}

方案三：适配新版本API变更

对于count()方法返回类型变更的影响：

1. 修改所有接收count()结果的变量类型为long
2. 对于需要int的场景，显式进行类型转换
3. 更新相关业务逻辑中对返回值类型的假设

最佳实践建议

1. 版本升级策略：

   • 先在测试环境验证所有数据源相关功能
   • 分阶段升级，先升级MyBatis-Plus核心，再升级动态数据源插件

2. 配置管理：

   • 保持主数据源在配置文件中明确定义
   • 动态添加的数据源建议使用@PostConstruct或ApplicationReadyEvent触发

3. 异常处理：

   • 增加对数据源切换失败的兜底逻辑
   • 实现健康检查机制监控多数据源状态

4. 测试保障：

   • 增加多数据源切换的集成测试用例
   • 对count()等API变更影响的场景进行重点测试

总结

MyBatis-Plus版本升级带来的多数据源问题主要源于框架对数据源初始化流程的严格化处理。通过预先配置主数据源、调整初始化时机以及适配API变更，可以有效解决这些问题。在插件化等复杂环境中，更需要关注框架组件的生命周期和加载顺序，确保各模块协调工作。