【SpringBoot DB 系列】Mybatis 基于 AbstractRoutingDataSource 与 AOP 实现多数据源切换
后面一篇博文介绍了 Mybatis 多数据源的配置，简略来讲就是一个数据源一个配置指定，不同数据源的 Mapper 离开指定；本文将介绍另外一种形式，借助AbstractRoutingDataSource来实现动静切换数据源，并通过自定义注解形式 + AOP 来实现数据源的指定
<!-- more -->
I. 环境筹备
1. 数据库相干
以 mysql 为例进行演示阐明，因为须要多数据源，一个最简略的 case 就是一个物理库上多个逻辑库，本文是基于本机的 mysql 进行操作
创立数据库test 与 story，两个库下都存在一个表money (同名同构造表，然而数据不同哦)
CREATE TABLE `money` ( `id` int(11) unsigned NOT NULL AUTO_INCREMENT, `name` varchar(20) NOT NULL DEFAULT '' COMMENT '用户名', `money` int(26) NOT NULL DEFAULT '0' COMMENT '钱', `is_deleted` tinyint(1) NOT NULL DEFAULT '0', `create_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创立工夫', `update_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新工夫', PRIMARY KEY (`id`), KEY `name` (`name`)) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;2. 我的项目环境
本我的项目借助SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA进行开发
上面是外围的pom.xml（源码能够再文末获取）
<dependencies> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.3.2</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency></dependencies>配置文件信息application.yml
# 数据库相干配置，请留神这个配置和之前一篇博文的不统一，前面会给出起因spring: dynamic: datasource: story: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai username: root password: test: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai username: root password:# 日志相干logging: level: root: info org: springframework: jdbc: core: debugII. 多数据源配置
强烈建议没有看上一篇博文的小伙伴，先看一下上篇博文 【DB 系列】Mybatis 多数据源配置与应用
在开始之前，先有必要回顾一下之前 Mybatis 多数据源配置的次要问题在哪里
- 多加一个数据源，须要多一份配置
- Mapper 文件须要分包解决，对开发人员而言这是个潜在的坑
针对下面这个，那咱们想实现的目标也很清晰了，解决下面两个问题
1. AbstractRoutingDataSource
实现多数据源的要害,从名字上就能够看出，它就是用来路由具体的数据源的，其外围代码如
// 返回选中的数据源protected DataSource determineTargetDataSource() { Assert.notNull(this.resolvedDataSources, "DataSource router not initialized"); Object lookupKey = this.determineCurrentLookupKey(); 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; }}@Nullableprotected abstract Object determineCurrentLookupKey();其中determineCurrentLookupKey须要咱们本人来实现，到底返回哪个数据源
2. 动静数据源实现
咱们创立一个DynamicDataSource继承自下面的抽象类
public class DynamicDataSource extends AbstractRoutingDataSource { @Override protected Object determineCurrentLookupKey() { String dataBaseType = DSTypeContainer.getDataBaseType(); return dataBaseType; }}留神下面的实现办法，怎么决定具体的返回数据源呢？
一个可思考的办法是，在 Mapper 文件上增加一个注解@DS，外面指定对应的数据源，而后再执行时，通过它来确定具体须要执行的数据源；
因为下面的实现没有传参，因而咱们思考借助线程上下文的形式来传递信息
public class DSTypeContainer { private static final ThreadLocal<String> TYPE = new ThreadLocal<String>(); public static String defaultType; /** * 往以后线程里设置数据源类型 * * @param dataBase */ public static void setDataBaseType(String dataBase) { if (StringUtils.isEmpty(dataBase)) { dataBase = defaultType; } TYPE.set(dataBase); System.err.println("[将以后数据源改为]：" + dataBase); } /** * 获取数据源类型 * * @return */ public static String getDataBaseType() { String database = TYPE.get(); System.err.println("[获取以后数据源的类型为]：" + database); return database; } /** * 清空数据类型 */ public static void clearDataBaseType() { TYPE.remove(); }}3. 注解实现
下面尽管给出了数据源抉择的策略，从线程上下文中获取DataBaseType，然而应该怎么向线程上下文中塞这个数据呢？
咱们须要反对的计划必然是在 Sql 执行之前，先拦挡它，写入这个DataBaseType，因而咱们能够思考在xxxMapper接口上，定义一个注解，而后拦挡它的拜访执行，在执行之前获取注解中指定的数据源写入上下文，在执行之后分明上下文
一个最根底的数据源注解@DS
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Inheritedpublic @interface DS { String value() default "";}注解拦挡
@Aspect@Componentpublic class DsAspect { // 拦挡类上有DS注解的办法调用 @Around("@within(DS)") public Object dsAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable { DS ds = (DS) proceedingJoinPoint.getSignature().getDeclaringType().getAnnotation(DS.class); try { // 写入线程上下文，应该用哪个DB DSTypeContainer.setDataBaseType(ds == null ? null : ds.value()); return proceedingJoinPoint.proceed(); } finally { // 清空上下文信息 DSTypeContainer.clearDataBaseType(); } }}4. 注册配置
接下来就是比拟要害的数据源配置了，咱们当初须要注册DynamicDataSource，而后将他提供给SqlSessionFactory，在这里，咱们心愿解决即使多加数据源也不须要批改配置，所以咱们调整了一下数据源的配置构造
spring: dynamic: datasource: story: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai username: root password: test: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai username: root password:而后给出一个加载下面配置的配置类DSProperties
@Data@ConfigurationProperties(prefix = "spring.dynamic")public class DSProperties { private Map<String, DataSourceProperties> datasource;}而后咱们的AutoConfiguration类的实现形式就绝对明确了(倡议比照上一篇博文中的配置类)
@Configuration@EnableConfigurationProperties(DSProperties.class)@MapperScan(basePackages = {"com.git.hui.boot.multi.datasource.mapper"}, sqlSessionFactoryRef = "SqlSessionFactory")public class DynamicDataSourceConfig { @SuppressWarnings("unchecked") @Bean(name = "dynamicDataSource") public DynamicDataSource DataSource(DSProperties dsProperties) { Map targetDataSource = new HashMap<>(8); dsProperties.getDatasource().forEach((k, v) -> { targetDataSource.put(k, v.initializeDataSourceBuilder().build()); }); DynamicDataSource dataSource = new DynamicDataSource(); dataSource.setTargetDataSources(targetDataSource); // 设置默认的数据库，上面这个赋值形式写法不太举荐，这里只是为了不便而已 DSTypeContainer.defaultType = (String) targetDataSource.keySet().stream().findFirst().get(); dataSource.setDefaultTargetDataSource(targetDataSource.get(DSTypeContainer.defaultType)); return dataSource; } @Bean(name = "SqlSessionFactory") public SqlSessionFactory test1SqlSessionFactory(@Qualifier("dynamicDataSource") DataSource dynamicDataSource) throws Exception { SqlSessionFactoryBean bean = new SqlSessionFactoryBean(); bean.setDataSource(dynamicDataSource); bean.setMapperLocations( new PathMatchingResourcePatternResolver().getResources("classpath*:mapping/*/*.xml")); return bean.getObject(); }}5. 数据库实体类
我的项目结构图
所有后面的货色属于通用配置相干，接下来给出具体的数据库操作相干实体类、Mapper 类
数据库实体类StoryMoneyEntity
@Datapublic class StoryMoneyEntity { private Integer id; private String name; private Long money; private Integer isDeleted; private Timestamp createAt; private Timestamp updateAt;}mapper 定义接口 StoryMoneyMapper + TestMoneyMapper
@DS(value = "story")@Mapperpublic interface StoryMoneyMapper { List<StoryMoneyEntity> findByIds(List<Integer> ids);}@DS(value = "test")@Mapperpublic interface TestMoneyMapper { List<TestMoneyEntity> findByIds(List<Integer> ids);}对应的 xml 文件
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.git.hui.boot.multi.datasource.mapper.StoryMoneyMapper"> <resultMap id="BaseResultMap" type="com.git.hui.boot.multi.datasource.entity.StoryMoneyEntity"> <id column="id" property="id" jdbcType="INTEGER"/> <result column="name" property="name" jdbcType="VARCHAR"/> <result column="money" property="money" jdbcType="INTEGER"/> <result column="is_deleted" property="isDeleted" jdbcType="TINYINT"/> <result column="create_at" property="createAt" jdbcType="TIMESTAMP"/> <result column="update_at" property="updateAt" jdbcType="TIMESTAMP"/> </resultMap> <sql id="money_po"> id, `name`, money, is_deleted, create_at, update_at </sql> <select id="findByIds" parameterType="list" resultMap="BaseResultMap"> select <include refid="money_po"/> from money where id in <foreach item="id" collection="list" separator="," open="(" close=")" index=""> #{id} </foreach> </select></mapper><!-- 省略第二个xml文件 内容基本一致-->数据库操作封装类StoryMoneyRepository + TestMoneyRepository
@Repositorypublic class StoryMoneyRepository { @Autowired private StoryMoneyMapper storyMoneyMapper; public void query() { List<StoryMoneyEntity> list = storyMoneyMapper.findByIds(Arrays.asList(1, 1000)); System.out.println(list); }}@Repositorypublic class TestMoneyRepository { @Autowired private TestMoneyMapper testMoneyMapper; public void query() { List<TestMoneyEntity> list = testMoneyMapper.findByIds(Arrays.asList(1, 1000)); System.out.println(list); }}6. 测试
最初简略的测试下，动静数据源切换是否失效
@SpringBootApplicationpublic class Application { public Application(StoryMoneyRepository storyMoneyRepository, TestMoneyRepository testMoneyRepository) { storyMoneyRepository.query(); testMoneyRepository.query(); } public static void main(String[] args) { SpringApplication.run(Application.class); }}输入日志如下
6.小结
本文次要给出了一种基于AbstractRoutingDataSource + AOP实现动静数据源切换的实现形式，应用了上面三个知识点
AbstractRoutingDataSource实现动静数据源切换- 自定义
@DS注解 + AOP 指定 Mapper 对应的数据源 ConfigurationProperties形式反对增加数据源无需批改配置
II. 其余
0. 我的项目
相干博文
- 【DB 系列】Mybatis 多数据源配置与应用
- 【DB 系列】JdbcTemplate 之多数据源配置与应用
- 【DB 系列】Mybatis-Plus 代码主动生成
- 【DB 系列】MybatisPlus 整合篇
- 【DB 系列】Mybatis+注解整合篇
- 【DB 系列】Mybatis+xml 整合篇
源码
- 工程：https://github.com/liuyueyi/spring-boot-demo
- 源码: https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/109-multi-datasource-mybatis
1. 一灰灰 Blog
尽信书则不如，以上内容，纯属一家之言，因集体能力无限，不免有疏漏和谬误之处，如发现 bug 或者有更好的倡议，欢送批评指正，不吝感谢
上面一灰灰的集体博客，记录所有学习和工作中的博文，欢送大家前去逛逛
- 一灰灰 Blog 集体博客 https://blog.hhui.top
- 一灰灰 Blog-Spring 专题博客 http://spring.hhui.top
- 微信公众号: 一灰灰blog