Spring(AbstractRoutingDataSource)实现动态数据源切换示例

下面为你详细讲解Spring中如何使用抽象路由数据源（AbstractRoutingDataSource）实现动态数据源切换，包含两个示例。

1. 动态数据源切换

动态数据源切换指的是可以动态地选择使用哪个数据源来进行数据访问，一般用于多数据源的情况下。使用抽象路由数据源（AbstractRoutingDataSource）可以方便地实现数据源动态切换。

2. 抽象路由数据源（AbstractRoutingDataSource）

抽象路由数据源（AbstractRoutingDataSource）是Spring提供的一个抽象类，它继承了Spring的SimpleDriverDataSource，并实现了Spring的DataSource接口，在实现过程中通过维护一个ThreadLocal变量来存储当前使用的数据源。

使用抽象路由数据源（AbstractRoutingDataSource）来实现动态数据源切换，需要继承该类并重写其中的determineCurrentLookupKey方法，该方法返回一个字符串，用来表示当前要使用哪个数据源。

3. 示例一

下面是一个示例，演示如何实现基于注解的动态数据源切换。

3.1 首先创建两个数据源

@Configuration
public class DataSourceConfig {
    @Bean
    @Primary
    @ConfigurationProperties("spring.datasource.master")
    public DataSource masterDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean
    @ConfigurationProperties("spring.datasource.slave")
    public DataSource slaveDataSource() {
        return DataSourceBuilder.create().build();
    }
}

3.2 创建动态数据源

@Configuration
public class DynamicDataSourceConfig {
    @Bean
    public AbstractRoutingDataSource routingDataSource(DataSource masterDataSource, DataSource slaveDataSource) {
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put("master", masterDataSource);
        targetDataSources.put("slave", slaveDataSource);
        AbstractRoutingDataSource routingDataSource = new AbstractRoutingDataSource() {
            @Override
            protected Object determineCurrentLookupKey() {
                return DataSourceContextHolder.getDataSourceType();
            }
        };
        routingDataSource.setTargetDataSources(targetDataSources);
        routingDataSource.setDefaultTargetDataSource(masterDataSource);
        return routingDataSource;
    }
}

3.3 创建数据源上下文

public class DataSourceContextHolder {
    private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();

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

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

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

3.4 创建注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DataSource {
    String value() default "master";
}

3.5 创建切面

@Aspect
@Component
public class DataSourceAspect {
    @Before("@annotation(dataSource)")
    public void changeDataSource(JoinPoint point, DataSource dataSource) {
        DataSourceContextHolder.setDataSourceType(dataSource.value());
    }

    @After("@annotation(dataSource)")
    public void restoreDataSource(JoinPoint point, DataSource dataSource) {
        DataSourceContextHolder.clearDataSourceType();
    }
}

3.6 使用示例

@Service
public class UserService {
    @Autowired
    private UserDao userDao;

    @Transactional
    @DataSource("master")
    public void save(User user) {
        userDao.save(user);
    }

    @Transactional(readOnly = true)
    @DataSource("slave")
    public List<User> findAll() {
        return userDao.findAll();
    }
}

4. 示例二

下面是另一个示例，演示如何通过配置文件来实现基于注解的动态数据源切换。

4.1 创建动态数据源

public class RoutingDataSource extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return DataSourceContextHolder.getDataSourceType();
    }
}

4.2 创建数据源上下文

public class DataSourceContextHolder {
    private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();

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

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

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

4.3 配置文件

spring:
  datasource:
    type: class
    driver-class-name: com.mysql.jdbc.Driver
    master:
        url: jdbc:mysql://localhost:3306/db_master?useSSL=false
        username: root
        password: root
    slave:
        url: jdbc:mysql://localhost:3306/db_slave?useSSL=false
        username: root
        password: root

datasource:
    type: routing
    datasource:
        master:
            - jdbc:mysql://localhost:3306/db_master?useSSL=false
            - root
            - root
        slave:
            - jdbc:mysql://localhost:3306/db_slave?useSSL=false
            - root
            - root

4.4 读取配置

@Configuration
@EnableConfigurationProperties(DataSourceProperties.class)
public class DataSourceConfig {
    @Bean
    @Primary
    public DataSource masterDataSource(DataSourceProperties properties) {
        String url = properties.getDatasource().get("master").get(0);
        String username = properties.getDatasource().get("master").get(1);
        String password = properties.getDatasource().get("master").get(2);
        return DataSourceBuilder.create().url(url).username(username).password(password).build();
    }

    @Bean
    public DataSource slaveDataSource(DataSourceProperties properties) {
        String url = properties.getDatasource().get("slave").get(0);
        String username = properties.getDatasource().get("slave").get(1);
        String password = properties.getDatasource().get("slave").get(2);
        return DataSourceBuilder.create().url(url).username(username).password(password).build();
    }

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

4.5 创建注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DataSource {
    String value() default "master";
}

4.6 创建切面

@Aspect
@Component
public class DataSourceAspect {
    @Before("@annotation(dataSource)")
    public void changeDataSource(JoinPoint point, DataSource dataSource) {
        DataSourceContextHolder.setDataSourceType(dataSource.value());
    }

    @After("@annotation(dataSource)")
    public void restoreDataSource(JoinPoint point, DataSource dataSource) {
        DataSourceContextHolder.clearDataSourceType();
    }
}

4.7 使用示例

@Service
public class UserService {
    @Autowired
    private UserDao userDao;

    @Transactional
    @DataSource("master")
    public void save(User user) {
        userDao.save(user);
    }

    @Transactional(readOnly = true)
    @DataSource("slave")
    public List<User> findAll() {
        return userDao.findAll();
    }
}

以上就是使用抽象路由数据源（AbstractRoutingDataSource）实现动态数据源切换的两个示例，具体使用方法可参考代码。