浅谈利用Spring的AbstractRoutingDataSource解决多数据源的问题
作者:Hing Kwan 发布时间:2021-09-07 07:20:59
在互联网的服务端开发的时候,我们很经常要在一个项目中去调用不同的数据库。在这种情况下,必然要涉及到多数据源问题。那么,我们该如何解决多数据源问题呢?有没有一种方法来动态切换数据源呢?
答案是有的。万能的Spring已经给了我们解决方案——利用AbstractRoutingDataSource。在 AbstractRoutingDataSource 类中,发现 getConnection() 方法,从名字上可以知道它是获得connection连接的。跟踪 getConnection() 方法, determineTargetDataSource() 就这么进入我们的视线,继续下去,我们发现了重点—— determineCurrentLookupKey() 。 determineCurrentLookupKey 方法是一个抽象方法,它的返回值就是我们要用到的数据源dataSource的key,然后根据这个key从 resolvedDataSources 这个map中取出dataSource,如果找不到就使用默认的dataSource。
知道了这些,我们就来用代码实现吧!以下的代码是基于Spring Boot,所以需要建立一个Spring Boot项目,然后引入spring-boot-starter-jdbc。项目中又有用到AOP,肯定的,我们必须引入spring-boot-starter-aop。
接下来,我们需要建一个DynamicDataSource。
public class DynamicDataSourceextends AbstractRoutingDataSource{
@Override
protectedObjectdetermineCurrentLookupKey(){
String dataSourceName = DynamicDataSourceContextHolder.getDataSourceName();
return dataSourceName;
}
}
DynamicDataSource 继承了抽象类 AbstractRoutingDataSource ,实现了 determineCurrentLookupKey() 。在 DynamicDataSourceContextHolder 中,我们使用ThreadLocal维护 dataSouceName 这个变量。这样,每一个线程都可以独立改变自己的副本,而不会影响其他线程所对应的副本。
/**
* 动态数据源上下文
*/
public class DynamicDataSourceContextHolder{
private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();
public static List<String> dataSourceNames = new ArrayList<>();
public static void setDataSourceName(String name){
contextHolder.set(name);
}
public staticStringgetDataSourceName(){
return contextHolder.get();
}
public static void clearDataSourceName(){
contextHolder.remove();
}
public static boolean containsDataSource(String dataSourceName){
return dataSourceNames.contains(dataSourceName);
}
}
OK,我们已经有了动态数据源DynamicDataSource,也有了DynamicDataSourceContextHolder,我们怎么使用呢?让我们看下 DataSourceConfig 。
@Configuration
public class DataSourceConfig{
@Bean(name = "primaryDataSource")
@ConfigurationProperties(prefix = "spring.datasource.primary")
@Primary
publicDataSourceprimaryDataSource(){
return DataSourceBuilder.create().build();
}
@Bean(name = "secondaryDataSource")
@ConfigurationProperties(prefix = "spring.datasource.secondary")
publicDataSourcesecondaryDataSource(){
return DataSourceBuilder.create().build();
}
@Autowired
@Qualifier("primaryDataSource")
private DataSource primaryDataSource;
@Autowired
@Qualifier("secondaryDataSource")
private DataSource secondaryDataSource;
@Bean
publicDynamicDataSourcedataSource(){
Map<Object, Object> targetDataSources = new HashMap<>();
targetDataSources.put("primaryDataSource", primaryDataSource);
targetDataSources.put("secondaryDataSource", secondaryDataSource);
DynamicDataSourceContextHolder.dataSourceNames.add("primaryDataSource");
DynamicDataSourceContextHolder.dataSourceNames.add("secondaryDataSource");
DynamicDataSource dataSource = new DynamicDataSource();
//设置数据源映射
dataSource.setTargetDataSources(targetDataSources);
//设置默认数据源,当无法映射到数据源时会使用默认数据源
dataSource.setDefaultTargetDataSource(primaryDataSource);
dataSource.afterPropertiesSet();
return dataSource;
}
}
当然,上面的 DataSourceConfig 还得搭配 application.properties 配置文件。
#
spring.datasource.primary.jdbcUrl=jdbc:mysql://localhost/test1?useSSL=false
spring.datasource.primary.username=root
spring.datasource.primary.password=root
spring.datasource.primary.driver-class-name=com.mysql.jdbc.Driver
#
spring.datasource.secondary.jdbcUrl=jdbc:mysql://localhost/test2?useSSL=false
spring.datasource.secondary.username=root
spring.datasource.secondary.password=root
spring.datasource.secondary.driver-class-name=com.mysql.jdbc.Driver
到现在为止,我们已经配置了动态的数据源,将我们的多个数据源设置给了DynamicDataSource。这样,我们就可以在Service或者是Dao中使用 DynamicDataSourceContextHolder.setDataSourceName("primaryDataSource")
方法来动态切换数据源了。但是,这样的写法会不会感到很不爽呢?其实,我们可以在方法上使用注解来切换数据源。
自定义一个注解TargetDataSource:
/**
* 在方法上使用,用于指定使用哪个数据源
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TargetDataSource {
Stringvalue();
}
这样,我们就可以在Service上如以下使用:
@TargetDataSource(value = "primaryDataSource")
publicList<Customer>findAll(){
//TODO
return null;
}
@TargetDataSource(value = "secondaryDataSource")
public void addCustomer(String name, String email){
}
很明显的,到目前为止还不能完成我们的切换需求。我们还需要一段代码,来实现动态调用 DynamicDataSourceContextHolder.setDataSourceName("xxx")
,比较好的实现就是AOP啦。
@Aspect
@Component
@Order(-1)// 保证该AOP在@Transactional之前执行
public class DynamicDataSourceChangeAspect{
private static final Logger logger = LoggerFactory.getLogger(DynamicDataSourceChangeAspect.class);
@Before("@annotation(targetDataSource)")
public void changeDataSource(JoinPoint joinPoint, TargetDataSource targetDataSource){
String dsName = targetDataSource.value();
if (!DynamicDataSourceContextHolder.containsDataSource(dsName)) {
System.err.println("数据源[{}]不存在,使用默认数据源 > {}" + targetDataSource.value() + joinPoint.getSignature());
} else {
DynamicDataSourceContextHolder.setDataSourceName(targetDataSource.value()); //设置到动态数据源上下文中
}
}
@After("@annotation(targetDataSource)")
public void restoreDataSource(JoinPoint point, TargetDataSource targetDataSource){
//方法执行完毕之后,销毁当前数据源信息,进行垃圾回收。
DynamicDataSourceContextHolder.clearDataSourceName();
}
}
到现在为止,我们就实现了动态切换数据源了。
来源:http://webfuse.cn/2017/08/10/%E5%88%A9%E7%94%A8Spring%E7%9A%84AbstractRoutingDataSource%E8%A7%A3%E5%86%B3%E5%A4%9A%E6%95%B0%E6%8D%AE%E6%BA%90%E7%9A%84%E9%97%AE%E9%A2%98/?utm_source=tuicool&utm_medium=referral
猜你喜欢
- C#串口模块的使用。使用VS .net框架下WinForm程序应用开发。C#开发的串口通信小工具。相比于QT添加的串口类,WinForm是通
- mybatis多个区间处理如图:要实现车辆数不同区间查询条件思路a.前端传数组,数组里面放"1-5"String类型值
- 前言接口调试是每个软件开发从业者必不可少的一项技能,一个项目的的完成,可能接口测试调试的时间比真正开发写代码的时间还要多,几乎是每个开发的日
- 一、创建项目1.File->new->project;2.选择“Spring Initializr”,点击next;(jdk1.
- 第一步:引入jar包 <dependency> <gro
- 前言:什么是多数据源?最常见的单一应用中最多涉及到一个数据库,即是一个数据源(Datasource)。那么顾名思义,多数据源就是在一个单一应
- 判断参数是否为空并作为查询条件@Override public Page<DemandEntity>
- 项目上线之后,如果日志打印的很模糊或者业务逻辑比较复杂,有时候无法定位具体的错误原因,因此可以通过IDEA远程代理进行Debug。线上的代码
- 删除本地仓库未下载完成的缓存文件(删除像图片显示这样以.lastUpdated结尾的文件)执行mvn -v确保maven命令可以正常执行执行
- reduce()简介Reduce 原意:减少,缩小根据指定的计算模型将Stream中的值计算得到一个最终结果解释:reduce 操
- Struts2简介Struts2是一个基于MVC设计模式的Web应用框架,它本质上相当于一个servlet,在MVC设计模式中,Struts
- 简介官方API文档Scaffold的of方法说明有说明调用Scaffold.of方法是在Scallfold的子组件的Build方法中,也就是
- 前言在服务器上,当我们启动了tomcat,就可以以http://ip地址:8080/文件路径/文件名的方式,进行访问到我们服务器上处于tom
- 全面解析java注解Java中的常见注解 a.JDK中的注解 @Override 覆盖父类或者父接口的方
- 通过之前三篇关于Spring Boot异步任务实现的博文,我们分别学会了用@Async创建异步任务、为异步任务配置线程池、使用多个线程池隔离
- 前言通过此篇文章,你将了解到:Flutter windows和Android桌面应用屏幕适配的解决方案;屏幕适配的相关知识和原理;flutt
- 本文实例为大家分享了java实现马踏棋盘的具体代码,供大家参考,具体内容如下马踏棋盘算法介绍8X8棋盘,马走日字,要求每个方格只进入一次,走
- spring FactoryBean 是创建 复杂的bean,一般的bean 直接用xml配置即可,如果一个bean的创建过程中
- 一、前言系统执行业务逻辑之前,会对输入数据进行校验,检测数据是否有效合法的。所以我们可能会写大量的if else等判断逻辑,特别是在不同方法
- 在项目中使用Maven管理jar包依赖,往往会出现以下状况:1、国内访问maven默认远程中央镜像特别慢;2、使用阿里的镜像替代远程中央镜像