在Spring Boot中配置和使用多個數據源

一、概述

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 dataSourceProperties1() {
 return new DataSourceProperties();
 }

 @Bean
 @ConfigurationProperties("spring.datasource.topics")
 public DataSourceProperties dataSourceProperties1() {
 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 時，我們還需要為每個DataSource配置一個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

當使用 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(todosDataSource())
 .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中聲明的，並且此類需要注入單個數據源。通常，框架的某些部分可能不會期望配置多個數據源。

六，結論

在本文中，我們學習瞭如何使用 Spring Boot 配置多個數據源。我們已經看到我們需要一些配置，並且在偏離標準時可能會出現陷阱——但最後，我們可以看到這是可能的。