在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 配置多个数据源。我们已经看到我们需要一些配置，并且在偏离标准时可能会出现陷阱——但最后，我们可以看到这是可能的。