MyBatis-Plus 高级功能 —— 多数据源配置

一、引言

在我们实际业务开发中，难以避免需要同时涉及多个数据库，可能一个API中所需要的数据，往往是包含了多个数据库中的数据，

这个时候我们就需要在项目运行中，切换数据源。 那为什么会有这篇文章呢，那是因为小编在使用mybatis-plus这个框架，明明一个多数据源配置很简单，但是网上其他博客着实太过于复杂了。

从数据源配置、每一个数据源配置一个config类、配置枚举类、还有需要自己实现AOP的，当时小编就在想mybatis-plus是为简化而生，怎么搞这么复杂。

接下来不要眨眼，很快就实现了。

二、具体实现

步骤一：我们先需要引入maven配置，这里小编是使用3.1.0版本，可自选。dynamic-datasource-spring-boot-starter 是一个基于springboot的快速集成多数据源的启动器。

 <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
            <version>3.1.0</version>
        </dependency>

步骤二：多数据源配置，需要注意的后面都有写注释。

spring:
  datasource:
    dynamic:
      primary: master #设置默认的数据源或者数据源组,默认值即为master
      strict: false #设置严格模式,默认false不启动. 启动后在未匹配到指定数据源时候会抛出异常,不启动则使用默认数据源.
      datasource:
        master:
          url: jdbc:mysql://xx.xx.xx.xx:3306/dynamic
          username: root
          password: 123456
          driver-class-name: com.mysql.jdbc.Driver # 3.2.0开始支持SPI可省略此配置
        slave_1:
          url: jdbc:mysql://xx.xx.xx.xx:3307/dynamic
          username: root
          password: 123456
          driver-class-name: com.mysql.jdbc.Driver
        slave_2:
          url: ENC(xxxxx) # 内置加密,使用请查看详细文档
          username: ENC(xxxxx)
          password: ENC(xxxxx)
          driver-class-name: com.mysql.jdbc.Driver
          schema: db/schema.sql # 配置则生效,自动初始化表结构
          data: db/data.sql # 配置则生效,自动初始化数据
          continue-on-error: true # 默认true,初始化失败是否继续
          separator: ";" # sql默认分号分隔符

步骤三：步骤三就可以直接使用啦，真的是太方便了，@DS 可以注解在方法上或类上，同时存在就近原则 方法上注解 优先于 类上注解。

/**
 * 数据源切换测试
 *
 * @author IT 贱男
 * description:
 * date: 2021/2/25 18:01
 */
@Service
@AllArgsConstructor
public class TestJdbcServiceImpl implements TestJdbcService {

    // 数据库1的mapper
    private final KkOrderMapper kkOrderMapper;

    // 数据库2的mapper
    private final SysUserMapper sysUserMapper;

    // 不写DS默认是主数据源
    @Override
    public void testMySql1() {
        List<KkOrder> kkOrders = kkOrderMapper.selectList(null);
        System.out.println(kkOrders.size());
    }

    // 注解里面填写多数据源配置的名字
    @DS("slave_1")
    @Override
    public void testMysql2() {
        List<SysUser> sysUsers = sysUserMapper.selectList(null);
        System.out.println(sysUsers.size());
    }
}

 

三、官方建议以及特性

建议

1. 本框架只做 切换数据源 这件核心的事情，并不限制你的具体操作，切换了数据源可以做任何CRUD。
2. 配置文件所有以下划线 _ 分割的数据源 首部 即为组的名称，相同组名称的数据源会放在一个组下。
3. 切换数据源可以是组名，也可以是具体数据源名称。组名则切换时采用负载均衡算法切换。
4. 默认的数据源名称为 master ，你可以通过 spring.datasource.dynamic.primary 修改。
5. 方法上的注解优先于类上注解。
6. 强烈建议只在service的类和方法上添加注解，不建议在mapper上添加注解

特性

1. 支持 数据源分组 ，适用于多种场景 纯粹多库 读写分离 一主多从 混合模式。
2. 支持数据库敏感配置信息 加密 ENC()。
3. 支持每个数据库独立初始化表结构schema和数据库database。
4. 支持 自定义注解 ，需继承DS(3.2.0+)。
5. 提供对Druid，Mybatis-Plus，P6sy，Jndi的快速集成。
6. 简化Druid和HikariCp配置，提供 全局参数配置 。配置一次，全局通用。
7. 提供 自定义数据源来源 方案。
8. 提供项目启动后 动态增加移除数据源 方案。
9. 提供Mybatis环境下的 纯读写分离 方案。
10. 提供使用 spel动态参数 解析数据源方案。内置spel，session，header，支持自定义。
11. 支持 多层数据源嵌套切换 。（ServiceA >>> ServiceB >>> ServiceC）。
12. 提供对shiro，sharding-jdbc,quartz等第三方库集成的方案,注意事项和示例。
13. 提供 基于seata的分布式事务方案。 附：不支持原生spring事务。
14. 提供 本地多数据源事务方案。 附：不支持原生spring事务