如何在Java SpringBoot项目中配置动态数据源你知道吗

当我们使用 SpringBoot 开发项目时，通常会遇到需要动态切换不同数据源的需求。这时候，我们可以通过配置动态数据源来解决这个问题。下面是详细讲解如何在 Java SpringBoot 项目中配置动态数据源的攻略。

1. 引入相关依赖

我们需要引入如下两个 SpringBoot 的依赖：

<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>3.4.5</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

HikariCP 是一个高性能的 JDBC 连接池，而 spring-boot-starter-jdbc 则是 SpringBoot 的 JDBC Starter ，用于简化 JDBC 开发配置。

2. 定义动态数据源

定义一个动态数据源的主要思想是使用 Spring 提供的 AbstractRoutingDataSource 类，该类可以根据指定的数据源标识动态路由到不同的数据源。

public class DynamicDataSource extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return DynamicDataSourceContextHolder.getDataSource();
    }
}

在 determineCurrentLookupKey() 方法中，我们使用 DynamicDataSourceContextHolder.getDataSource() 方法来获取当前需要使用的数据源的标识。

3. 配置数据源

在 SpringBoot 的配置文件中，我们通常会使用 application.properties 或 application.yml 来配置应用程序参数。下面是使用 YAML 配置文件的示例：

spring:
  datasource:
    # 默认的主数据源
    url: jdbc:mysql://127.0.0.1:3306/master?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
    username: root
    password: 123456
    driver-class-name: com.mysql.jdbc.Driver

    # 数据源2
    datasources:
      ds1:
        url: jdbc:mysql://127.0.0.1:3306/test1?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
        username: root
        password: 123456
        driver-class-name: com.mysql.jdbc.Driver

      ds2:
        url: jdbc:mysql://127.0.0.1:3306/test2?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
        username: root
        password: 123456
        driver-class-name: com.mysql.jdbc.Driver

我们可以在配置文件中定义多个数据源，并为每个数据源指定一个唯一的标识。在这个示例中，我们为两个数据源分别指定了 ds1 和 ds2 标识。

4. 配置动态数据源路由策略

我们需要通过代码指定动态数据源路由策略。这里我们可以使用 ThreadLocal 保存当前数据源的标识，比如：

public class DynamicDataSourceContextHolder {
    private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();

    public static void setDataSource(String dataSource) {
        contextHolder.set(dataSource);
    }

    public static String getDataSource() {
        return contextHolder.get();
    }

    public static void clearDataSource() {
        contextHolder.remove();
    }
}

在使用某个数据源之前，需要先通过 DynamicDataSourceContextHolder.setDataSource() 方法设置当前数据源的标识，同时需要在操作完成后清除线程中的数据源标识。

5. 配置 DynamicDataSource

@Configuration
public class DataSourceConfig {

    @Bean
    @ConfigurationProperties("spring.datasource")
    public DataSource dataSource() {
        return new DynamicDataSource();
    }

}

在这里，我们使用 @ConfigurationProperties("spring.datasource") 将 application.yml 中的数据源属性绑定到 DataSource 对象中，并返回一个 DynamicDataSource 对象。

6. 使用动态数据源

在使用动态数据源时，我们需要先设置当前需要使用的数据源的标识，然后让 SpringBoot 的 JdbcTemplate 通过动态数据源读取数据。下面是一个读取数据的示例：

@Autowired
private JdbcTemplate jdbcTemplate;

public void select() {
    DynamicDataSourceContextHolder.setDataSource("ds1"); // 设置数据源标识为 ds1
    String sql = "select * from user";
    List<User> userList = jdbcTemplate.query(sql, new BeanPropertyRowMapper<>(User.class));
    DynamicDataSourceContextHolder.clearDataSource(); // 清除线程中的数据源标识
}

在这个示例中，我们首先使用 DynamicDataSourceContextHolder.setDataSource() 方法设置需要使用的数据源标识，然后通过 JdbcTemplate 执行查询操作，并将返回的数据映射为 User 对象的列表。最后，我们使用 DynamicDataSourceContextHolder.clearDataSource() 方法清除线程中的数据源标识，以避免数据源切换出现错误。