AbstractRoutingDataSource 实现动态数据源切换原理简单分析

AbstractRoutingDataSource 实现动态数据源切换原理简单分析

写在前面，项目中用到了动态数据源切换，记录一下其运行机制。

代码展示

下面列出一些关键代码，后续分析会用到

1. 数据配置

@Configuration
@PropertySource({ "classpath:jdbc.yml" })
@EnableTransactionManagement(proxyTargetClass = true)
public class DataConfig {

    @Autowired
    private Environment env ;

    /**
     *  将jdbc相关的异常转换为spring的异常类型
     */
    @Bean
    public BeanPostProcessor persistenceTransLation(){
        return new PersistenceExceptionTranslationPostProcessor() ;
    }

    /**
     * 多数据源
     * @return
     */
    @Bean
    public DynamicDataSource dynamicDataSource(){
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        Map<Object,Object> sourceMap = new HashMap<>();
        //取得所有的datasource，DataSourceEnum里存放数据源的唯一标识
        EnumSet<DataSourceEnum> enums = EnumSet.allOf(DataSourceEnum.class);
        for(DataSourceEnum dataSource:enums){
            // map存放数据源的key和数据源
            sourceMap.put(dataSource.getKey(),generateDataSource(dataSource.getKey()));
        }
        //  重点
        dynamicDataSource.setTargetDataSources(sourceMap);
     dynamicDataSource.setDefaultTargetDataSource(sourceMap.get(DataSourceEnum.TEST.getKey()));
        return dynamicDataSource;
    }

    // 读取配置文件，创建数据源对象
    private EncryptDataSource generateDataSource(String key){
        EncryptDataSource dataSource
                = new EncryptDataSource();
        key = key.toLowerCase() ;
        String url = "jdbc.url."+key;
        String username = "jdbc.username."+key;
        String password = "jdbc.password."+key;
        dataSource.setDriverClassName("com.sybase.jdbc4.jdbc.SybDataSource");//SybDriver
        dataSource.setUrl(env.getProperty(url));
        dataSource.setUsername(env.getProperty(username));
        dataSource.setPassword(env.getProperty(password));

        //配置连接池
        dataSource.setInitialSize(Integer.parseInt(env.getProperty("jdbc.initialSize")));
        dataSource.setMaxIdle(Integer.parseInt(env.getProperty("jdbc.maxIdle")));
        dataSource.setMinIdle(Integer.parseInt(env.getProperty("jdbc.minIdle")));
        return dataSource;
    }
}

1. 自定义数据源类

public class DynamicDataSource extends AbstractRoutingDataSource {
    // 存放数据源的id（唯一标识）
    private static final ThreadLocal<String> dataSourceHolder = new ThreadLocal<>() ;

    //  重点
    @Override
    protected Object determineCurrentLookupKey() {
        return dataSourceHolder.get();
    }

    // 切换数据源
    public static void router(String sourceKey){
        if(StrUtil.isEmpty(sourceKey)){
            return;
        }
        if(DataSourceEnum.getSourceByKey(sourceKey)!=null){
            //根据法院代码切换
            dataSourceHolder.set(DataSourceEnum.getSourceByKey(sourceKey));
        }
    }

    ……

}

1. 数据源配置（jdbc.yml）

#测试库
jdbc.url.test: jdbc:sybase:Tds:xxx.xxx.xxx.xxx:xx/JUDGE?charset=cp936
jdbc.username.test: fymis
jdbc.password.test: xx

原理分析

第一部分已将关键代码列出，该部分通过修改后即可实现数据源的切换功能。下面来分析一下流程。

AbstractRoutingDataSource 类解析

只列出了部分方法，需要详细代码请自行移步源码

