Spring Boot中实现多数据源配置

大家好，我是微赚淘客系统3.0的小编，也是冬天不穿秋裤，天冷也要风度的程序猿！今天我们将探讨如何在Spring Boot应用中实现多数据源配置，以应对复杂业务需求下的数据管理挑战。

引言

在现代应用程序开发中，经常需要同时连接和管理多个数据库，例如主数据库、日志数据库、统计数据库等。Spring Boot作为一个流行的Java开发框架，提供了简便的方式来配置和管理多数据源，使得开发人员能够灵活处理不同数据源的连接和操作。本文将详细介绍如何利用Spring Boot实现多数据源配置，并提供具体的代码示例。

第一步：准备工作

在开始之前，请确保您已经配置好以下环境和工具：

  • JDK和Maven：确保已安装并配置好Java开发环境和项目构建工具。
  • IDE（如IntelliJ IDEA）：用于开发和调试Spring Boot应用。
  • 数据库服务：例如MySQL、PostgreSQL等，您可以根据实际需要准备多个数据库实例。
第二步：添加依赖
Maven依赖配置

首先，在您的Spring Boot项目的pom.xml文件中添加以下依赖，包括Spring Boot Starter和数据库驱动依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

<!-- MySQL 数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

<!-- HikariCP 连接池 -->
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
</dependency>
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
第三步：配置多数据源
数据源配置类

创建多个数据源配置类，分别配置不同的数据源连接信息。以下是一个示例，配置了两个数据源：主数据源（dataSourcePrimary）和第二个数据源（dataSourceSecondary）。

package cn.juwatech.multidatasourcedemo.config;

import javax.sql.DataSource;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;

@Configuration
public class DataSourceConfig {

    @Primary
    @Bean(name = "dataSourcePrimary")
    @ConfigurationProperties(prefix = "spring.datasource.primary")
    public DataSource primaryDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "dataSourceSecondary")
    @ConfigurationProperties(prefix = "spring.datasource.secondary")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.

在上述示例中，我们使用了Spring Boot的@ConfigurationProperties注解来绑定配置文件中的数据源属性（例如spring.datasource.primary和spring.datasource.secondary）到对应的DataSource对象。

第四步：配置多数据源属性
application.properties配置

在application.properties或application.yml文件中，配置每个数据源的连接信息。示例配置如下：

# 主数据源配置
spring.datasource.primary.url=jdbc:mysql://localhost:3306/db_primary
spring.datasource.primary.username=root
spring.datasource.primary.password=root

# 第二个数据源配置
spring.datasource.secondary.url=jdbc:mysql://localhost:3306/db_secondary
spring.datasource.secondary.username=root
spring.datasource.secondary.password=root
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
第五步：使用多数据源
Repository接口配置

在定义Repository接口时，通过@Qualifier注解指定要使用的数据源。例如：

package cn.juwatech.multidatasourcedemo.repository.primary;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

import cn.juwatech.multidatasourcedemo.model.primary.User;

@Repository
@Qualifier("dataSourcePrimary")
public interface UserRepositoryPrimary extends JpaRepository<User, Long> {

}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.

在上述示例中，我们使用了@Qualifier("dataSourcePrimary")来指定该Repository接口使用名为"dataSourcePrimary"的数据源，从而实现对主数据源的操作。

第六步：测试多数据源配置
编写测试用例

编写测试用例，验证多数据源配置的正确性和可用性。例如，编写一个简单的Service类来测试从不同数据源中读取数据。

package cn.juwatech.multidatasourcedemo.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;

import cn.juwatech.multidatasourcedemo.model.primary.User;
import cn.juwatech.multidatasourcedemo.repository.primary.UserRepositoryPrimary;
import cn.juwatech.multidatasourcedemo.repository.secondary.UserRepositorySecondary;

@Service
public class UserService {

    @Autowired
    @Qualifier("dataSourcePrimary")
    private UserRepositoryPrimary userRepositoryPrimary;

    @Autowired
    @Qualifier("dataSourceSecondary")
    private UserRepositorySecondary userRepositorySecondary;

    public User getUserFromPrimaryDataSource(Long id) {
        return userRepositoryPrimary.findById(id).orElse(null);
    }

    public User getUserFromSecondaryDataSource(Long id) {
        return userRepositorySecondary.findById(id).orElse(null);
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
  • 20.
  • 21.
  • 22.
  • 23.
  • 24.
  • 25.
  • 26.
  • 27.
  • 28.
  • 29.
结语

通过本文的介绍，您学习了如何在Spring Boot应用中实现多数据源配置。通过配置多个数据源、使用@Qualifier注解和适当的配置文件，可以有效地管理和利用多个数据库实例，满足复杂业务场景下对数据管理的需求。