dynamic-datasource-spring-boot-starter 动态数据源切换数据源方案

五月 19, 2024 5142

spring-boot-starter-dynamic-datasource 一个基于springboot的快速集成多数据源的启动器，能够轻易实现 多数据源 动态数据源 主从分离 读写分离 分布式事务

数据源切换方式

1. 动态配置法

配置文件：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
spring:
  activiti:
    datasource: flow
  datasource:
    dynamic:
      strict: true
      primary: activity
      datasource:
        flow:
          driver-class-name: com.mysql.cj.jdbc.Driver
          username: ${mysql.username}
          password: ${mysql.password}
          url: jdbc:mysql://${mysql.url}/housing_flow?nullCatalogMeansCurrent=true&serverTimezone=GMT%2B8
        activity:
          driver-class-name: com.mysql.cj.jdbc.Driver
          username: ${mysql.username}
          password: ${mysql.password}
          url: jdbc:mysql://${mysql.url}/housing_flow_new?nullCatalogMeansCurrent=true&serverTimezone=GMT%2B8

代码配置：

1
2
3
4
5
6
7
@Service
@DS("#this.target.datasource")
public class FlowEngineService {

    @Value("${spring.activiti.datasource}")
    public String datasource;
}

2. 主动获取法

这种方法会在多数据源混用时事务失效

配置文件：

同上

代码配置：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@Slf4j
@Configuration
public class ActivityFlowConfig implements ProcessEngineConfigurationConfigurer {

    @Value("${spring.activiti.datasource}")
    public String datasource;

    private final DynamicRoutingDataSource dynamicDataSource;

    public ActivityFlowConfig(DynamicRoutingDataSource dataSource) {
        this.dynamicDataSource = dataSource;
    }

    @Override
    public void configure(SpringProcessEngineConfiguration processEngineConfiguration) {
       DataSource dataSource = dynamicDataSource.getDataSource(datasource);
       processEngineConfiguration.setDataSource(dataSource);
    }
}

2. 克隆替换法

完美解决事务失效问题

配置文件：

同上

代码配置：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@Slf4j
@Configuration
public class ActivityFlowConfig implements ProcessEngineConfigurationConfigurer {

    @Value("${spring.activiti.datasource}")
    public String datasource;

    private final DynamicRoutingDataSource dynamicDataSource;

    public ActivityFlowConfig(DynamicRoutingDataSource dataSource) {
        this.dynamicDataSource = dataSource;
    }

    @Override
    public void configure(SpringProcessEngineConfiguration processEngineConfiguration) {
       DynamicRoutingDataSource dataSource = new DynamicRoutingDataSource(null); // 新建克隆对象
       dynamicDataSource.getDataSources().forEach(dataSource::addDataSource); // 克隆数据源
       dataSource.setPrimary(datasource); // 指定主数据源
       processEngineConfiguration.setDataSource(dataSource); // 完美替换
    }
}

官网使用方法

  1. 引入dynamic-datasource-spring-boot-starter。

spring-boot 1.5.x 2.x.x

1
2
3
4
5
6

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

spring-boot3及以上

1
2
3
4
5
6

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot3-starter</artifactId>
    <version>${version}</version>
</dependency>
  1. 配置数据源。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
spring:
  datasource:
    dynamic:
      enabled: true #启用动态数据源，默认true
      primary: master #设置默认的数据源或者数据源组,默认值即为master
      strict: false #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
      grace-destroy: false #是否优雅关闭数据源，默认为false，设置为true时，关闭数据源时如果数据源中还存在活跃连接，至多等待10s后强制关闭
      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
        #......省略
        #以上会配置一个默认库master，一个组slave下有两个子库slave_1,slave_2

多主多从：

1
2
3
4
5
6
7
8
9
spring:
  datasource:
    dynamic:
      datasource:
        master_1:
        master_2:
        slave_1:
        slave_2:
        slave_3:

纯粹多库：

1
2
3
4
5
6
7
8
9
spring:
  datasource:
    dynamic:
      datasource:
        mysql:
        oracle:
        sqlserver:
        postgresql:
        h2:

混合配置：

1
2
3
4
5
6
7
8
9
spring:
  datasource:
    dynamic:
      datasource:
        master:
        slave_1:
        slave_2:
        oracle_1:
        oracle_2:
  1. 使用 @DS 切换数据源。

@DS 可以注解在方法上或类上，同时存在就近原则 方法上注解 优先于 类上注解。

注解 结果
没有@DS 默认数据源
@DS(“dsName”) dsName可以为组名也可以为具体某个库的名称 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

@Service
@DS("slave")
public class UserServiceImpl implements UserService {

    @Autowired
    private JdbcTemplate jdbcTemplate;

    public List selectAll() {
        return jdbcTemplate.queryForList("select * from user");
    }

    @Override
    @DS("slave_1")
    public List selectByCondition() {
        return jdbcTemplate.queryForList("select * from user where age >10");
    }
}