在SpringBoot中配置和使用多个数据源方式
概述
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 配置多个数据源。
我们发现我们需要一些配置,并且偏离标准时可能会出现陷阱,但最终这是可能的。
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。
相关文章
解析Spring Data JPA的Audit功能之审计数据库变更
Spring Data JPA 提供了Audit审计功能,用来记录创建时间、创建人、修改时间、修改人等,下面来详细讲解下审计数据库变更2021-06-06
SpringBoot四大神器之Auto onfiguration的使用
本文主要介绍了SpringBoot四大神器之Auto Configuration,springboot auto configuration的本质就是自动配置spring的各种bean。感兴趣的可以了解一下2021-10-10
java线程池对象ThreadPoolExecutor的深入讲解
在我们的开发中“池”的概念并不罕见,有数据库连接池、线程池、对象池、常量池等等。下面这篇文章主要给大家介绍了关于java线程池对象ThreadPoolExecutor的相关资料,需要的朋友可以参考借鉴,下面来一起看看吧2018-09-09
Java中LinkedHashSet、LinkedHashMap源码详解
这篇文章主要介绍了Java中LinkedHashSet、LinkedHashMap源码详解,LinkedHashMap是一个以双向链表的方式将Entry节点链接起来的HashMap子类,它在HashMap的基础上实现了更多的功能,具有顺序存储和遍历的特性,需要的朋友可以参考下2023-09-09


最新评论