动态数据源-mybatis-plus-DynamicRoutingDataSource

mybatis-plus的动态数据源DynamicRoutingDataSource

适用于springboot，单体服务

使用场景：SaaS服务部署，单服务多租户。当一个系统中需要多个数据库参与，每个公司（租户）一个数据库，多个公司（租户）共用同一个域名同一个网站。用户操作时用公司号登录，进行的操作都会查询指定公司的数据库

mybatis-plus的动态数据源DynamicRoutingDataSource会和spring的动态数据源AbstractRoutingDataSource很像，在上文中有介绍动态数据源-spring-AbstractRoutingDataSource-CSDN博客

目录

1、实现效果

2、实现和继承关系

3、DynamicRoutingDataSource执行主体逻辑

3.1 DynamicRoutingDataSource核心属性分析

​编辑3.2 DynamicRoutingDataSource属性初始化并注入spring容器

3.3 核心属性DynamicDataSourceProvider provider的初始化和注入

3.4 核心属性dataSourceMap和groupDataSources

3.5 mybatis-plus提供本地线程栈操作类

4、使用的坑记录：

4.1 调用同一个接口一直乱切数据源

---

1、实现效果

登录时候输入租户 用户名 密码

登录后显示具体租户信息，后续所有数据库操作都会去租户号的数据库查询

2、实现和继承关系

DynamicRoutingDataSource类继承与AbstractRoutingDataSource类

AbstractRoutingDataSource类实现了DataSource接口

3、DynamicRoutingDataSource执行主体逻辑

3.1 DynamicRoutingDataSource核心属性分析

先来看一下核心属性，DynamicDataSourceProvider是个核心属性，在bean初始化时候回进行调用，把dataSourceMap数据map初始化

3.2 DynamicRoutingDataSource属性初始化并注入spring容器

bean加入spring管理，查找DynamicRoutingDataSource的使用之处会发现在autoConfiguration类中会进行调用

DynamicDataSourceAutoConfiguration类

DynamicDataSourceProperties类，只要配置文件中配置就会注入到属性properties中
DynamicDataSourceAutoConfiguration自动配置类，原理是用JDK中的SPI机制，在工程的resources下面META-INF文件夹，加载spring.factories中注册的各种AutoConfiguration类，当某个AutoConfiguration类满足其注解@Conditional指定的生效条件时，实例化该AutoConfiguration类中定义的Bean，并注入Spring容器

没有DataSource接口实现类就会实例化一个DynamicRoutingDataSource加入spring上下文管理

3.3 核心属性DynamicDataSourceProvider provider的初始化和注入

DynamicDataSourceProvider有两个主要实现类，这两个实现类都继承了AbstractDataSourceProvider

AbstractJdbcDataSourceProvider通过jdbc的方式获取数据源
YmlDynamicDataSourceProvider通过yml配置文件的方式获取数据源

loadDataSources中都会调用父类createDataSource，最终通过配置文件/数据库，实例化数据源，组成map的形式（key-数据源）

其中AbstractJdbcDataSourceProvider需要由子类确定执行的sql​​​​

这里通过匿名内部类的方式直接创建子类实现方法

到这里provider对象构建完毕

3.4 核心属性dataSourceMap和groupDataSources

在bean初始化时，因为DynamicRoutingDataSource实现了InitializingBean接口，初始化时会执行afterPropertiesSet方法

addDataSource方法

当进行sql查询时会调用dataSource的getConnection方法获取连接

子类DynamicRoutingDataSource中，本地技术栈为key在dataSourceMap/groupDataSources中正确的数据源

3.5 mybatis-plus提供本地线程栈操作类

DynamicDataSourceContextHolder

4、使用的坑记录：

4.1 调用同一个接口一直乱切数据源

原因：组数据源设置不当导致一直切换数据源，所有数据源key都master_XX

组数据源（groupDataSources），mybatis-plus-DynamicRoutingDataSource除了有dataSourceMap存放数据源还有组数据源的概念，当输入数据源key值是master_XX，如果带有‘_’，就会在插入dataSourceMap的同时插入groupDataSources（分组就是master），而当新的线程没有指定本地线程栈内容，会走groupDataSources策略从组中拿一个（随机或者遍历）

解决方案:

1、把主数据源的分组只放默认数据源，其他数据源配置的时候不能加前缀master_

2、自定义策略（针对已经把所有数据源都进入主数据源组）

建议：生产开启严格模式

源码详解

初始化时的组数据源

DynamicRoutingDataSource类中afterPropertiesSet方法，中addDataSource方法初始化装配dataSourceMap和groupDataSources，addDataSource方法中addGroupDataSource初始化装配groupDataSources。具体方法如下

查询sql时选择数据源逻辑
DynamicDataSourceAutoConfiguration类中determineDataSource方法，在查询数据库时调用dataSource接口实现类的getConnection时决定所用数据源。determineDataSource方法核心是调用getDataSource方法。