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(源码可以再文末获取)
org.mybatis.spring.boot mybatis-spring-boot-starter 1.3.2 mysql mysql-connector-java配置文件信息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 TYPE = new ThreadLocal(); 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 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 findByIds(List ids);}@DS(value = "test")@Mapperpublic interface TestMoneyMapper { List findByIds(List ids);}对应的 xml 文件
<?xml version="1.0" encoding="UTF-8"?>mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> id, `name`, money, is_deleted, create_at, update_at select from money where id in #{id}数据库操作封装类StoryMoneyRepository + TestMoneyRepository
@Repositorypublic class StoryMoneyRepository { @Autowired private StoryMoneyMapper storyMoneyMapper; public void query() { List list = storyMoneyMapper.findByIds(Arrays.asList(1, 1000)); System.out.println(list); }}@Repositorypublic class TestMoneyRepository { @Autowired private TestMoneyMapper testMoneyMapper; public void query() { List 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方式支持添加数据源无需修改配置
本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。