public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean {
    @Nullable
    private Map<Object, Object> targetDataSources;// 目标数据源map
    @Nullable
    private Object defaultTargetDataSource;// 默认数据源
    private boolean lenientFallback = true;
    private DataSourceLookup dataSourceLookup = new JndiDataSourceLookup();
    @Nullable
    private Map<Object, DataSource> resolvedDataSources;
    @Nullable
    private DataSource resolvedDefaultDataSource;

    public AbstractRoutingDataSource() {
    }

    public void setTargetDataSources(Map<Object, Object> targetDataSources) {
        this.targetDataSources = targetDataSources;
    }

    public void setDefaultTargetDataSource(Object defaultTargetDataSource) {
        this.defaultTargetDataSource = defaultTargetDataSource;
    }

    // 初始化 Bean 时执行
    public void afterPropertiesSet() {
        if (this.targetDataSources == null) {
            throw new IllegalArgumentException("Property 'targetDataSources' is required");
        } else {
            // 将targetDataSources属性的值赋值给resolvedDataSources，后续需要用到resolvedDataSources
            this.resolvedDataSources = new HashMap(this.targetDataSources.size());
            this.targetDataSources.forEach((key, value) -> {
                Object lookupKey = this.resolveSpecifiedLookupKey(key);
                DataSource dataSource = this.resolveSpecifiedDataSource(value);
                this.resolvedDataSources.put(lookupKey, dataSource);
            });
            if (this.defaultTargetDataSource != null) {
                this.resolvedDefaultDataSource = this.resolveSpecifiedDataSource(this.defaultTargetDataSource);
            }

        }
    }

    // 重写了 getConnection 方法，ORM 框架执行语句前会调用该处
    @Override
    public Connection getConnection() throws SQLException {
        return this.determineTargetDataSource().getConnection();
    }

    // 同上
    @Override
    public Connection getConnection(String username, String password) throws SQLException {
        return this.determineTargetDataSource().getConnection(username, password);
    }

    //  重点
    protected DataSource determineTargetDataSource() {
        Assert.notNull(this.resolvedDataSources, "DataSource router not initialized");
        // 调用我们重写的determineCurrentLookupKey方法，返回的是数据源的唯一标识
        Object lookupKey = this.determineCurrentLookupKey();
        // 从map中查询改标识对应的数据源，然后返回该数据源，打开对应连接
        DataSource dataSource = (DataSource)this.resolvedDataSources.get(lookupKey);
        if (dataSource == null && (this.lenientFallback || lookupKey == null)) {
            dataSource = this.resolvedDefaultDataSource;
        }

        if (dataSource == null) {
            throw new IllegalStateException("Cannot determine target DataSource for lookup key [" + lookupKey + "]");
        } else {
            return dataSource;
        }
    }

    // 钩子方法，供我们重写
    @Nullable
    protected abstract Object determineCurrentLookupKey();
}

总结与闲谈

综上，可以列出以下几点描述整个流程：

1. 自定义类继承 AbstractRoutingDataSource（后文称 ARDS），重写 determineCurrentLookupKey()，返回数据源的唯一标识；
2. 将数据源名称和数据源封装为 map，调用 ARDS 类的 setTargetDataSources() 设置目标数据源。ARDS 类实现了 InitializingBean 接口，重写了 afterPropertySet()（对该方法不熟悉的话请回顾一下 Bean 的生命周期，该方法在 Bean 的属性注入后执行），该方法内部对 resolvedDataSources 属性赋值（将 targetDataSources 的值放进去），后续会用到 resolvedDataSources ；
3. ARDS 实现了 DataSource 接口，重写了 getConnection()，当 ORM 框架执行 sql 语句前总是执行 getConnection()，然后就调用到了重写后的 getConnection()，该方法内部调用了 ARDS 类的 determineTargetDataSource()；
4. determineTargetDataSource() 内部调用了自定义类重写的 determineCurrentLookupKey()，返回数据源的映射，然后从 resolvedDataSources（map） 属性获取到数据源，进行后续的操作。

（题外话）想要实现数据源切换可以有两种实现：

1. 手动切换数据源，每次执行相应操作前调用 router 方法切换；
2. 还有一种思路就是利用 AOP，设计一个注解，注解内添加数据源唯一标识的属性，然后对方法添加注解，AOP 代码进行拦截，然后将唯一标识赋值给 ThreadLocal 变量即可。

AbstractRoutingDataSource 实现动态数据源切换原理简单分析的更多相关文章

1. SpringMVC 利用AbstractRoutingDataSource实现动态数据源切换

   SpringMVC 利用AbstractRoutingDataSource实现动态数据源切换 本文转载至:http://exceptioneye.iteye.com/blog/1698064 Spri ...

2. Spring主从数据库的配置和动态数据源切换原理

   原文:https://www.liaoxuefeng.com/article/00151054582348974482c20f7d8431ead5bc32b30354705000 在大型应用程序中,配 ...

3. Spring(AbstractRoutingDataSource)实现动态数据源切换--转载

   原始出处:http://linhongyu.blog.51cto.com/6373370/1615895 一.前言 近期一项目A需实现数据同步到另一项目B数据库中,在不改变B项目的情况下,只好选择项目 ...

