baeldung 2024-05-11
1. 概述
典型的 Spring Boot 应用程序通常只使用一个关系型数据库来存储数据。但有时我们需要访问多个数据库。
在本教程中，我们将学习如何在 Spring Boot 中配置和使用多个数据源。
若想了解如何处理单个数据源，请参阅我们关于 Spring Data JPA 入门 的文章。
2. 默认行为
让我们先回顾一下在 application.yml 中声明单个数据源的典型方式：
spring:
datasource:
url: ...
username: ...
password: ...
driver-class-name: ...
在内部，Spring 会将这些配置映射到 org.springframework.boot.autoconfigure.jdbc.DataSourceProperties 的一个实例。
来看看它的实现：
@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties implements BeanClassLoaderAware, InitializingBean {
// ...
/**
* JDBC 驱动的全限定类名。默认根据 URL 自动检测。
*/
private String driverClassName;
/**
* 数据库的 JDBC URL。
*/
private String url;
/**
* 数据库登录用户名。
*/
private String username;
/**
* 数据库登录密码。
*/
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: ...
driver-class-name: ...
topics:
url: ...
username: ...
password: ...
driver-class-name: ...
然后我们可以使用 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 时，我们希望像下面这样使用 Repository（其中 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 连接池
如果要配置 HikariCP 连接池，只需在数据源定义上添加 @ConfigurationProperties 注解：
@Bean
@ConfigurationProperties("spring.datasource.todos.hikari")
public DataSource todosDataSource() {
return todosDataSourceProperties()
.initializeDataSourceBuilder()
.build();
}
然后可以在 application.properties 文件中添加如下配置：
spring.datasource.todos.hikari.connection-timeout=30000
spring.datasource.todos.hikari.idle-timeout=600000
spring.datasource.todos.hikari.max-lifetime=1800000
7. 结论
在本文中，我们学习了如何在 Spring Boot 中配置多个数据源。
我们看到，虽然这需要一些额外的配置，并且在偏离标准做法时可能会遇到一些陷阱，但最终是完全可以实现的。