【多数据源动态切换】Spring Boot中实现多数据源动态切换效果（2）：通过开源项目Dynamic Datasource Spring Boot Starter实现

忘是亡心i 2024-03-31 17:41 90阅读 0赞

在Spring Boot中，可以通过多种方式实现多数据源的动态切换效果，本篇介绍第二种实现方案。

## 一 具体实现 ##

### （1）测试使用的数据库 ###

这里我们创建3个数据库，分别是：`db01`、`db02`、`db03`，然后这3个数据库都有一张名为`user_info`的表，表结构一样，只是数据不同。

### （2）在pom.xml文件中添加相关依赖 ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> &lt;dependency&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;groupId&gt;com.baomidou&lt;/groupId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;artifactId&gt;dynamic-datasource-spring-boot-starter&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;version&gt;3.2.1&lt;/version&gt; &lt;/dependency&gt; </td> 
 </tr> 
 </tbody> 
</table>

最新版本：[https://mvnrepository.com/artifact/com.baomidou/dynamic-datasource-spring-boot-starter][https_mvnrepository.com_artifact_com.baomidou_dynamic-datasource-spring-boot-starter]

### （3）新增`application-datasource2.yml`配置文件 ###

新建这个用于测试的配置文件，主要配置了接下来需要用到的多个数据源，其配置如下：

### （4）新建一个测试使用的Mapper ###

在[上篇文章][Link 1]的基础上，再新建一个测试使用的`Mapper`，跟上篇文章的那个`Mapper`类似，只是使用的注解不同而已。

其对应的`UserInfoDynamicMapper.xml`文件（文件内容除了类路径不同，其他跟上篇文章的那个`Mapper.xml`一样）是：

### （5）使用单元测试测试「动态切换数据源」的效果 ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 </td> 
 <td> package cn.zifangsky.example.webexercise.dataSource; import cn.zifangsky.example.webexercise.mapper.UserInfoDynamicMapper2; import cn.zifangsky.example.webexercise.mapper.UserInfoMapper; import cn.zifangsky.example.webexercise.model.UserInfo; import org.junit.jupiter.api.*; import org.junit.jupiter.api.extension.ExtendWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit.jupiter.SpringExtension; import org.springframework.transaction.annotation.Transactional; import java.sql.SQLException; /** * 测试动态切换数据源(Dynamic Datasource Spring Boot Starter) * */ @DisplayName("测试动态切换数据源(Dynamic Datasource Spring Boot Starter)") @TestMethodOrder(MethodOrderer.OrderAnnotation.class) @ExtendWith(SpringExtension.class) @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) public class DynamicDataSource2Test { &nbsp;&nbsp;&nbsp;&nbsp;@Autowired &nbsp;&nbsp;&nbsp;&nbsp;private UserInfoMapper userInfoMapper; &nbsp;&nbsp;&nbsp;&nbsp;@Autowired &nbsp;&nbsp;&nbsp;&nbsp;private UserInfoDynamicMapper2 userInfoDynamicMapper2; &nbsp;&nbsp;&nbsp;&nbsp;@Test &nbsp;&nbsp;&nbsp;&nbsp;@Order(1) &nbsp;&nbsp;&nbsp;&nbsp;@DisplayName("普通方法——使用默认数据源") &nbsp;&nbsp;&nbsp;&nbsp;public void testCommonMethod(){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UserInfo userInfo = userInfoMapper.selectByPrimaryKey(1); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assertions.assertNotNull(userInfo); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assertions.assertEquals("张三", userInfo.getName()); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;@Test &nbsp;&nbsp;&nbsp;&nbsp;@Order(2) &nbsp;&nbsp;&nbsp;&nbsp;@DisplayName("通过默认数据源查询，方法级别的注解优先级更高") &nbsp;&nbsp;&nbsp;&nbsp;public void testSelectByDefaultDataSource(){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UserInfo userInfo = userInfoDynamicMapper2.selectByDefaultDataSource(1); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assertions.assertNotNull(userInfo); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assertions.assertEquals("张三", userInfo.getName()); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;@Test &nbsp;&nbsp;&nbsp;&nbsp;@Order(3) &nbsp;&nbsp;&nbsp;&nbsp;@DisplayName("方法级别没有添加注解，则使用接口级别的注解，通过 db02 数据源查询") &nbsp;&nbsp;&nbsp;&nbsp;public void testSelectByDB02DataSource(){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UserInfo userInfo = userInfoDynamicMapper2.selectByDB02DataSource(1); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assertions.assertNotNull(userInfo); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assertions.assertEquals("王五", userInfo.getName()); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;@Test &nbsp;&nbsp;&nbsp;&nbsp;@Order(4) &nbsp;&nbsp;&nbsp;&nbsp;@DisplayName("方法级别添加注解，手动指定通过 db03 数据源查询") &nbsp;&nbsp;&nbsp;&nbsp;public void testSelectByDB03DataSource(){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UserInfo userInfo = userInfoDynamicMapper2.selectByDB03DataSource(1); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assertions.assertNotNull(userInfo); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Assertions.assertEquals("孙七", userInfo.getName()); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;@Test &nbsp;&nbsp;&nbsp;&nbsp;@Order(5) &nbsp;&nbsp;&nbsp;&nbsp;@DisplayName("在一个方法执行过程中嵌套操作多个数据源的情况") &nbsp;&nbsp;&nbsp;&nbsp;public void testNestedMultiDataSource(){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//1. 从 db02 查询一条数据 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UserInfo userInfo = userInfoDynamicMapper2.selectByDB02DataSource(1); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//2. 插入到 db03 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;userInfo.setId(null); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;userInfoDynamicMapper2.addToDB03(userInfo); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;@Test &nbsp;&nbsp;&nbsp;&nbsp;@Order(6) &nbsp;&nbsp;&nbsp;&nbsp;@DisplayName("从 db03 数据源删除数据") &nbsp;&nbsp;&nbsp;&nbsp;public void testDeleteFromDB03ByName(){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;userInfoDynamicMapper2.deleteFromDB03ByName("王五"); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;@Test &nbsp;&nbsp;&nbsp;&nbsp;@Order(7) &nbsp;&nbsp;&nbsp;&nbsp;@DisplayName("嵌套多个数据源的事务回滚情况") &nbsp;&nbsp;&nbsp;&nbsp;@Transactional(rollbackFor = Exception.class) &nbsp;&nbsp;&nbsp;&nbsp;public void testTransaction() throws SQLException { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//1. 从 db01 查询一条数据 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UserInfo userInfo = userInfoDynamicMapper2.selectByDefaultDataSource(1); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//2. 分别插入到 db02 和 db03 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;userInfo.setId(null); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;userInfoDynamicMapper2.addToDB02(userInfo); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;userInfoDynamicMapper2.addToDB03(userInfo); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;//3. 手动抛出一个异常，测试事务回滚效果 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;throw new SQLException("SQL执行过程中发生某些未知异常"); &nbsp;&nbsp;&nbsp;&nbsp;} } </td> 
 </tr> 
 </tbody> 
</table>

> 注：以上测试代码基于Junit5 测试框架编写，需要的依赖如下：
> 
> <table> 
> <tbody> 
> <tr> 
> <td> 1 2 3 4 5 6 7 8 9 10 11 </td> 
> <td> &lt;dependency&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;artifactId&gt;spring-boot-starter-test&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;scope&gt;test&lt;/scope&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;exclusions&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;exclusion&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;groupId&gt;org.junit.vintage&lt;/groupId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;artifactId&gt;junit-vintage-engine&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/exclusion&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;/exclusions&gt; &lt;/dependency&gt; </td> 
> </tr> 
> </tbody> 
> </table>

运行单元测试后，其测试结果跟上篇文章一样，这里就省略截图吧。

## 二 这两种方案如何选择 ##

我看了一下开源项目`Dynamic Datasource Spring Boot Starter`的源代码，发现它也有一个`DynamicRoutingDataSource`（com/baomidou/dynamic/datasource/DynamicRoutingDataSource.java），然后具体的实现逻辑跟我在上篇文章中介绍的那种方案实际也是类似的。

![c68c936162e241f193afb534abec4bf8.png][]

不过，通过查看这个开源项目的[官方文档][Link 2]可以得知，这个项目支持的特性比较丰富，截止目前有以下这些：

![1187ac05ab1d435f8a9213014d4d9ebb.png][]

然后，经过了多次更新迭代后，这个开源项目也相对比较稳定。因此，在这里我给出的建议是：

*  如果想要实现简单，或者说想要将以上截图中的部分特性拿来就用，那么可以考虑使用这个开源项目；
 *  如果想要实现的功能比较单一，而且有尽可能减少外部依赖的需求，那么通过上篇文章介绍的方案来手动实现也是可以的。

[https_mvnrepository.com_artifact_com.baomidou_dynamic-datasource-spring-boot-starter]: https://mvnrepository.com/artifact/com.baomidou/dynamic-datasource-spring-boot-starter
[Link 1]: https://blog.csdn.net/wufaqidong1/article/details/128278867?spm=1001.2014.3001.5502
[c68c936162e241f193afb534abec4bf8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/bc2459a7285b44439278fdf296ef444b.png
[Link 2]: https://baomidou.gitee.io/dynamic-datasource-doc/guide/
[1187ac05ab1d435f8a9213014d4d9ebb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/2cad06424f2247d1a8f44403748f66e6.png