4. AbstractRoutingDataSource实现动态数据源切换 专题

   需求:系统中要实现切换数据库(业务数据库和his数据库) 网上很多资料上有提到AbstractRoutingDataSource,大致是这么说的 在Spring 2.0.1中引入了AbstractRo ...

5. Spring(AbstractRoutingDataSource)实现动态数据源切换

   转自: http://blog.51cto.com/linhongyu/1615895 一.前言 近期一项目A需实现数据同步到另一项目B数据库中,在不改变B项目的情况下,只好选择项目A中切换数据源,直 ...

6. 利用AbstractRoutingDataSource实现动态数据源切换

   需求:系统中要实现切换数据库(业务数据库和his数据库) 网上很多资料上有提到AbstractRoutingDataSource,大致是这么说的 在Spring 2.0.1中引入了AbstractRo ...

7. spring AbstractRoutingDataSource实现动态数据源切换

   使用Spring 提供的 AbstractRoutingDataSource 实现 创建 AbstractRoutingDataSource 实现类,负责保存所有数据源与切换数据源策略:public ...

8. Spring 实现动态数据源切换--转载 （AbstractRoutingDataSource）的使用

   [参考]Spring(AbstractRoutingDataSource)实现动态数据源切换--转载 [参考] 利用Spring的AbstractRoutingDataSource解决多数据源的问题 ...

9. 【开发笔记】- AbstractRoutingDataSource动态数据源切换，AOP实现动态数据源切换

   AbstractRoutingDataSource动态数据源切换 上周末,室友通宵达旦的敲代码处理他的多数据源的问题,搞的非常的紧张,也和我聊了聊天,大概的了解了他的业务的需求.一般的情况下我们都是使 ...

10. AbstractRoutingDataSource动态数据源切换，AOP实现动态数据源切换

    版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明.本文链接:https://blog.csdn.net/u012881904/article/de ...

随机推荐

1. ubuntu14.04环境下spyder的安装

   在ubuntu14.04系统中,默认在/usr/lib目录下安装了python2.7.6和python3.4.3,在该环境下安装spyder,然后使其链接到python3.4.3. 首先安装为pyth ...

2. MySQL的基本知识 -- 命令

   1.数据库和表 SHOW DATABASES; 返回可用数据库的一个列表 SHOW TABLES; 返回一个数据库内的表的列表 SHOW COLUMNS FROM tableName; 返回数据表的表 ...

3. Transaction Save Point (SET XACT_ABORT { ON | OFF })

   ref:http://blog.csdn.net/wym3587/article/details/6940630 ref:http://www.cnblogs.com/jiajiayuan/archi ...

4. 加快Win7整体运行速度的12个小技巧

   在整体运行速度方面,微软Windows 7系统超越了它的前任Vista,拥有明显的提升;但是相比最新的Windows 8,似乎又有所不及,至少很少有Windows用户能够体会到15秒的开机速度.虽然如 ...

5. modernizr.js

   1.判断浏览器是否支持 h5 if(Modernizr.canvas){ alert(123); }else{ alert(321); } 2.判断浏览器是否支持 canvas function su ...

6. poj - 3723 Conscription(最大权森林）

   http://poj.org/problem?id=3723 windy需要挑选N各女孩,和M各男孩作为士兵,但是雇佣每个人都需要支付10000元的费用,如果男孩x和女孩y存在亲密度为d的关系,只要他 ...

7. 程序、计算机程序、java初论

   一.程序? 程序一词来自生活,通常指完成某些事情的一种既定方式和过程,可以将程序看成对一系列动作的执行过程的描述. 例如:个人去银行取钱 1.带上存折/银行卡去银行 2.取号排队 3.将存折或储蓄卡递 ...

8. iOS APP上架被拒重新提交审核教程

   iOS APP审核比较严格,难免会出现被拒绝的情况,需要根据苹果反馈的问题修改后重新打包上传审核! 1.登录itunesconnect.https://itunesconnect.apple.com进 ...

9. MySQL基础----动态SQL语句

   尊重原创:http://blog.csdn.net/abc19900828/article/details/39501643   动态sql语句基本语法 1 :普通SQL语句可以用Exec执行 eg: ...

10. 求最小环 —— 并查集 与 Floyd

    对于一个图,如何求出其中的最小环(不包括一元环)? 很显然,对于一个无向图,每一条边都是一个二元环:对于有向图,可以考虑从每一个点出发,用DFS求出它到自己的距离,如果遍历了$N$个点仍未便利到自己, ...