知識庫 / Spring / Spring Boot RSS 訂閱

1. 概述

典型的 Spring Boot 應用場景是將數據存儲在單個關係型數據庫中。但有時我們需要訪問多個數據庫。

在本教程中，我們將學習如何配置和使用 Spring Boot 中的多個數據源。

要了解如何處理單個數據源，請查看我們關於 Spring Data JPA 的介紹。

2. 默認行為

請記住在 Spring Boot 中聲明數據源的外觀，它在 application.yml 中是這樣的：

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

內部，Spring 將這些設置映射到一個 org.springframework.boot.autoconfigure.jdbc.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. 擴展默認配置

為了使用多個數據源，我們需要在 Spring 的應用程序上下文中聲明多個具有不同映射的 Bean。

我們可以通過使用配置類來實現這一點：

@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

當使用 Spring Data JDBC 時，我們也需要為每個 JdbcTemplate 配置一個 DataSource 實例：

@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

在使用 Spring Data JPA 時，我們希望使用類似於以下的倉庫，其中 Todo 是實體：

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

因此，我們需要為每個數據源聲明 EntityManager 工廠：

@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()));
    }

}

讓我們先來看一下需要注意的限制。

我們需要將軟件包拆分，以便每個數據源上有一個 @EnableJpaRepositories。

不幸的是，要注入 EntityManagerFactoryBuilder，我們需要將其中一個數據源聲明為 @Primary。

這是因為 EntityManagerFactoryBuilder 在 org.springframework.boot.autoconfigure.orm.jpa.JpaBaseConfiguration 中聲明，並且這個類需要注入單個數據源。通常，框架的某些部分可能不會期望配置多個數據源。

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 

7. 結論

在本文中，我們學習瞭如何使用 Spring Boot 配置多個數據源。

我們瞭解到需要進行一些配置，並且偏離標準配置可能會存在陷阱，但最終仍然可以實現。