在 Spring Boot 中配置和使用多个数据源-工具盒子

1、概览 {#1概览}

一般的 Spring Boot 应用通常只需要配置一个数据库，但是有时也可能需要访问多个数据源。本文将带你了解如何在 Spring Boot 中配置和使用多个数据源。

2、默认行为 {#2默认行为}

通常，我们会在 application.yml 中声明 Spring Boot 数据源，如下：

spring:
  datasource:
    url: ...
    username: ...
    password: ...
    driverClassname: ...

Spring 会将这些配置映射到 org.springframework.boot.autoconfigure.jdbc.DataSourceProperties 的实例。

DataSourceProperties 的定义如下：

@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties implements BeanClassLoaderAware, InitializingBean {

    // ...

    /**
     * Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.
     */
    private String driverClassName;

    /**
     * JDBC URL of the database.
     */
    private String url;

    /**
     * Login username of the database.
     */
    private String username;

    /**
     * Login password of the database.
     */
    private String password;

    // ...

}

其中 @ConfigurationProperties 注解可将配置属性自动映射到 Java 对象。

3、继承默认的行为 {#3继承默认的行为}

要使用多个数据源，我们可以在 Spring Application Context 中声明具有不同映射配置的多个 DataSourceProperties Bean。

通过配置类来定义 DataSourceProperties：

@Configuration
public class TodoDatasourceConfiguration {

    @Bean
    @ConfigurationProperties("spring.datasource.todos")
    public DataSourceProperties todosDataSourceProperties() {
        return new DataSourceProperties();
    }
}

@Configuration
public class TopicDatasourceConfiguration {

    @Bean
    @ConfigurationProperties("spring.datasource.topics")
    public DataSourceProperties topicsDataSourceProperties() {
        return new DataSourceProperties();
    }

}

数据源的配置必须如下所示：

spring:
  datasource:
    todos:
      url: ...
      username: ...
      password: ...
      driverClassName: ...
    topics:
      url: ...
      username: ...
      password: ...
      driverClassName: ...

然后，通过 DataSourceProperties 对象创建数据源：

@Bean
public DataSource todosDataSource() {
    return todosDataSourceProperties()
      .initializeDataSourceBuilder()
      .build();
}

@Bean
public DataSource topicsDataSource() {
    return topicsDataSourceProperties()
      .initializeDataSourceBuilder()
      .build();
}

4、Spring Data JDBC {#4spring-data-jdbc}

使用 Spring Data JDBC 时，还需要为每个数据源配置一个 JdbcTemplate 实例：

@Bean
public JdbcTemplate todosJdbcTemplate(@Qualifier("todosDataSource") DataSource dataSource) {
    return new JdbcTemplate(dataSource);
}

@Bean
public JdbcTemplate topicsJdbcTemplate(@Qualifier("topicsDataSource") DataSource dataSource) {
    return new JdbcTemplate(dataSource);
}

然后，可以通过指定 @Qualifier 来使用它们：

@Autowired
@Qualifier("topicsJdbcTemplate")
JdbcTemplate jdbcTemplate;

5、Spring Data JPA {#5spring-data-jpa}

使用 Spring Data JPA Repository 时。

如下，其中 Todo 是实体：

public interface TodoRepository extends JpaRepository<Todo, Long> {}

需要为每个数据源声明 EntityManager Factory：

@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(
  basePackageClasses = Todo.class,
  entityManagerFactoryRef = "todosEntityManagerFactory",
  transactionManagerRef = "todosTransactionManager"
)
public class TodoJpaConfiguration {

    @Bean
    public LocalContainerEntityManagerFactoryBean todosEntityManagerFactory(
      @Qualifier("todosDataSource") DataSource dataSource,
      EntityManagerFactoryBuilder builder) {
        return builder
          .dataSource(dataSource)
          .packages(Todo.class)
          .build();
    }

    @Bean
    public PlatformTransactionManager todosTransactionManager(
      @Qualifier("todosEntityManagerFactory") LocalContainerEntityManagerFactoryBean todosEntityManagerFactory) {
        return new JpaTransactionManager(Objects.requireNonNull(todosEntityManagerFactory.getObject()));
    }

}

有些限制需要注意！

需要拆分 package 以允许每个数据源都有一个 @EnableJpaRepositories。

为了获得注入的 EntityManagerFactoryBuilder，需要将其中一个数据源声明为 @Primary。

这是因为 EntityManagerFactoryBuilder 是在 org.springframework.boot.autoconfigure.orm.jpa.JpaBaseConfiguration 中声明的，并且该类需要注入一个单一的数据源。通常，框架的某些部分可能不支持配置多个数据源。

6、配置 Hikari 连接池 {#6配置-hikari-连接池}

如果想配置 Hikari 连接池，只需在数据源定义中添加 @ConfigurationProperties 即可：具体配置属性可以参考中文文档。

@Bean
@ConfigurationProperties("spring.datasource.todos.hikari")
public DataSource todosDataSource() {
    return todosDataSourceProperties()
      .initializeDataSourceBuilder()
      .build();
}

然后，在 application.properties 文件中插入以下几行：

spring.datasource.todos.hikari.connectionTimeout=30000 
spring.datasource.todos.hikari.idleTimeout=600000 
spring.datasource.todos.hikari.maxLifetime=1800000