怎么使用SpringBoot配置多数据源

发布时间：2022-04-11 14:00:56 作者：iii
来源：亿速云阅读：255

怎么使用SpringBoot配置多数据源

在现代企业级应用开发中，数据库是存储和管理数据的核心组件。随着业务需求的不断增长，单一数据源往往无法满足复杂的业务场景，因此多数据源配置成为了一个常见的需求。Spring Boot 流行的 Java 开发框架，提供了灵活且强大的多数据源配置支持。本文将详细介绍如何在 Spring Boot 项目中配置和使用多数据源。

引言

在传统的单数据源应用中，所有的数据库操作都通过一个数据源进行。然而，随着业务的发展，单一数据源可能无法满足以下需求：

读写分离：为了提高数据库的读取性能，通常会将读操作和写操作分离到不同的数据库实例上。
分库分表：当数据量非常大时，单一数据库可能无法承载，此时需要将数据分散到多个数据库或表中。
多租户架构：在多租户应用中，每个租户可能需要独立的数据库实例。
异构数据源：有些应用可能需要同时访问不同类型的数据库，如关系型数据库和 NoSQL 数据库。

为了应对这些需求，Spring Boot 提供了多数据源配置的支持。通过合理配置，开发者可以在同一个应用中轻松管理多个数据源。

多数据源的应用场景

1. 读写分离

读写分离是一种常见的数据库优化策略。通过将读操作和写操作分离到不同的数据库实例上，可以有效减轻主数据库的负载，提高系统的整体性能。在 Spring Boot 中，可以通过配置多个数据源来实现读写分离。

2. 分库分表

当数据量非常大时，单一数据库可能无法承载。此时，可以通过分库分表的方式将数据分散到多个数据库或表中。Spring Boot 的多数据源配置可以轻松支持这种场景。

3. 多租户架构

在多租户应用中，每个租户可能需要独立的数据库实例。通过配置多数据源，可以为每个租户分配独立的数据源，从而实现数据的隔离。

4. 异构数据源

有些应用可能需要同时访问不同类型的数据库，如关系型数据库和 NoSQL 数据库。Spring Boot 的多数据源配置可以支持这种异构数据源的场景。

Spring Boot 多数据源配置基础

在 Spring Boot 中，多数据源的配置主要依赖于 DataSource 和 JdbcTemplate 或 EntityManager 等组件。通过配置多个 DataSource，可以为每个数据源分配独立的连接池、事务管理器等。

1. 数据源（DataSource）

DataSource 是 Java 中用于管理数据库连接的标准接口。Spring Boot 默认使用 HikariCP 作为连接池实现，但也可以选择其他连接池，如 Druid、Tomcat JDBC 等。

2. 事务管理器（TransactionManager）

事务管理器用于管理数据库事务。在多数据源场景下，每个数据源通常需要对应一个独立的事务管理器。Spring Boot 提供了 PlatformTransactionManager 接口，常用的实现类有 DataSourceTransactionManager 和 JpaTransactionManager。

3. MyBatis 或 JPA

MyBatis 和 JPA 是两种常见的 ORM 框架。在多数据源场景下，需要为每个数据源配置独立的 SqlSessionFactory 或 EntityManagerFactory。

配置多数据源的步骤

4.1 添加依赖

首先，在 pom.xml 中添加 Spring Boot 和数据库相关的依赖。以 MySQL 为例：

<dependencies>
    <!-- Spring Boot Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>

    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Spring Boot Starter Data JPA -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>

    <!-- MySQL Connector -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>

    <!-- HikariCP -->
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
    </dependency>

    <!-- MyBatis Spring Boot Starter -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.1.4</version>
    </dependency>
</dependencies>

4.2 配置数据源

在 application.yml 或 application.properties 中配置多个数据源。以下是一个 application.yml 的示例：

spring:
  datasource:
    primary:
      jdbc-url: jdbc:mysql://localhost:3306/primary_db
      username: root
      password: root
      driver-class-name: com.mysql.cj.jdbc.Driver
      hikari:
        maximum-pool-size: 10
        minimum-idle: 2
    secondary:
      jdbc-url: jdbc:mysql://localhost:3306/secondary_db
      username: root
      password: root
      driver-class-name: com.mysql.cj.jdbc.Driver
      hikari:
        maximum-pool-size: 10
        minimum-idle: 2

4.3 创建数据源配置类

