文章目录
前言
在一个实际的企业工程项目当中,我们的数据往往会来源于不同的数据库服务器,所以在调用数据访问层或者业务层的方法时,我们要指定本次访问的数据来源于哪个数据源,最好的方式就是通过注解的方式,直接切换当前方法的数据来源。
所幸的是,MyBatis Plus基于Spring Boot项目开发了一个能够快速切换数据源的注解,在介绍它之前,我们先来了解一下动态切换数据源的原理,同时也可以让没有导入Mybatis Plus的小伙伴也能通过注解实现数据源的切换。
一、SpringBoot项目中切换数据源的原理
1.ThreadLocal
首先,我们来了解一下ThreadLocal类。
ThreadLocal类提供了线程局部变量,只要线程存活并且ThreadLocal实例可以访问,每个线程都保存对其线程局部变量副本的隐式引用; 线程消失后,线程本地实例的所有副本都将被垃圾收集(除非存在对这些副本的其他引用)。
所以,我们可以通过ThreadLocal类将数据源类型信息存放到线程当中,这样的话切换数据源的过程也就相当于切换线程的过程。
2.AbstractRoutingDataSource
接着,了解一下AbstractRoutingDataSource类。
1)并且该类的setDefaultTargetDataSource和setTargetDataSources方法,可以将数据源对象存入到线程当中,setDefaultTargetDataSource存的是默认数据源,setTargetDataSources存入所有的数据源。
2)该类的determineCurrentLookupKey方法每执行一次数据库,动态执行,我们可以通过这个方法获取当前的切换到的数据源。
3.DataSourceContextHolder
接下来,我们需要一个类来管理我们存放到线程上下文当中的数据源,我们将它命名为DataSourceContextHolder,当AbstractRoutingDataSource调用determineCurrentLookupKey方法时,我们就调用DataSourceContextHolder中的方法,将注解当中的数据源切换至线程上下文环境当中。
4.读取数据源配置
通常我们会将项目所涉及到的数据源配置在配置文件当中,对于配置文件的内容读取,倒也没必要像我之前发的那篇文章用Properties类读取,SpringBoot已经提供了@ConfigurationProperties读入配置,我们可以根据配置实例化DataSource对象。
二、使用自定义注解的方法切换数据源
参考文章:
1.yml数据源配置
spring:
datasource:
mainDs:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/test1?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
username: root
password: root
slaveDs:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/test2?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
username: root
password: root
2.相关类
DynamicDataSource:继承AbstractRoutingDataSource,实现动态获取数据源。
DataSourceContextHolder:动态数据源上下文管理,相当于在容器中管理数据源实例。
DynamicDataSourceAspect:动态数据源切面,用于获取注解的数据源。
DynamicDatasourceConfig:动态数据源配置,实例化所有配置数据源
DataSource: 自定义的注解,作用域为方法域
3.具体实现
DynamicDataSource
public class DynamicDataSource extends AbstractRoutingDataSource {
@Override
protected Object determineCurrentLookupKey() {
System.out.println("当前切换至数据源:" + DataSourceContextHolder.getDB());
return DataSourceContextHolder.getDB();
}
}
DataSourceContextHolder
/**
* 默认数据源
*/
public static final String DEFAULT_DS = "mainDs";
private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();
// 设置数据源名
public static void setDB(String dbType) {
contextHolder.set(dbType);
}
// 获取数据源名
public static String getDB() {
return (contextHolder.get());
}
// 清除数据源名
public static void clearDB() {
contextHolder.remove();
}
DynamicDataSourceAspect
@Aspect
@Component
public class DynamicDataSourceAspect {
@Before("@annotation(DataSource)")
public void beforeSwitchDS(JoinPoint point) {
//获得当前访问的class
Class<?> className = point.getTarget().getClass();
//获得访问的方法名
String methodName = point.getSignature().getName();
//得到方法的参数的类型
Class[] argClass = ((MethodSignature) point.getSignature()).getParameterTypes();
String dataSource = DataSourceContextHolder.DEFAULT_DS;
try {
// 得到访问的方法对象
Method method = className.getMethod(methodName, argClass);
// 判断是否存在@DataSource注解
if (method.isAnnotationPresent(DataSource.class)) {
DS annotation = method.getAnnotation(DataSource.class);
// 取出注解中的数据源名
dataSource = annotation.value();
}
} catch (Exception e) {
e.printStackTrace();
}
// 切换数据源
DataSourceContextHolder.setDB(dataSource);
}
// 本项目中DataSource注解定义在com.java.common.support包下,读者可依照需求更改
@After("@annotation(com.java.common.support.DataSource)")
public void afterSwitchDS(JoinPoint point) {
DataSourceContextHolder.clearDB();
}
}
DynamicDatasourceConfig
@Bean(name = "mainDs")
@ConfigurationProperties(prefix = "spring.datasource.mainDs")
public DataSource dataSource1(){return DataSourceBuilder.create().build();}
@Bean(name = "slaveDs")
@ConfigurationProperties(prefix = "spring.datasource.slaveDs")
public DataSource dataSource2(){return DataSourceBuilder.create().build();}
/**
* 动态数据源
* @return
*/
@Bean(name = "dynamicDataSource")
@Primary
public DataSource dataSource() {
DynamicDataSource dynamicDataSource = new DynamicDataSource();
DataSource master = dataSource1();
//设置默认数据源
dynamicDataSource.setDefaultTargetDataSource(master);
//配置多数据源
Map<Object, Object> map = new HashMap<>();
//key需要跟ThreadLocal中的值对应
map.put("mainDs", master);
map.put("slaveDs", dataSource2());
dynamicDataSource.setTargetDataSources(map);
return dynamicDataSource;
}
DataSource
@Retention(RetentionPolicy.RUNTIME)
@Target({
ElementType.METHOD
})
public @interface DataSource{
String value() default "mainDs";
}
业务层代码
// 默认数据源是mainDs配置的数据源
@GetMapping("/test1")
public R test1(){
return testService.test1();
}
@DataSource(value = "mainDs")
@GetMapping("/test2")
public R test2(){
return testService.test2();
}
@DataSource(value = "slaveDs")
@GetMapping("/test3")
public R test3(){
return testService.test3();
}
三、Mybatis-Plus实现快速切换
具体实现
我们发现切换数据源的过程确实是一件十分麻烦的事情,而Mybatis-Plus为了简化开发,用了一个十分快速的切换方式,就是使用@Ds注解,轻松实现数据源的切换,详情可以看官网。
修改一下我们的数据源配置:
spring:
datasource:
dynamic:
primary: mainDs #设置默认的数据源或者数据源组,默认值即为master
strict: true #严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
datasource:
mainDs:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/test1?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
username: root
password: root
slaveDs:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/test2?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
username: root
password: root
我们在导入Mybatis-Plus的依赖之后,可以直接用文件中的配置名作为注解的"value"将数据源对象存入线程上下文了。
业务层代码
// 默认数据源是mainDs配置的数据源
@GetMapping("/test1")
public R test1(){
return testService.test1();
}
@DS("mainDs")
@GetMapping("/test2")
public R test2(){
return testService.test2();
}
@DS("slaveDs")
@GetMapping("/test3")
public R test3(){
return testService.test3();
}
总结
本文首先我们剖析了一下动态切换数据源所涉及到的必要知识前提,继而自定义了一个注解实现动态数据源的切换,不仅让小伙伴们知道了Mybatis-Plus实现动态数据源切换的底层原理,也让项目中没有导入Mybatis-Plus的小伙伴也有办法实现动态数据源切换。最后我们介绍了Mybatis-Plus实现动态数据源切换的应用,可以说是十分方便,本人最建议大家直接使用后面这种方法实现数据源切换,这样可以省去大量的开发工作。