Spring Boot 动态配置数据源全解析

亲爱的小伙伴们，在求知的漫漫旅途中，若你对深度学习的奥秘、Java 与 Python 的奇妙世界，亦或是读研论文的撰写攻略有所探寻，那不妨给我一个小小的关注吧。我会精心筹备，在未来的日子里不定期地为大家呈上这些领域的知识宝藏与实用经验分享。每一个点赞，都如同春日里的一缕阳光，给予我满满的动力与温暖，让我们在学习成长的道路上相伴而行，共同进步✨。期待你的关注与点赞哟！

引言

在企业级应用开发中，单一数据源往往无法满足复杂业务场景的需求。例如，在多租户应用中，不同租户的数据可能存储在不同的数据库中；或者在进行数据库读写分离时，需要根据操作类型切换数据源。Spring Boot 提供了强大的扩展性，支持动态配置数据源，让开发者能够灵活应对这些复杂情况。本文将深入探讨 Spring Boot 中动态配置数据源的原理与实现方法。

动态配置数据源的应用场景

1. 多租户架构：每个租户拥有独立的数据库，通过动态配置数据源，应用可以根据租户标识连接到对应的数据库，实现数据隔离。
2. 读写分离：读操作和写操作分别连接到不同的数据库，提高系统的并发性能和数据读取效率。写操作通常连接到主数据库，以保证数据的一致性；读操作则可以分发到多个从数据库，减轻主数据库的压力。
3. 数据库迁移与升级：在进行数据库迁移或升级时，可能需要在不同阶段连接到不同的数据库。动态配置数据源使得切换数据库变得更加容易，减少对业务的影响。

实现步骤

引入依赖

首先，在pom.xml文件中添加相关依赖。除了基本的数据库连接依赖（如 MySQL 驱动），还需要引入动态数据源的核心依赖，如dynamic-datasource-spring-boot-starter。

    
    
        mysql
        mysql-connector-java
    
    
    
        com.baomidou
        dynamic-datasource-spring-boot-starter
        3.5.0
    

配置数据源信息

在application.yml文件中配置多个数据源的连接信息。例如，配置主数据源和从数据源：

spring:
  datasource:
    dynamic:
      primary: master
      strict: false
      datasource:
        master:
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://localhost:3306/master_db?useSSL=false
          username: root
          password: 123456
        slave:
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://localhost:3306/slave_db?useSSL=false
          username: root
          password: 123456

primary指定主数据源，strict表示是否严格匹配数据源，datasource下分别配置各个数据源的连接信息。

创建数据源注解

为了方便在代码中切换数据源，我们创建了自定义注解@DS。其代码如下：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface DS {
    String value() default "";
}

• 设计目的：@DS注解的主要目的是为了在业务代码中以一种简洁、直观的方式指定方法或类所使用的数据源。它避免了在代码中硬编码数据源切换逻辑，使得代码的可读性和维护性大大提高。

• 使用方式：该注解可以作用于方法和类两个层面。当作用于方法时，优先使用方法上的@DS注解指定的数据源；若作用于类上，则该类中的所有方法在没有单独指定数据源注解时，都将使用类上@DS注解指定的数据源。

• 属性作用：@DS注解只有一个value属性，用于指定要使用的数据源名称。该名称需与在application.yml文件中配置的数据源名称一致。例如，当value属性值为"master"时，被注解的方法或类将使用主数据源；若value属性值为"slave"，则使用从数据源。

配置数据源解析器

创建一个数据源解析器，用于根据注解解析数据源。例如：

import com.baomidou.dynamic.datasource.toolkit.DynamicDataSourceContextHolder;
import org.springframework.stereotype.Component;

@Component
public class DataSourceContextHolder {

    public static void setDataSource(String dataSource) {
        DynamicDataSourceContextHolder.push(dataSource);
    }

    public static void clearDataSource() {
        DynamicDataSourceContextHolder.poll();
    }
}

setDataSource方法用于设置当前使用的数据源，clearDataSource方法用于清除数据源设置。

使用动态数据源

在业务代码中，通过注解和数据源解析器来切换数据源。例如：

import com.example.demo.config.DataSourceContextHolder;
import com.example.demo.annotation.DS;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
public class UserService {

    @DS("master")
    @Transactional
    public void saveUser(User user) {
        // 保存用户到主数据库
    }

    @DS("slave")
    public User getUserById(Long id) {
        // 从从数据库获取用户
    }
}

在saveUser方法上使用@DS("master")注解，表示该方法使用主数据源；在getUserById方法上使用@DS("slave")注解，表示该方法使用从数据源。

注意事项

1. 事务管理：在使用动态数据源时，事务管理需要特别注意。如果一个事务中涉及多个不同数据源的操作，可能会出现分布式事务问题。可以使用分布式事务解决方案，如 Seata 来保证事务的一致性。
2. 数据源的动态添加与删除：在实际应用中，可能需要动态添加或删除数据源。这需要更复杂的配置和代码逻辑，例如在运行时修改配置文件并重新加载数据源。
3. 性能优化：动态切换数据源会带来一定的性能开销，尤其是在高并发场景下。需要合理配置数据源连接池参数，优化数据库查询语句，以提高系统性能。

总结

Spring Boot 的动态数据源配置为开发者提供了强大的灵活性，能够满足复杂业务场景的需求。通过引入依赖、配置数据源信息、创建数据源注解和解析器，我们可以轻松实现数据源的动态切换。在实际应用中，需要注意事务管理、数据源的动态操作以及性能优化等问题。希望本文能帮助你深入理解和掌握 Spring Boot 动态配置数据源的技术，在开发中灵活运用，提升系统的性能和扩展性。