Spring Boot 配置和使用多个数据源

我会带着你远行 2023-09-26 10:10 46阅读 0赞

### **1. 概述** ###

Spring Boot 应用程序的典型方案是将数据存储在单个关系数据库中。但我们有时需要访问多个数据库。

在本教程中，我们将学习如何通过弹簧启动配置和使用多个数据源。

要了解如何处理单个数据源，请查看我们对[Spring数据JPA的介绍][Spring_JPA]。

### **2. 默认行为** ###

让我们记住在弹簧启动中声明数据源在*应用程序.yml*中的样子：

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

在内部，Spring 将这些设置映射到*一*个实例。

让我们来看看实现：

@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();
        }
    
        @Bean
        @ConfigurationProperties("spring.datasource.topics")
        public DataSourceProperties topicsDataSourceProperties() {
            return new DataSourceProperties();
        }
    
    }

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

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

然后，我们可以使用*数据源属性*对象创建数据源：

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

### **4. 春季数据 JDBC** ###

使用春季数据 JDBC 时，我们还需要为每个*数据源*配置一个 *Jdbc 模板*实例：

@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. 春季数据JPA** ###

使用春季数据JPA时，我们希望使用如下所示的存储库，其中*Todo*是实体：

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

因此，我们需要为每个数据源声明*实体管理器*工厂：

@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*。

不幸的是，要注入*实体管理器工厂生成器*，我们需要将其中一个数据源声明为*@Primary*。

这是因为*实体管理器工厂生成器*是在 *org.springframework.boot.自动配置.orm.jpa.JpaBaseConfimatic 中声明的*，并且此类需要注入单个数据源。通常，框架的某些部分可能不需要配置多个数据源。

### **6. 配置光连接池** ###

如果要配置 [Hikari][]，只需向数据源定义添加*一个@ConfigurationProperties*：

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

然后，我们可以将以下行插入到*应用程序.properties*文件中：

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

### **7. 结论** ###

在本文中，我们学习了如何使用弹簧启动配置多个数据源。

我们看到我们需要一些配置，并且在偏离标准时可能存在陷阱，但最终是可能的。

与往常一样，所有代码都可以[在 GitHub 上使用][GitHub]。

[Spring_JPA]: https://www.baeldung.com/the-persistence-layer-with-spring-data-jpa
[Hikari]: https://www.baeldung.com/spring-boot-hikari
[GitHub]: https://github.com/eugenp/tutorials/tree/master/persistence-modules/spring-data-jdbc