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 实现 动态数据源切换。

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

相关文章

  • Spring Security 密码验证动态加盐的验证处理方法

    Spring Security 密码验证动态加盐的验证处理方法

    小编最近在改造项目,需要将gateway整合security在一起进行认证和鉴权,今天小编给大家分享Spring Security 密码验证动态加盐的验证处理方法,感兴趣的朋友一起看看吧
    2021-06-06
  • Mybatis-Plus3.2.0 MetaObjectHandler 无法进行公共字段全局填充

    Mybatis-Plus3.2.0 MetaObjectHandler 无法进行公共字段全局填充

    这篇文章主要介绍了Mybatis-Plus3.2.0 MetaObjectHandler 无法进行公共字段全局填充,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11
  • Java中左移和右移问题图文详解

    Java中左移和右移问题图文详解

    左移和右移并不常用,在一些特殊情况下才会使用,比如加解密时,会大量用到,这篇文章主要给大家介绍了关于Java中左移和右移问题的相关资料,需要的朋友可以参考下
    2021-11-11
  • Mybatis空值关联的问题解析及解决方案

    Mybatis空值关联的问题解析及解决方案

    这篇文章给大家介绍了Mybatis空值关联的问题解析及解决方案,文中通过代码示例介绍的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2024-01-01
  • 关于Java中的CAS如何使用

    关于Java中的CAS如何使用

    这篇文章主要介绍了关于Java中的CAS如何使用,CAS是Compare And Swap(比较并交换)的缩写,是一种非阻塞式并发控制技术,用于保证多个线程在修改同一个共享资源时不会出现竞争条件,从而避免了传统锁机制的各种问题,需要的朋友可以参考下
    2023-09-09
  • 浅析java创建文件和目录

    浅析java创建文件和目录

    这篇文章主要介绍了浅析java创建文件和目录的关键技术点以及演示示例,是篇非常不错的文章,有需要的朋友可以参考下
    2014-09-09
  • Java HashMap原理及实例解析

    Java HashMap原理及实例解析

    这篇文章主要介绍了Java HashMap原理及实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • Java编程实现基于用户的协同过滤推荐算法代码示例

    Java编程实现基于用户的协同过滤推荐算法代码示例

    这篇文章主要介绍了Java编程实现基于用户的协同过滤推荐算法代码示例,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • JAVA语言编程格式高级规范

    JAVA语言编程格式高级规范

    这篇文章主要介绍了JAVA语言编程格式高级规范,需要的朋友可以参考下
    2015-05-05
  • mybatis 为什么千万不要使用 where 1=1

    mybatis 为什么千万不要使用 where 1=1

    这篇文章主要介绍了mybatis 为什么千万不要使用 where 1=1,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-05-05

最新评论