接下来，创建数据源配置类，分别为每个数据源配置 DataSource、JdbcTemplate 或 EntityManagerFactory。

@Configuration
public class DataSourceConfig {

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

    @Bean(name = "secondaryDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.secondary")
    public DataSource secondaryDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "primaryJdbcTemplate")
    public JdbcTemplate primaryJdbcTemplate(@Qualifier("primaryDataSource") DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }

    @Bean(name = "secondaryJdbcTemplate")
    public JdbcTemplate secondaryJdbcTemplate(@Qualifier("secondaryDataSource") DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }
}

4.4 配置事务管理器

为每个数据源配置独立的事务管理器。

@Configuration
public class TransactionManagerConfig {

    @Bean(name = "primaryTransactionManager")
    public PlatformTransactionManager primaryTransactionManager(@Qualifier("primaryDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    @Bean(name = "secondaryTransactionManager")
    public PlatformTransactionManager secondaryTransactionManager(@Qualifier("secondaryDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
}

4.5 配置 MyBatis 或 JPA

如果使用 MyBatis 或 JPA，还需要为每个数据源配置独立的 SqlSessionFactory 或 EntityManagerFactory。

MyBatis 配置

@Configuration
@MapperScan(basePackages = "com.example.mapper.primary", sqlSessionFactoryRef = "primarySqlSessionFactory")
public class PrimaryMyBatisConfig {

    @Bean(name = "primarySqlSessionFactory")
    public SqlSessionFactory primarySqlSessionFactory(@Qualifier("primaryDataSource") DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource);
        return sessionFactory.getObject();
    }

    @Bean(name = "primarySqlSessionTemplate")
    public SqlSessionTemplate primarySqlSessionTemplate(@Qualifier("primarySqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

JPA 配置

@Configuration
@EnableJpaRepositories(
        basePackages = "com.example.repository.primary",
        entityManagerFactoryRef = "primaryEntityManagerFactory",
        transactionManagerRef = "primaryTransactionManager"
)
public class PrimaryJpaConfig {

    @Bean(name = "primaryEntityManagerFactory")
    public LocalContainerEntityManagerFactoryBean primaryEntityManagerFactory(
            EntityManagerFactoryBuilder builder,
            @Qualifier("primaryDataSource") DataSource dataSource) {
        return builder
                .dataSource(dataSource)
                .packages("com.example.entity.primary")
                .persistenceUnit("primary")
                .build();
    }

    @Bean(name = "primaryTransactionManager")
    public PlatformTransactionManager primaryTransactionManager(
            @Qualifier("primaryEntityManagerFactory") EntityManagerFactory entityManagerFactory) {
        return new JpaTransactionManager(entityManagerFactory);
    }
}

多数据源的动态切换

在某些场景下，可能需要根据业务逻辑动态切换数据源。Spring Boot 提供了 AbstractRoutingDataSource 来实现数据源的动态切换。

1. 创建动态数据源

public class DynamicDataSource extends AbstractRoutingDataSource {

    @Override
    protected Object determineCurrentLookupKey() {
        return DataSourceContextHolder.getDataSource();
    }
}

2. 创建数据源上下文持有者

public class DataSourceContextHolder {

    private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();

    public static void setDataSource(String dataSource) {
        contextHolder.set(dataSource);
    }

    public static String getDataSource() {
        return contextHolder.get();
    }

    public static void clearDataSource() {
        contextHolder.remove();
    }
}

3. 配置动态数据源

@Configuration
public class DynamicDataSourceConfig {

    @Bean(name = "dynamicDataSource")
    public DataSource dynamicDataSource(
            @Qualifier("primaryDataSource") DataSource primaryDataSource,
            @Qualifier("secondaryDataSource") DataSource secondaryDataSource) {
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put("primary", primaryDataSource);
        targetDataSources.put("secondary", secondaryDataSource);

        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        dynamicDataSource.setDefaultTargetDataSource(primaryDataSource);
        dynamicDataSource.setTargetDataSources(targetDataSources);
        return dynamicDataSource;
    }

    @Bean(name = "dynamicTransactionManager")
    public PlatformTransactionManager dynamicTransactionManager(@Qualifier("dynamicDataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
}

4. 使用动态数据源

在需要切换数据源的地方，调用 DataSourceContextHolder.setDataSource() 方法即可。

@Service
public class UserService {

    @Autowired
    private JdbcTemplate jdbcTemplate;

    public void switchDataSource(String dataSource) {
        DataSourceContextHolder.setDataSource(dataSource);
        // 执行数据库操作
        jdbcTemplate.queryForList("SELECT * FROM user");
        DataSourceContextHolder.clearDataSource();
    }
}

多数据源的事务管理

在多数据源场景下，事务管理变得更加复杂。Spring Boot 提供了 ChainedTransactionManager 来支持跨数据源的事务管理。

1. 配置链式事务管理器

@Configuration
public class ChainedTransactionManagerConfig {

    @Bean(name = "chainedTransactionManager")
    public PlatformTransactionManager chainedTransactionManager(
            @Qualifier("primaryTransactionManager") PlatformTransactionManager primaryTransactionManager,
            @Qualifier("secondaryTransactionManager") PlatformTransactionManager secondaryTransactionManager) {
        return new ChainedTransactionManager(primaryTransactionManager, secondaryTransactionManager);
    }
}

2. 使用链式事务管理器

在需要跨数据源事务管理的地方，使用 @Transactional 注解并指定 chainedTransactionManager。

@Service
public class UserService {

    @Autowired
    private JdbcTemplate primaryJdbcTemplate;

    @Autowired
    private JdbcTemplate secondaryJdbcTemplate;

    @Transactional(transactionManager = "chainedTransactionManager")
    public void transferMoney(int userId, int amount) {
        primaryJdbcTemplate.update("UPDATE user SET balance = balance - ? WHERE id = ?", amount, userId);
        secondaryJdbcTemplate.update("UPDATE user SET balance = balance + ? WHERE id = ?", amount, userId);
    }
}

多数据源的性能优化

在多数据源场景下，性能优化尤为重要。以下是一些常见的优化策略：

1. 连接池优化

合理配置连接池参数，如最大连接数、最小空闲连接数等，可以有效提高数据库操作的性能。

2. 缓存

使用缓存可以减少数据库的访问次数，从而提高系统的整体性能。常见的缓存方案有 Redis、Ehcache 等。

3. 异步处理

将耗时的数据库操作异步化，可以提高系统的响应速度。常见的异步处理方案有 Spring 的 @Async 注解、消息队列等。

4. 数据库分片

当数据量非常大时，可以通过数据库分片的方式将数据分散到多个数据库实例上，从而提高数据库的读写性能。

常见问题与解决方案

1. 数据源切换失败

问题描述：在动态切换数据源时，数据源切换失败。

解决方案：检查 DataSourceContextHolder 的实现，确保在每次数据库操作后都清除了数据源上下文。

2. 事务管理失效

问题描述：在多数据源场景下，事务管理失效。

解决方案：确保为每个数据源配置了独立的事务管理器，并在需要跨数据源事务管理的地方使用 ChainedTransactionManager。

3. 性能瓶颈

问题描述：在多数据源场景下，系统性能出现瓶颈。

解决方案：优化连接池配置、使用缓存、异步处理等策略来提高系统性能。

总结

通过本文的介绍，我们详细了解了如何在 Spring Boot 项目中配置和使用多数据源。多数据源配置不仅可以满足复杂的业务需求，还可以提高系统的性能和可扩展性。在实际开发中，开发者应根据具体的业务场景选择合适的配置方案，并进行合理的性能优化。

希望本文能帮助你在 Spring Boot 项目中成功配置和使用多数据源。如果你有任何问题或建议，欢迎在评论区留言讨论。

怎么使用SpringBoot配置多数据源

怎么使用SpringBoot配置多数据源

目录

引言

多数据源的应用场景

1. 读写分离

2. 分库分表

3. 多租户架构

4. 异构数据源

Spring Boot 多数据源配置基础

1. 数据源（DataSource）

2. 事务管理器（TransactionManager）

3. MyBatis 或 JPA

配置多数据源的步骤

4.1 添加依赖

4.2 配置数据源

4.3 创建数据源配置类

4.4 配置事务管理器

4.5 配置 MyBatis 或 JPA

MyBatis 配置

JPA 配置

多数据源的动态切换

1. 创建动态数据源

2. 创建数据源上下文持有者

3. 配置动态数据源

4. 使用动态数据源

多数据源的事务管理

1. 配置链式事务管理器

2. 使用链式事务管理器

多数据源的性能优化

1. 连接池优化

2. 缓存

3. 异步处理

4. 数据库分片

常见问题与解决方案

1. 数据源切换失败

2. 事务管理失效

3. 性能瓶颈

总结

相关阅读