Spring：动态数据源

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

目录

一、AbstractRoutingDataSource

二、AbstractRoutingDataSource的妙用

1. 动态数据源选择

2. 简化配置

3. 支持多种数据源 

4. 灵活的路由策略 

5. 集成与扩展 

6. 减少硬编码 

总结

---

提示：以下是本篇文章正文内容，下面案例可供参考

一、AbstractRoutingDataSource

AbstractRoutingDataSource 是 Spring 框架中的一个抽象类，它主要被用来实现动态数据源切换的功能。在多数据源的应用场景下，例如读写分离、数据分片、环境隔离等，AbstractRoutingDataSource 提供了一种灵活的方式来根据不同的条件选择不同的数据源

二、AbstractRoutingDataSource的妙用

1. 动态数据源选择

AbstractRoutingDataSource 允许你在运行时根据业务需求动态地选择不同的数据源。例如，在读写分离的场景中，你可以根据请求类型（读或写）选择不同的数据库连接

代码示例：

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;

public class DynamicDataSource extends AbstractRoutingDataSource {

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

    @Override
    protected Object determineCurrentLookupKey() {
        return contextHolder.get();
    }

    public static void setDataSourceType(String dataSourceType) {
        contextHolder.set(dataSourceType);
    }

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

在 Spring 配置中注册 DynamicDataSource 和实际的数据源 

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import javax.sql.DataSource;

@Configuration
public class DataSourceConfig {

    @Autowired
    private DataSourceProperties masterDataSourceProperties;

    @Autowired
    private DataSourceProperties slaveDataSourceProperties;

    @Bean(name = "masterDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.master")
    public DataSource masterDataSource() {
        return masterDataSourceProperties.initializeDataSourceBuilder().type(com.zaxxer.hikari.HikariDataSource.class).build();
    }

    @Bean(name = "slaveDataSource")
    @ConfigurationProperties(prefix = "spring.datasource.slave")
    public DataSource slaveDataSource() {
        return slaveDataSourceProperties.initializeDataSourceBuilder().type(com.zaxxer.hikari.HikariDataSource.class).build();
    }

    @Bean
    public DynamicDataSource dynamicDataSource(@Qualifier("masterDataSource") DataSource masterDataSource,
                                               @Qualifier("slaveDataSource") DataSource slaveDataSource) {
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        dynamicDataSource.setDefaultTargetDataSource(masterDataSource);
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put("master", masterDataSource);
        targetDataSources.put("slave", slaveDataSource);
        dynamicDataSource.setTargetDataSources(targetDataSources);
        return dynamicDataSource;
    }

    @Bean
    public DataSourceTransactionManager transactionManager(DynamicDataSource dynamicDataSource) {
        return new DataSourceTransactionManager(dynamicDataSource);
    }
}

在服务层使用 AOP 来控制数据源的切换

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

@Aspect
@Component
@Order(1)
public class DataSourceAspect {

    @Around("@annotation(readWrite)")
    public Object around(ProceedingJoinPoint point, ReadWrite readWrite) throws Throwable {
        String dataSourceType = readWrite.value();
        DynamicDataSource.setDataSourceType(dataSourceType);
        try {
            return point.proceed();
        } finally {
            DynamicDataSource.clearDataSourceType();
        }
    }
}

ReadWrite 是一个自定义的注解，可以被用在服务层的方法上，以指示方法应该使用哪个数据源

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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ReadWrite {
    String value();
}

在服务层的方法上使用这个注解

import org.springframework.stereotype.Service;

@Service
public class SomeService {

    @ReadWrite("master")
    public void writeOperation() {
        // 写操作
    }

    @ReadWrite("slave")
    public void readOperation() {
        // 读操作
    }
}

多数据源的配置
dynamic:
  datasource:
    slave1:
      driver-class-name: com.microsoft.sqlserver.jdbc.SQLServerDriver
      url: jdbc:sqlserver://localhost:1433;DatabaseName=renren_security
      username: sa
      password: 123456
    slave2:
      driver-class-name: org.postgresql.Driver
      url: jdbc:postgresql://localhost:5432/renren_security
      username: renren
      password: 123456

2. 简化配置

通过继承 AbstractRoutingDataSource 并重写 determineCurrentLookupKey() 方法，你可以基于任意的业务逻辑来决定使用哪个数据源，而不需要手动管理数据源的切换 

3. 支持多种数据源 

它可以同时管理多个 DataSource 实例，每个实例可以对应不同的数据库，这在处理大量数据或需要高可用性时非常有用 

4. 灵活的路由策略 

你可以根据不同的业务场景定制路由策略，例如根据用户角色、地理位置、系统负载等因素来选择数据源 

代码示例：

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;

import java.util.Date;

public class TimeBasedDataSource extends AbstractRoutingDataSource {

    @Override
    protected Object determineCurrentLookupKey() {
        Date now = new Date();
        int dayOfMonth = now.getDate();
        if (dayOfMonth % 2 == 0) {
            return "slave1";
        } else {
            return "slave2";
        }
    }
}

5. 集成与扩展 

AbstractRoutingDataSource 很容易与 Spring 的其他特性结合使用，如事务管理、JPA 等，同时也方便进行自定义扩展 

6. 减少硬编码 

使用 AbstractRoutingDataSource 可以避免在代码中硬编码数据源的选择逻辑，使得代码更加清晰和易于维护 

---

总结

每天进步一点点！