快捷導(dǎo)航

在SpringBoot中配置和使用多個(gè)數(shù)據(jù)源方式

更新時(shí)間：2025年08月25日 11:17:07 作者：csdn_aspnet

本文介紹如何在Spring?Boot中配置多數(shù)據(jù)源,需通過配置類聲明不同數(shù)據(jù)源bean,使用@ConfigurationProperties映射屬性,并針對(duì)SpringDataJDBC和JPA分別配置JdbcTemplate與EntityManagerFactory,注意拆分包及@Primary注解的使用,同時(shí)可配置Hikari連接池

概述

Spring Boot 應(yīng)用程序的典型場(chǎng)景是將數(shù)據(jù)存儲(chǔ)在單個(gè)關(guān)系數(shù)據(jù)庫中。但有時(shí)我們需要訪問多個(gè)數(shù)據(jù)庫。

在本教程中，我們將學(xué)習(xí)如何使用 Spring Boot 配置和使用多個(gè)數(shù)據(jù)源。

默認(rèn)行為

讓我們回憶一下在 Spring Boot 中在application.yml中聲明數(shù)據(jù)源的樣子：

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

在內(nèi)部，Spring 將這些設(shè)置映射到org.springframework.boot.autoconfigure.jdbc.DataSourceProperties的實(shí)例。

讓我們看一下實(shí)現(xiàn)過程：

@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;

    // ...

}

我們應(yīng)該指出@ConfigurationProperties注釋，它自動(dòng)將配置的屬性映射到Java對(duì)象。

擴(kuò)展默認(rèn)值

因此，要使用多個(gè)數(shù)據(jù)源，我們需要在 Spring 的應(yīng)用程序上下文中聲明具有不同映射的多個(gè) bean。

我們可以通過使用配置類來實(shí)現(xiàn)這一點(diǎn)：

@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();
    }

}

數(shù)據(jù)源的配置必須如下所示：

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

然后我們可以使用DataSourceProperties對(duì)象創(chuàng)建數(shù)據(jù)源：

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

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

Spring Data JDBC

使用 Spring Data JDBC 時(shí)，我們還需要為每個(gè)DataSource配置一個(gè)JdbcTemplate實(shí)例：

@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

當(dāng)使用 Spring Data JPA 時(shí)，我們希望使用如下所示的存儲(chǔ)庫，其中Todo是實(shí)體：

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

因此，我們需要為每個(gè)數(shù)據(jù)源聲明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()));
    }

}

讓我們看看我們應(yīng)該注意的一些限制。

我們需要拆分包以允許每個(gè)數(shù)據(jù)源使用一個(gè)@EnableJpaRepositories 。

不幸的是，為了注入EntityManagerFactoryBuilder，我們需要將其中一個(gè)數(shù)據(jù)源聲明為@Primary。

這是因?yàn)镋ntityManagerFactoryBuilder是在org.springframework.boot.autoconfigure.orm.jpa.JpaBaseConfiguration中聲明的，而該類只需要注入單個(gè)數(shù)據(jù)源。通常，框架的某些部分可能不需要配置多個(gè)數(shù)據(jù)源。

配置 Hikari 連接池

如果我們想要配置Hikari，我們只需要在數(shù)據(jù)源定義中添加@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