SpringBoot +DynamicDataSource切换多数据源的全过程

下面将为你介绍SpringBoot + DynamicDataSource切换多数据源的全过程。

1. 需求分析

在实际应用场景中，一个系统需要连接多个数据库的情况是十分常见的。SpringBoot + DynamicDataSource可以帮助我们方便地实现这一需求，通过对数据源进行动态切换，实现对多个数据库的访问。

2. 技术方案

SpringBoot是一个高度集成的开发框架，通过其提供的自动配置功能，可以很方便地搭建一个Web应用程序。DynamicDataSource则是一个开源的多数据源切换框架，它支持动态切换数据源，轻松处理多数据源的访问问题。

3. 实现步骤

以下是实现步骤的详细介绍。

3.1 创建SpringBoot工程

首先，我们需要创建一个基础的SpringBoot工程。在pom.xml中增加DynamicDataSource的依赖：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>2.5.3</version>
</dependency>

3.2 配置多数据源

在application.yml文件中配置多个数据源：

dynamic:
  datasource:
      datasource:
        master:
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://localhost:3306/db1?useSSL=false&useUnicode=true&characterEncoding=utf8
          username: root
          password: 123456
        slave:
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://localhost:3306/db2?useSSL=false&useUnicode=true&characterEncoding=utf8
          username: root
          password: 123456
      index: master # 默认数据源为master

3.3 创建DynamicDataSource

在SpringBoot工程中，我们需要创建一个DynamicDataSource类，继承AbstractRoutingDataSource类：

public class DynamicDataSource extends AbstractRoutingDataSource {

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

3.4 创建DataSourceContextHolder

创建DataSourceContextHolder类，用于存储当前线程所使用的数据源：

public class DataSourceContextHolder {

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

    public static void setDataSourceKey(String dataSourceKey) {
        contextHolder.set(dataSourceKey);
    }

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

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

3.5 创建切面

创建一个AOP切面类，用于动态切换数据源。在切面类中，使用@Around注解实现方法增强：

@Aspect
@Component
public class DynamicDataSourceAspect {

    @Around("@annotation(com.baomidou.dynamic.datasource.annotation.DS)")
    public Object switchDataSource(ProceedingJoinPoint point) throws Throwable {
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        DS ds = method.getAnnotation(DS.class); // 获取注解
        if (ds == null) {
            DataSourceContextHolder.setDataSourceKey("master"); // 默认使用master数据源
        } else {
            DataSourceContextHolder.setDataSourceKey(ds.value()); // 根据注解选择数据源
        }
        try {
            return point.proceed(); // 执行方法
        } finally {
            DataSourceContextHolder.clearDataSourceKey(); // 清除数据源
        }
    }
}

3.6 完成示例

最后，我们可以通过示例代码来检验我们的配置是否生效。

3.6.1 示例1：查询master数据源中的数据

在DAO类的查询方法上使用@DS注解：

@DS("master") // 指定数据源为master
public List<Map<String, Object>> getMasterData() {
    return jdbcTemplate.queryForList("SELECT * FROM user");
}

执行查询，可以获取到master数据源中的数据。

3.6.2 示例2：查询slave数据源中的数据

在DAO类的查询方法上使用@DS注解：

@DS("slave") // 指定数据源为slave
public List<Map<String, Object>> getSlaveData() {
    return jdbcTemplate.queryForList("SELECT * FROM book");
}

执行查询，可以获取到slave数据源中的数据。

4. 总结

SpringBoot + DynamicDataSource切换多数据源的过程中，我们需要配置多个数据源、创建DynamicDataSource和DataSourceContextHolder类、创建AOP切面等。通过合理使用这些组件，我们可以方便地实现对多个数据源的访问。