Spring AbstractRoutingDatasource 动态数据源的实例讲解

更新时间：2021年07月22日 09:29:47 作者：梦想画家

本文介绍如何使用 Spring AbstractRoutingDatasource 基于上下文动态切换数据源，因此我们会让查找数据源逻辑独立于数据访问之外

Spring AbstractRoutingDatasource 动态数据源

数据源上下文

AbstractRoutingDatasource 需要信息决定路由到那个数据源，该信息我们称为上下文。可以市任何对象，下面示例我们使用枚举 ClientDatabase 作为上下文：

public enum ClientDatabase {
    CLIENT_A, CLIENT_B
}

值得注意的是，实际中上下文可以是任何有意义的领域对象。如 Environment 定义上下文，在这种上下文中枚举可以包括 PRODUCTION, DEVELOPMENT, and TESTING.

上下文持有者 ( ContextHolder )

上下文持有者实现是存储当前上下文的容器，如 ThreadLocal 对象。除了包括上下文引用外，还应该包括set , get , clear 静态方法，AbstractRoutingDatasource 将查询 ContextHolder 获得上下文，然后使用上下文查找实际的数据源。

这里最重要的是使用 ThreadLocal ，让上下文绑定只当前执行线程。使用这种方法就是为了保障当数据访问逻辑跨多个数据源使用事务：

public class ClientDatabaseContextHolder {
    private static ThreadLocal<ClientDatabase> CONTEXT  = new ThreadLocal<>();
    public static void set(ClientDatabase clientDatabase) {
        Assert.notNull(clientDatabase, "clientDatabase cannot be null");
        CONTEXT.set(clientDatabase);
    }
    public static ClientDatabase getClientDatabase() {
        return CONTEXT.get();
    }
    public static void clear() {
        CONTEXT.remove();
    }
}

数据源路由器

下面定义 ClientDataSourceRouter 继承 AbstractRoutingDataSource. 重写方法 determineCurrentLookupKey ，查询 ClientDatabaseContextHolder 获得当前上下文。AbstractRoutingDataSource 帮我们处理了其他逻辑，仅了解它透明地返回了合适的数据源：

public class ClientDataSourceRouter extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return ClientDatabaseContextHolder.getClientDatabase();
    }
}

配置

下面利用Map上下文存储DataSource对象，用于配置 AbstractRoutingDataSource 。当然也可以指定缺省数据源，当没有设定上下文时选择缺省数据源。

@Configuration
public class RoutingTestConfiguration {
    @Bean
    public ClientService clientService() {
        return new ClientService(new ClientDao(clientDatasource()));
    }
 
    @Bean
    public DataSource clientDatasource() {
        Map<Object, Object> targetDataSources = new HashMap<>();
        DataSource clientADatasource = clientADatasource();
        DataSource clientBDatasource = clientBDatasource();
        targetDataSources.put(ClientDatabase.CLIENT_A, clientADatasource);
        targetDataSources.put(ClientDatabase.CLIENT_B, clientBDatasource);
        ClientDataSourceRouter clientRoutingDatasource  = new ClientDataSourceRouter();
        clientRoutingDatasource.setTargetDataSources(targetDataSources);
        clientRoutingDatasource.setDefaultTargetDataSource(clientADatasource);        
        return clientRoutingDatasource;
    }
    // ...
}

我们可以使用不同方式的数据源，但典型场景时运行时创建，或使用JNDI方式查找。下面定义示例的Dao类，它依赖动态数据源进行实例化：

public class ClientDao {
    private static final String SQL_GET_CLIENT_NAME = "select name from client";
    private final JdbcTemplate jdbcTemplate;
    public ClientDao(DataSource datasource) {
        this.jdbcTemplate = new JdbcTemplate(datasource);
    }
    public String getClientName() {
        return this.jdbcTemplate.query(SQL_GET_CLIENT_NAME, rowMapper).get(0);
    }
    private static RowMapper<String> rowMapper = (rs, rowNum) -> {
        return rs.getString("name");
    };
}

使用动态数据源

实际使用时，首先设置上下文，然后再执行业务操作。我们定义业务层，其中业务方法包括上下文作为参数。在执行业务之前设置上下文，调用之后清除上下文：

public class ClientService {
    private final ClientDao clientDao;
    public ClientService(ClientDao clientDao) {
        this.clientDao = clientDao;
    }
    public String getClientName(ClientDatabase clientDb) {
        ClientDatabaseContextHolder.set(clientDb);
        String clientName = this.clientDao.getClientName();
        ClientDatabaseContextHolder.clear();
        return clientName;
    }
}

总结

本文通过示例解释如何使用 Spring AbstractRoutingDataSource 实现动态数据源切换。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Java中提供synchronized后为什么还要提供Lock
这篇文章主要介绍了Java中提供synchronized后为什么还要提供Lock，在Java中提供了synchronized关键字来保证只有一个线程能够访问同步代码块，下文更多相关资料需要的小伙伴可以参考一下
2022-03-03
Java使用Jdom读取xml解析实例
这篇文章主要介绍了Java使用Jdom读取xml解析,以实例形式较为详细的分析了Jdom操作XML文件实现读取操作的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-10-10
Go并发编程中使用channel的方法
本文给大家介绍Go并发编程中使用channel的方法，通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧
2021-11-11
SpringBoot应用启动内置Tomcat的过程源码分析
这篇文章主要介绍了SpringBoot应用启动内置Tomcat的过程分析,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-07-07
一个简单的Spring容器初始化流程详解
这篇文章主要给大家介绍了一个简单的Spring容器初始化流程的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-01-01
详解SpringBoot Start组件开发之记录接口日志信息
这篇文章主要为大家介绍了SpringBoot-Start组件开发之记录接口日志信息详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-04-04
简单了解Spring中常用工具类
这篇文章主要介绍了简单了解Spring中常用工具类，非常全面，具有一定参考价值，需要的朋友可以了解下。
2017-10-10
Java中Lambda表达式的使用详细教程
这篇文章将通过示例为大家详细展示Java中Lambda表达式的用法，同时也会介绍Lambda的相关知识，感兴趣的小伙伴可以跟随小编一起学习一下
2022-05-05
Java设计模式之java备忘录模式详解
这篇文章主要介绍了JAVA设计模式之备忘录模式,简单说明了备忘录模式的概念、原理并结合实例形式分析了java备忘录模式的具体定义及使用方法,需要的朋友可以参考下
2021-09-09
java.lang.OutOfMemoryError: Metaspace异常解决的方法
这篇文章主要介绍了java.lang.OutOfMemoryError: Metaspace异常解决的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-03-03