java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > SpringBoot中配置和使用多个数据源

在SpringBoot中配置和使用多个数据源方式

作者:csdn_aspnet

本文介绍如何在Spring Boot中配置多数据源,需通过配置类声明不同数据源bean,使用@ConfigurationProperties映射属性,并针对SpringDataJDBC和JPA分别配置JdbcTemplate与EntityManagerFactory,注意拆分包及@Primary注解的使用,同时可配置Hikari连接池

概述

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

在本教程中,我们将学习如何使用 Spring Boot 配置和使用多个数据源。

默认行为

让我们回忆一下在 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对象。 

扩展默认值

因此,要使用多个数据源,我们需要在 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();
}

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; 

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中声明的,而该类只需要注入单个数据源。通常,框架的某些部分可能不需要配置多个数据源。

配置 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  

结论

在本文中,我们学习了如何使用 Spring Boot 配置多个数据源。

我们发现我们需要一些配置,并且偏离标准时可能会出现陷阱,但最终这是可能的。 

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

您可能感兴趣的文章:
阅读全文