SpringBoo Mybatis Druid配置多数据源
前言:当单个数据库无法满足大量读写操作需求的时候,就需要用到多个数据库实现读写分离了。那么,这个时候,就需要去配置多数据源了。那么具体如何配置呢?本就将给出基本的配置示例…
一 创建两个数据库用于测试
我这里分别创建了 datasourceone 和 datasourcetwo 两个数据库,并分别创建了t_user 和 t_student 两张表,表字段非常简单,都是一样的,如图所示:
二 创建SpringBoot工程进行测试
1. 配置pom依赖
说明:需要引入相应的Mysql Mybatis
以及 Druid
依赖。需要注意的是,如果你用的是SpringBoot2.x
的版本,Durid
依赖请使用1.1.10
版本(否则,可能会导致项目无法启动):
<!-- druid数据源驱动 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.10</version>
</dependency>
2. 配置文件
具体配置属性均有说明,这里就不再赘述了:
spring:
datasource:
# 数据库访问配置, 使用druid数据源
type: com.alibaba.druid.pool.DruidDataSource
druid:
# 数据源1 master
master:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/datasourceone?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true&autoReconnect=true&failOverReadOnly=false
username: root
password: root
# 数据源2 slaver
slaver:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/datasourcetwo?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true&autoReconnect=true&failOverReadOnly=false
username: root
password: root
# 连接池配置
initial-size: 5
min-idle: 5
max-active: 20
# 连接等待超时时间
max-wait: 30000
# 配置检测可以关闭的空闲连接间隔时间
time-between-eviction-runs-millis: 60000
# 配置连接在池中的最小生存时间
min-evictable-idle-time-millis: 300000
validation-query: select '1' from dual
test-while-idle: true
test-on-borrow: false
test-on-return: false
# 打开PSCache,并且指定每个连接上PSCache的大小
pool-prepared-statements: true
max-open-prepared-statements: 20
max-pool-prepared-statement-per-connection-size: 20
# 配置监控统计拦截的filters, 去掉后监控界面sql无法统计, 'wall'用于防火墙
filters: stat,wall
# Spring监控AOP切入点,如x.y.z.service.*,配置多个英文逗号分隔
aop-patterns: com.springboot.servie.*
# WebStatFilter配置
web-stat-filter:
enabled: true
# 添加过滤规则
url-pattern: /*
# 忽略过滤的格式
exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*'
# StatViewServlet配置
stat-view-servlet:
enabled: true
# 访问路径为/druid时,跳转到StatViewServlet
url-pattern: /druid/*
# 是否能够重置数据
reset-enable: false
# 需要账号密码才能访问控制台
login-username: druiduser
login-password: druidpwd
# IP白名单
# allow: 127.0.0.1
# IP黑名单(共同存在时,deny优先于allow)
# deny: 192.168.1.218
# 配置StatFilter
filter:
stat:
log-slow-sql: true
3. 多数据源配置
实际上,在SpringBoot Mybatis配置多数据源的关键就是创建SqlSessionFactory的时候为其分配不同的数据源。
.yml文件已经配置好了主从数据库的连接信息,这里需要创建两个数据源配置类,分别完成两个数据源的配置:
3.1 主数据源配置类
/**
* 主数据源配置类
*/
@Configuration
@MapperScan(basePackages = MasterDataSourceConfig.PACKAGE, sqlSessionFactoryRef = "masterSqlSessionFactory")
public class MasterDataSourceConfig {
/**
* dao扫描路径
*/
static final String PACKAGE = "com.czj.test.dao.masterdao";
/**
* mybatis-mapper 扫描路径
*/
private static final String MAPPER_LOCATION = "classpath:mapper/master/*.xml";
/**
* 创建名为 masterDataSource 的数据源
*/
@Bean(name = "masterDataSource")
@Primary //该注解的作用是,当有多个相同的Bean的时候,优先选择有该注解的Bean 配置多数据源,必须有一个主数据源
@ConfigurationProperties(prefix = "spring.datasource.druid.master")
public DataSource masterDataSource() {
return DruidDataSourceBuilder.create().build();
}
@Bean(name = "masterTransactionManager")
@Primary
public DataSourceTransactionManager masterTransactionManager() {
return new DataSourceTransactionManager(masterDataSource());
}
/**
* 将名为 masterDataSource 的数据源注入到 SqlSessionFactory
*/
@Bean(name = "masterSqlSessionFactory")
@Primary
public SqlSessionFactory masterSqlSessionFactory(@Qualifier("masterDataSource") DataSource masterDataSource)
throws Exception {
final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
sessionFactory.setDataSource(masterDataSource);
sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver()
.getResources(MasterDataSourceConfig.MAPPER_LOCATION));
return sessionFactory.getObject();
}
}
具体的配置说明,注释中都有,就不重复说明啦~
3.2 从数据源配置类
和master数据源基本一致,区别就在于扫描路径不一样,以及读取.yml配置文件的属性值不一样。
@Configuration
@MapperScan(basePackages = SlaverDataSourceConfig.PACKAGE, sqlSessionFactoryRef = "slaverSqlSessionFactory")
public class SlaverDataSourceConfig {
/**
* dao扫描路径
*/
static final String PACKAGE = "com.czj.test.dao.slaverdao";
/**
* mybatis-mapper 扫描路径
*/
private static final String MAPPER_LOCATION = "classpath:mapper/slaver/*.xml";
/**
* 创建名为 slaverDataSource 的数据源
* 注意和主数据源的区别在于 读取.yml配置文件配置项不一样
* 以及从数据源是不需要 @Primary 注解的
*/
@Bean(name = "slaverDataSource")
@ConfigurationProperties(prefix = "spring.datasource.druid.slaver")
public DataSource clusterDataSource() {
return DruidDataSourceBuilder.create().build();
}
@Bean(name = "slaverTransactionManager")
public DataSourceTransactionManager clusterTransactionManager() {
return new DataSourceTransactionManager(clusterDataSource());
}
/**
* 将名为 slaverDataSource 的数据源注入到 SqlSessionFactory
*/
@Bean(name = "slaverSqlSessionFactory")
public SqlSessionFactory clusterSqlSessionFactory(@Qualifier("slaverDataSource") DataSource slaverDatasource)
throws Exception {
final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
sessionFactory.setDataSource(slaverDatasource);
sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(SlaverDataSourceConfig.MAPPER_LOCATION));
return sessionFactory.getObject();
}
}
其他配置和平常单个数据源基本是一样的,没有什么太多区别,我的项目目录如下图所示:
4. 多数据源配置测试
OK 到此就都配置完成了,开始测试,记得现在数据源随便添加几条数据。测试结果如下:
4.1 datasourceone
4.2 datasourcetwo
OK 关于多数据源的配置就介绍到这里啦~
等等,上面的配置是不是有什么问题呢?
是的,不够灵活,无法做到动态的切换数据源,不同数据源的dao以及mapper都要明确分开来。
那么,有没有办法可以实现数据源
的动态加载
呢?
当然是有的!
接下来,就对上面的代码稍加改造,通过AOP+注解
的方式实现数据源的动态加载
。
三 多数据源的动态加载
特别说明:
-
数据库无需改变,直接用上面的,也就是两个数据源;
-
.yml配置文件,增加如下配置(其实这里可以不分master和slaver目录):
mybatis: mapper-locations: classpath:mapper/**/*.xml
-
新建一个数据源标识枚举类(用于区分不用的数据源);
/** * 不同数据源切换标识 */ public enum DataSourceEnum { MASTER, SLAVER; }
-
自定义数据源选择注解,通过在方法上添加此注解完成数据源的动态切换;
/** * 自定义数据源选择注解 默认为MASTER数据源 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) @Documented public @interface ChooseDataSource { public DataSourceEnum name() default DataSourceEnum.MASTER; }
-
然后就是数据源的具体配置了(重点)
大概过程就是:
通过ThreadLocal
实现对数据源上下文的增删以及获取操作;通过继承
AbstractRoutingDataSource
类,重写determineCurrentLookupKey()
方法,该方法可以决定使用哪一个数据源。主要用到AbstractRoutingDataSource
的defaultTargetDataSource
属性用于设置默认数据源,targetDataSources
属性用于用于存放需要切换到的数据源(map类型)。最后通过AOP切换,实现数据源的选择,使用以及使用完之后的移除。
数据源的具体配置代码如下:
数据源上下文
/**
* 数据源上下文
*/
public class DynamicDataSourceHolder {
private static final ThreadLocal<DataSourceEnum> holder = new ThreadLocal<DataSourceEnum>();
private DynamicDataSourceHolder() {
}
public static void putDataSource(DataSourceEnum dataSource) {
holder.set(dataSource);
}
public static DataSourceEnum getDataSource() {
return holder.get();
}
public static void clearDataSource() {
holder.remove();
}
}
继承AbstractRoutingDataSource
类,重写determineCurrentLookupKey()
方法
/**
* 动态切换数据源类
*/
public class DynamicDataSource extends AbstractRoutingDataSource {
public DynamicDataSource(DataSource defaultTargetDataSource, Map<Object, Object> targetDataSources) {
//设置默认数据源 多数据源必须设置这个
super.setDefaultTargetDataSource(defaultTargetDataSource);
//设置用于切换的数据源
super.setTargetDataSources(targetDataSources);
// afterPropertiesSet()方法调用的作用是将targetDataSources的属性写入resolvedDataSources中
super.afterPropertiesSet();
}
//重写该方法 实现数据源的切换
@Override
protected Object determineCurrentLookupKey() {
return DynamicDataSourceHolder.getDataSource();
}
}
多数据源配置类,创建不同的数据源
/**
* 多数据源配置类
*/
@Configuration
@Component
public class DataSourceConfig {
/**
* 创建名为 masterDataSource 的数据源
*/
@Bean(name = "masterDataSource")
@ConfigurationProperties(prefix = "spring.datasource.druid.master")
public DataSource masterDataSource() {
return DruidDataSourceBuilder.create().build();
}
/**
* 创建名为 slaverDataSource 的数据源
*/
@Bean(name = "slaverDataSource")
@ConfigurationProperties(prefix = "spring.datasource.druid.slaver")
public DataSource slaverDataSource() {
return DruidDataSourceBuilder.create().build();
}
@Bean
@Primary
public DynamicDataSource dataSource(DataSource masterDataSource, DataSource slaverDataSource) {
Map<Object, Object> targetDataSources = new HashMap<>();
targetDataSources.put(DataSourceEnum.MASTER, masterDataSource);
targetDataSources.put(DataSourceEnum.SLAVER, slaverDataSource);
return new DynamicDataSource(masterDataSource, targetDataSources);
}
}
通过AOP实现动态数据源切换
说明:这里用的环绕增强,使用前置以及后置增强也是可以的。
@Aspect
@Component
public class DataSourceAspect {
//定义一个切点 添加了ChooseDataSource注解的方法
@Pointcut("@annotation(com.czj.test.annotation.ChooseDataSource)")
public void dataSourcePointCut() {
}
//环绕增强 调用方法前设置数据源 调用方法后清除数据源
@Around("dataSourcePointCut()")
public Object around(ProceedingJoinPoint point) throws Throwable {
MethodSignature signature = (MethodSignature) point.getSignature();
Method method = signature.getMethod();
ChooseDataSource chooseDataSource = method.getAnnotation(ChooseDataSource.class);
if (chooseDataSource == null) {
//这一步也可以不要 因为默认会使用MASTER数据源
DynamicDataSourceHolder.putDataSource(DataSourceEnum.MASTER);
} else {
DynamicDataSourceHolder.putDataSource(chooseDataSource.name());
}
try {
return point.proceed();
} finally {
//清除数据源 无论异常都会完成数据源的清除
DynamicDataSourceHolder.clearDataSource();
}
}
}
OK, 至此,动态数据源的切换完成。具体测试和上面一样,我就不再重复测试啦~