官方建议!Spring Boot多数据源正确实现方式

环境：SpringBoot3.4.2

1. 简介

如果需要配置多个数据源，你就必须将其中一个数据源实例标记为 @Primary，因为接下来的各种自动配置都希望能通过类型获得其中一个。

如果创建了自己的数据源，自动配置的默认数据源就不会生效。接下来通过一个完整示例展示如何在项目中配置多个数据源。

2. 实战案例

Spring Boot 提供了一个名为 DataSourceBuilder 的实用构建器类，可用于创建一个标准数据源（如果它在类路径上）。生成器可根据类路径上的可用数据源检测要使用的数据源。它还能根据 JDBC URL 自动检测驱动程序。

2.1 数据源配置信息

app:
  datasource:
    first:
      url: "jdbc:mysql://localhost:3306/ds1"
      username: "root"
      password: "123123"
      configuration:
        minimumIdle: 20
        maximumPoolSize: 20
    second:
      url: "jdbc:mysql://localhost:3306/ds2"
      username: "root"
      password: "123123"
      configuration:
        minimumIdle: 10
        maximumPoolSize: 10

以上配置了2个数据源first，second。configuration属性节点是针对连接池进行配置。如果你有更多的数据源配置，按照上面方式添加即可。接下来是数据源bean的配置。

2.2 配置多数据源Bean

@Configuration(proxyBeanMethods = false)
public class MultiDataSourcesConfiguration {
  @Bean
  @Primary
  @ConfigurationProperties("app.datasource.first")
  DataSourceProperties firstDataSourceProperties() {
    return new DataSourceProperties();
  }


  @Bean
  @Primary
  // 这里指定连接池的其它信息进行绑定
  @ConfigurationProperties("app.datasource.first.configuration")
  HikariDataSource firstDataSource(DataSourceProperties firstDataSourceProperties) {
    return firstDataSourceProperties.initializeDataSourceBuilder().type(HikariDataSource.class).build();
  }


  @Bean
  @ConfigurationProperties("app.datasource.second")
  DataSourceProperties secondDataSourceProperties() {
    return new DataSourceProperties();
  }


  @Bean
  @ConfigurationProperties("app.datasource.second.configuration")
  HikariDataSource secondDataSource(
      @Qualifier("secondDataSourceProperties") DataSourceProperties secondDataSourceProperties) {
    return secondDataSourceProperties.initializeDataSourceBuilder().type(HikariDataSource.class).build();
  }
}

上面调用的DataSourceProperties#
initializeDataSourceBuilder方法，其本质调用的是DataSourceBuilder类进行数据源的构建。

这里的@Primary不是必须的，以上的配置逻辑与 Spring Boot 在自动配置中使用的逻辑相同。

在通常情况下，当我们使用JPA或MyBatis等持久层框架时，针对单个数据源的配置通常比较简单，只需要配置好数据源和框架的相关设置即可。然而，当涉及到多数据源的场景时，配置会相对复杂一些，因为我们需要为每个数据源单独配置JPA或MyBatis。接下来将针对JPA进行多数据源情况的配置。

2.3 JPA配置

由于配置的比较多，这里就针对一个数据源进行配置，其它数据源除了定义名称不一样外其它都一样。

配置文件

app:
  jpa:
    first:
      generateDdl: false
      openInView: true
      show-sql: true
    second:
      generateDdl: false
      openInView: true
      show-sql: true

配置类，需要配置jpa的核心类EntityManagerFactory及事务管理器。

@Configuration(proxyBeanMethods = false)
@EnableJpaRepositories(basePackages = {"com.pack.ds1"}, 
  entityManagerFactoryRef = "firstEntityManagerFactory", transactionManagerRef = "firstJPATransactionManager")
public class FirstEntityManagerFactoryConfiguration {


  @Bean
  @ConfigurationProperties("app.jpa.first")
  JpaProperties firstJpaProperties() {
    return new JpaProperties();
  }
  @Bean
  LocalContainerEntityManagerFactoryBean firstEntityManagerFactory(DataSource firstDataSource,
      JpaProperties firstJpaProperties) {
    Map<String, Object> properties = new HashMap<>();
    // 自动生成/更新表结构
    properties.put("hibernate.hbm2ddl.auto", "update");
    EntityManagerFactoryBuilder builder = createEntityManagerFactoryBuilder(firstJpaProperties) ;
    return builder.dataSource(firstDataSource).packages("com.pack.ds1").properties(properties).persistenceUnit("firstDs").build() ;
  }
  private EntityManagerFactoryBuilder createEntityManagerFactoryBuilder(JpaProperties jpaProperties) {
    JpaVendorAdapter jpaVendorAdapter = createJpaVendorAdapter(jpaProperties);
    return new EntityManagerFactoryBuilder(jpaVendorAdapter, jpaProperties.getProperties(), null);
  }
  private JpaVendorAdapter createJpaVendorAdapter(JpaProperties jpaProperties) {
    return new HibernateJpaVendorAdapter() ;
  }
  // 事务管理器必须配置（针对的那个数据源）
  @Bean
  PlatformTransactionManager firstJPATransactionManager(EntityManagerFactory firstEntityManagerFactory) {
    JpaTransactionManager tm = new JpaTransactionManager(firstEntityManagerFactory) ;
    return tm;
  }
}

其它数据源与上面配置是一样的。到此所有的配置就完成了，接下来你就可以像操作单数据源一样进行编码了，注意：针对不同数据源所建立的Repository放到对应的包中即可。

测试

// com.pack.ds1包
@Entity
@Table(name = "t_student")
public class Student {


  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id ;
  private String name ;
}
public interface StudentRepository extends JpaRepository<Student, Long>{}
// com.pack.ds2包
@Entity
@Table(name = "t_teacher")
public class Teacher {


  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id ;
  private String name ;
}
public interface TeacherRepository extends JpaRepository<Teacher, Long> {}

单元测试

@Resource
private StudentRepository studentRepository ;
@Resource
private TeacherRepository teacherRepository ;


@Test
public void test() {
  Student student = new Student() ;
  student.setName("张三") ;
  Teacher teacher = new Teacher() ;
  teacher.setName("王老师") ;
  this.studentRepository.save(student) ;
  this.teacherRepository.save(teacher) ;
}

这样就分别保存到了不同的数据库中。