1. 概述
Spring Boot 应用程序的一般场景是在单一关系数据库中存储数据。但有时我们需要访问多个数据库。本教程将指导您如何在 Spring Boot 中配置和使用多个数据源。
如果您想了解如何处理单个数据源，请参阅我们的Spring Data JPA 入门教程。
2. 默认行为
让我们回忆一下在 application.yml 中声明 Spring Boot 数据源的外观：
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 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();
}
4. Spring Data JDBC
在使用 Spring Data JDBC 时，我们也需要为每个数据源配置一个 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> {}
因此，我们需要为每个数据源声明 EntityManagerFactory 工厂：
@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 类中，而这个类需要单个数据源注入。通常，框架的一些部分可能不期望配置多个数据源。
6. 配置 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
7. 总结
在这篇文章中，我们学习了如何在 Spring Boot 中配置多个数据源。
我们了解到需要进行一些配置，并且在偏离标准时可能会遇到一些问题，但最终是可行的。
如往常一样，所有代码都可在GitHub 上找到。