【Spring】使用动态数据源框架实现动态数据源切换

Java Spring

发布日期: 2025-02-24

更新日期: 2025-02-25

文章字数: 1.1k

阅读时长: 4 分

阅读次数:

问题背景

在上一篇文章中，我们讨论了如何在Spring中实现动态数据源切换。虽然手动实现动态数据源切换是可行的，但使用开源的第三方库可以大大简化开发过程，提高代码的可维护性和可读性。

本文将介绍如何使用开源的 dynamic-datasource 框架来实现动态数据源切换。

1. 添加依赖

首先，在 pom.xml 中添加 dynamic-datasource 的依赖：

<dependency>
    <groupId>com.github.dynamic-datasource</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>3.1.0</version> <!-- 请根据最新版本进行调整 -->
</dependency>

2. 配置数据源

在 application.yml 或 application.properties 中配置多个数据源。例如：

spring:
  datasource:
    dynamic:
      primary:
        url: jdbc:mysql://localhost:3306/primary_db
        username: root
        password: password
        driver-class-name: com.mysql.cj.jdbc.Driver
      secondary:
        url: jdbc:mysql://localhost:3306/secondary_db
        username: root
        password: password
        driver-class-name: com.mysql.cj.jdbc.Driver

3. 使用注解切换数据源

动态数据源的切换有两种方式:注解方式和硬编码方式。

3.1 注解方式切换

import com.baomidou.dynamic.datasource.annotation.DS;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @DS("primary") // 切换到主数据源
    public User getPrimaryUser(Long id) {
        // 从主数据源获取用户
    }

    @DS("secondary") // 切换到次数据源
    public User getSecondaryUser(Long id) {
        // 从次数据源获取用户
    }
}

3.2 硬编码方式切换

使用 DynamicDataSourceContextHolder 类进行手动切换:

import com.baomidou.dynamic.datasource.toolkit.DynamicDataSourceContextHolder;

@Service
public class UserService {

    public User getUser(Long id, String dataSource) {
        // 切换数据源
        DynamicDataSourceContextHolder.push(dataSource);
        try {
            // 执行业务操作
            return userMapper.selectById(id);
        } finally {
            // 清除数据源
            DynamicDataSourceContextHolder.poll();
        }
    }

    public void complexOperation() {
        // 查询主库
        DynamicDataSourceContextHolder.push("primary");
        User primaryUser = userMapper.selectById(1L);
        DynamicDataSourceContextHolder.poll();

        // 查询从库
        DynamicDataSourceContextHolder.push("secondary");
        User secondaryUser = userMapper.selectById(2L);
        DynamicDataSourceContextHolder.poll();

        // 更多复杂操作...
    }
}

硬编码方式的优点是更加灵活，可以在方法内部根据不同的业务逻辑动态切换数据源。但需要注意以下几点：

必须手动清理数据源，建议使用 try-finally 块。
嵌套切换时要注意顺序，先进后出。
代码侵入性较强，不如注解方式优雅。

4. 读写分离示例

如果需要实现读写分离，可以使用 @DS 注解结合 AOP 来实现。例如：

@Aspect
@Component
public class ReadWriteDataSourceAspect {

    @Pointcut("execution(* com.example.service..*.select*(..))" +
            "|| execution(* com.example.service..*.get*(..))" +
            "|| execution(* com.example.service..*.find*(..))")
    public void readPointcut() {}

    @Pointcut("execution(* com.example.service..*.insert*(..))" +
            "|| execution(* com.example.service..*.add*(..))" +
            "|| execution(* com.example.service..*.update*(..))" +
            "|| execution(* com.example.service..*.delete*(..))")
    public void writePointcut() {}

    @Before("readPointcut()")
    public void setReadDataSource() {
        DataSourceContextHolder.setDataSourceType("secondary");
    }

    @Before("writePointcut()")
    public void setWriteDataSource() {
        DataSourceContextHolder.setDataSourceType("primary");
    }

    @After("readPointcut() || writePointcut()")
    public void clearDataSource() {
        DataSourceContextHolder.clearDataSourceType();
    }
}

5. 使用示例

1. 在Service层使用

使用 @DSTransactional 注解来确保事务在切换数据源时能够正常工作：

import com.baomidou.dynamic.datasource.annotation.DSTransactional;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Autowired
    private UserMapper userMapper;

    @DS("primary")
    @DSTransactional // 使用动态数据源的事务注解
    public User getPrimaryUser(Long id) {
        return userMapper.selectById(id);
    }

    @DS("secondary")
    @DSTransactional // 使用动态数据源的事务注解
    public User getSecondaryUser(Long id) {
        return userMapper.selectById(id);
    }
}

2. 测试验证

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class UserServiceTest {

    @Autowired
    private UserService userService;

    @Test
    public void testGetUsers() {
        User primaryUser = userService.getPrimaryUser(1L);
        User secondaryUser = userService.getSecondaryUser(2L);
        // 验证用户是否正确
    }
}