文章已收录到我的Github精选,欢迎Star:https://github.com/yehongzhi/learningSummary
提出问题
在平时开发中,经常会遇到在一个项目里需要使用多个数据源的情况,比如有一部分数据在数据源A,另一部分数据在数据源B,业务需要把这两部分的数据做合并然后从接口返回。
又或者操作完数据源A后,需要切换数据源,操作数据源B。这样的需求,怎么实现?
解决问题
其实在MyBatis-plus就有相关的实现,是一个基于SpringBoot快速集成多数据源的启动器。
首先要搭建一个springBoot+Mybatis+Mybatis-Plus的项目,搭建项目就不演示了,比较简单。这里讲怎么使用多数据源,首先引入dynamic-datasource-spring-boot-starter
。
<dependency><groupId>com.baomidou</groupId><artifactId>dynamic-datasource-spring-boot-starter</artifactId><version>${version}</version><!--版本号--></dependency>
第二步,修改application配置文件,配置数据源。
#默认数据源spring.datasource.dynamic.primary=master#数据源Aspring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.master.url=jdbc:mysql://192.168.0.101:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.master.username=rootspring.datasource.dynamic.datasource.master.password=#数据源Bspring.datasource.dynamic.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.slave.url=jdbc:mysql://192.168.0.102:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.slave.username=rootspring.datasource.dynamic.datasource.slave.password=
第三步,使用@DS注解切换数据源。一般我喜欢放在Mapper接口上面。注解的值则是数据源的名称。
现在有两个数据源,如图所示:
slave数据源的user表对应的Mapper接口,如下:
@Mapper@DS("slave")publicinterfaceUserMapperextendsBaseMapper<User>{}
master数据源的commodity表对应的Mapper接口,如下:
@Mapper@DS("master")publicinterfaceCommodityMapperextendsBaseMapper<Commodity>{}
接着我们写一个Service进行测试:
@ServicepublicclassDynamicServiceImplimplementsDynamicService{@ResourceprivateUserMapperuserMapper;@ResourceprivateCommodityMappercommodityMapper;@OverridepublicResultObjectgetUserListAndCommodityList(){//查询slave数据源List<User>userList=userMapper.selectList(null);//查询master数据源List<Commodity>commodityList=commodityMapper.selectList(null);//把两个数据源查询的整合到一起返回ResultObjectresultObject=newResultObject();resultObject.setUserList(userList);resultObject.setCommodityList(commodityList);returnresultObject;}}
Controller接口,如下:
@RestController@RequestMapping("/dynamic")publicclassDynamicController{@ResourceprivateDynamicServicedynamicService;@RequestMapping("/getUserListAndCommodityList")publicResultObjectgetUserListAndCommodityList(){returndynamicService.getUserListAndCommodityList();}}
启动项目,然后请求接口地址,我们可以看到结果里包含了两个数据源查询到的数据:
一些疑问
问题一:@DS注解可以在什么地方使用?
看源码,可以知道是在类和方法上使用。
@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interfaceDS{/***groupNameorspecificdatabasenameorspringSPELname.**@returnthedatabaseyouwanttoswitch*/Stringvalue();}
一般在Service或者Mapper上面进行标记。在方法上面标记优先级高于在类上标记。
问题二:支持多层嵌套切换数据源吗?
什么是嵌套切换数据源,先看个例子:
@Service@DS("slave")publicclassUserServiceImplimplementsUserService{@ResourceprivateUserMapperuserMapper;@OverridepublicList<User>getList(){returnuserMapper.selectList(null);}}
@Service@DS("master")publicclassCommodityServiceImplimplementsCommodityService{@ResourceprivateUserServiceuserService;@OverridepublicResultObjectgetUserAndCommodity(){//切换到slave数据源,查询user表List<User>userList=userService.getList();//切换回master数据源,查询commodity表List<Commodity>commodityList=commodityMapper.selectList(null);ResultObjectresultObject=newResultObject();resultObject.setUserList(userList);resultObject.setCommodityList(commodityList);returnresultObject;}}
@RestController@RequestMapping("/dynamic")publicclassDynamicController{@ResourceprivateCommodityServicecommodityService;@RequestMapping("/getUserListAndCommodityList")publicResultObjectgetUserListAndCommodityList(){returncommodityService.getUserAndCommodity();}}
启动项目,然后请求地址,发现依然能查出结果,证明是支持嵌套切换数据源的。
问题三:如何使用@Transactional注解提供事务支持?
我们看个例子: 首先定义一个插入对象InsertRequest:
#默认数据源spring.datasource.dynamic.primary=master#数据源Aspring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.master.url=jdbc:mysql://192.168.0.101:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.master.username=rootspring.datasource.dynamic.datasource.master.password=#数据源Bspring.datasource.dynamic.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.slave.url=jdbc:mysql://192.168.0.102:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.slave.username=rootspring.datasource.dynamic.datasource.slave.password=0
然后在Service类加上@Transactional注解,并把数据分别插入两个数据源的表中:
#默认数据源spring.datasource.dynamic.primary=master#数据源Aspring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.master.url=jdbc:mysql://192.168.0.101:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.master.username=rootspring.datasource.dynamic.datasource.master.password=#数据源Bspring.datasource.dynamic.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.slave.url=jdbc:mysql://192.168.0.102:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.slave.username=rootspring.datasource.dynamic.datasource.slave.password=1
然后在Controller接口层增加一个入口方法:
#默认数据源spring.datasource.dynamic.primary=master#数据源Aspring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.master.url=jdbc:mysql://192.168.0.101:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.master.username=rootspring.datasource.dynamic.datasource.master.password=#数据源Bspring.datasource.dynamic.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.slave.url=jdbc:mysql://192.168.0.102:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.slave.username=rootspring.datasource.dynamic.datasource.slave.password=2
启动项目,测试,结果是500错误:
我们看控制台日志可以发现问题:
学过Spring都知道@Transactional是本地事务管理,不是分布式事务,所以我们不能在需要切换数据源的方法上加@Transactional注解。
不使用分布式事务的情况下,我们只能让其各自管理各自的事务,中间加多一层Service。
#默认数据源spring.datasource.dynamic.primary=master#数据源Aspring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.master.url=jdbc:mysql://192.168.0.101:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.master.username=rootspring.datasource.dynamic.datasource.master.password=#数据源Bspring.datasource.dynamic.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.slave.url=jdbc:mysql://192.168.0.102:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.slave.username=rootspring.datasource.dynamic.datasource.slave.password=3
#默认数据源spring.datasource.dynamic.primary=master#数据源Aspring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.master.url=jdbc:mysql://192.168.0.101:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.master.username=rootspring.datasource.dynamic.datasource.master.password=#数据源Bspring.datasource.dynamic.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.slave.url=jdbc:mysql://192.168.0.102:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.slave.username=rootspring.datasource.dynamic.datasource.slave.password=4
这样改完之后,我们再测一下,可以看到数据源切换成功了。
如果需要使用分布式事务,官网也说明提供基于seata的分布式事务方案,这里就不演示了,读者有兴趣可以自己尝试一下。
问题四:同一个Service里面,定义了两个不同的方法对应不同的数据源,能互相调用吗?
我们还是以事实说话,先整个例子:
#默认数据源spring.datasource.dynamic.primary=master#数据源Aspring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.master.url=jdbc:mysql://192.168.0.101:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.master.username=rootspring.datasource.dynamic.datasource.master.password=#数据源Bspring.datasource.dynamic.datasource.slave.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.dynamic.datasource.slave.url=jdbc:mysql://192.168.0.102:3306/user?createDatabaseIfNotExist=truespring.datasource.dynamic.datasource.slave.username=rootspring.datasource.dynamic.datasource.slave.password=5
启动项目,测试,发现报错了:
原因是数据源切换的底层原理是使用AOP实现的,如果是内部方法调用是不会使用AOP的,所以也就没法切换数据源。
解决的方法是把getCommodityList()方法提到另一个类里面去。
最后
dynamic-datasource其实还有很多功能没介绍,这里就不一一介绍了,有兴趣的可以到官网上去学习。多数据源在项目开发中是很常见的,所以我觉得学习这个插件还是很有用的。后面如果有时间的话,我会解读一下dynamic-datasource源码,探索一下底层的实现原理。
非常感谢你的阅读,希望这篇文章能给到你帮助和启发。
能力有限,如果有什么错误或者不当之处,请大家批评指正,一起学习交流!