利用SpringBoot实现多数据源的两种方式总结

我来为你详细讲解“利用SpringBoot实现多数据源的两种方式总结”的完整攻略。

1. 背景和概述

在实际应用开发中，我们常常会使用多个数据源，比如一个应用需要访问多个数据库，或者需要对接多个第三方数据服务。SpringBoot提供了开箱即用的多数据源支持，可以方便地实现多数据源配置和切换。

本文将讲解2种利用SpringBoot实现多数据源的方式，一种是使用@ConfigurationProperties注解实现，另一种是使用@Primary注解实现。

2. 方式一：使用@ConfigurationProperties注解实现多数据源

2.1. 步骤一：在配置文件中配置多数据源

首先，需要在application.yml或application.properties配置文件中指定多个数据源的相关信息，例如：

spring:
  datasource:
    # 主数据源配置
    primary:
      url: jdbc:mysql://localhost:3306/db_primary
      driver-class-name: com.mysql.jdbc.Driver
      username: root
      password: root
    # 第二个数据源配置
    second:
      url: jdbc:mysql://localhost:3306/db_second
      driver-class-name: com.mysql.jdbc.Driver
      username: root
      password: root

其中，使用spring.datasource作为前缀，可以配置多个不同名称的数据源。

2.2. 步骤二：创建多数据源配置类

接下来，需要创建一个多数据源的配置类，用于读取配置文件并创建对应的数据源。代码如下：

@Configuration
public class MultipleDataSourceConfiguration {

    private Map<String, DataSource> dataSources = new HashMap<>();

    public MultipleDataSourceConfiguration(
            @ConfigurationProperties("spring.datasource.primary") DataSource primaryDataSource,
            @ConfigurationProperties("spring.datasource.second") DataSource secondDataSource) {
        // 存储多个数据源
        dataSources.put("primary", primaryDataSource);
        dataSources.put("second", secondDataSource);
    }

    // 根据数据库名称动态获取对应的数据源
    public DataSource getDataSource(String dbName) {
        return dataSources.get(dbName);
    }
}

可以看到，在构造函数中，使用了@ConfigurationProperties注解来注入两个数据源，然后将其以Map的方式存储起来。同时，还提供了一个getDataSource方法，根据数据库名称动态获取对应的数据源。

2.3. 步骤三：使用多数据源

最后，可以在应用中使用多数据源了。比如，在需要访问数据源的地方注入多数据源配置类并调用相关的方法：

@RestController
public class TestController {

    @Autowired
    private MultipleDataSourceConfiguration dataSourceConfiguration;

    @GetMapping("/test1")
    public String test1() throws SQLException {
        // 获取主数据源
        DataSource dataSource = dataSourceConfiguration.getDataSource("primary");
        // 使用主数据源进行数据库操作
        Connection connection = dataSource.getConnection();
        Statement statement = connection.createStatement();
        ResultSet resultSet = statement.executeQuery("SELECT * FROM table1");
        ...
    }

    @GetMapping("/test2")
    public String test2() throws SQLException {
        // 获取第二个数据源
        DataSource dataSource = dataSourceConfiguration.getDataSource("second");
        // 使用第二个数据源进行数据库操作
        Connection connection = dataSource.getConnection();
        Statement statement = connection.createStatement();
        ResultSet resultSet = statement.executeQuery("SELECT * FROM table2");
        ...
    }
}

其中，test1方法使用主数据源进行数据库操作，而test2方法使用第二个数据源进行数据库操作。

3. 方式二：使用@Primary注解实现多数据源

3.1. 步骤一：在配置文件中配置多数据源

和方式一相同，需要在application.yml或application.properties配置文件中指定多个数据源的相关信息。

3.2. 步骤二：使用@Primary注解指定主数据源

在创建数据源的时候，使用@Primary注解来指定主数据源：

@Bean
@ConfigurationProperties(prefix = "spring.datasource.primary")
@Primary
public DataSource primaryDataSource() {
    return DataSourceBuilder.create().build();
}

@Bean
@ConfigurationProperties(prefix = "spring.datasource.second")
public DataSource secondDataSource() {
    return DataSourceBuilder.create().build();
}

可以看到，primaryDataSource方法上使用了@Primary注解，表示该数据源为主数据源，而secondDataSource方法则没有使用，表示它是非主数据源。

3.3. 步骤三：使用多数据源

和方式一相同，可以在应用中使用多数据源了。注意，这里主数据源的注入不需要指定名称，因为有了@Primary注解，SpringBoot会自动识别出来。

@RestController
public class TestController {

    @Autowired
    private DataSource primaryDataSource;

    @Autowired
    private DataSource secondDataSource;

    @GetMapping("/test1")
    public String test1() throws SQLException {
        // 使用主数据源进行数据库操作
        Connection connection = primaryDataSource.getConnection();
        Statement statement = connection.createStatement();
        ResultSet resultSet = statement.executeQuery("SELECT * FROM table1");
        ...
    }

    @GetMapping("/test2")
    public String test2() throws SQLException {
        // 使用第二个数据源进行数据库操作
        Connection connection = secondDataSource.getConnection();
        Statement statement = connection.createStatement();
        ResultSet resultSet = statement.executeQuery("SELECT * FROM table2");
        ...
    }
}

其中，primaryDataSource被注入为主数据源，而secondDataSource则被注入为非主数据源。

4. 总结

本文介绍了两种利用SpringBoot实现多数据源的方式，分别是使用@ConfigurationProperties注解实现和使用@Primary注解实现。两种方式都可以方便地实现多数据源配置和切换，开发者可以根据具体的需求选择适合自己的方式。

至此，本文的内容讲解结束。如果您还有其他问题或疑问，欢迎继续咨询。