spring boot2.0 +Mybatis + druid搭建一个最简单的多数据源
多数据源系列
1、spring boot2.0 +Mybatis + druid搭建一个最简单的多数据源
2、利用Spring的AbstractRoutingDataSource做多数据源动态切换
3、使用dynamic-datasource-spring-boot-starter做多数据源及源码分析
简介
前两篇博客介绍了用基本的方式做多数据源,可以应对一般的情况,但是遇到一些复杂的情况就需要扩展下功能了,比如:动态增减数据源、数据源分组,纯粹多库 读写分离 一主多从、从其他数据库或者配置中心读取数据源等等。其实就算没有这些需求,使用这个实现多数据源也比之前使用AbstractRoutingDataSource要便捷的多
dynamic-datasource-spring-boot-starter 是一个基于springboot的快速集成多数据源的启动器。
github: https://github.com/baomidou/dynamic-datasource-spring-boot-starter
文档: https://github.com/baomidou/dynamic-datasource-spring-boot-starter/wiki
它跟mybatis-plus是一个生态圈里的,很容易集成mybatis-plus
特性:
- 数据源分组,适用于多种场景 纯粹多库 读写分离 一主多从 混合模式。
- 内置敏感参数加密和启动初始化表结构schema数据库database。
- 提供对Druid,Mybatis-Plus,P6sy,Jndi的快速集成。
- 简化Druid和HikariCp配置,提供全局参数配置。
- 提供自定义数据源来源接口(默认使用yml或properties配置)。
- 提供项目启动后增减数据源方案。
- 提供Mybatis环境下的 纯读写分离 方案。
- 使用spel动态参数解析数据源,如从session,header或参数中获取数据源。(多租户架构神器)
- 提供多层数据源嵌套切换。(ServiceA >>> ServiceB >>> ServiceC,每个Service都是不同的数据源)
- 提供 不使用注解 而 使用 正则 或 spel 来切换数据源方案(实验性功能)。
- 基于seata的分布式事务支持。
实操
先把坐标丢出来
<dependency> <groupId>com.baomidou</groupId> <artifactId>dynamic-datasource-spring-boot-starter</artifactId> <version>3.1.0</version> </dependency>
下面抽几个用的比较多的应用场景介绍
基本使用
使用方法很简洁,分两步走
一:通过yml配置好数据源
二:service层里面在想要切换数据源的方法上加上@DS注解就行了,也可以加在整个service层上,方法上的注解优先于类上注解
spring: datasource: dynamic: primary: master #设置默认的数据源或者数据源组,默认值即为master strict: false #设置严格模式,默认false不启动. 启动后在未匹配到指定数据源时候回抛出异常,不启动会使用默认数据源. datasource: master: url: jdbc:mysql://127.0.0.1:3306/dynamic username: root password: 123456 driver-class-name: com.mysql.jdbc.Driver db1: url: jdbc:gbase://127.0.0.1:5258/dynamic username: root password: 123456 driver-class-name: com.gbase.jdbc.Driver
这就是两个不同数据源的配置,接下来写service代码就行了
# 多主多从
spring:
datasource:
dynamic:
datasource:
master_1:
master_2:
slave_1:
slave_2:
slave_3:
如果是多主多从,那么就用数据组名称_xxx,下划线前面的就是数据组名称,相同组名称的数据源会放在一个组下。切换数据源时,可以指定具体数据源名称,也可以指定组名然后会自动采用负载均衡算法切换
# 纯粹多库(记得设置primary)
spring:
datasource:
dynamic:
datasource:
db1:
db2:
db3:
db4:
db5:
纯粹多库,就一个一个往上加就行了
@Service @DS("master") public class UserServiceImpl implements UserService { @Autowired private JdbcTemplate jdbcTemplate; public List<Map<String, Object>> selectAll() { return jdbcTemplate.queryForList("select * from user"); } @Override @DS("db1") public List<Map<String, Object>> selectByCondition() { return jdbcTemplate.queryForList("select * from user where age >10"); } }
注解 | 结果 |
---|---|
没有@DS | 默认数据源 |
@DS(“dsName”) | dsName可以为组名也可以为具体某个库的名称 |
通过日志可以发现我们配置的多数据源已经被初始化了,如果切换数据源也会看到打印日子的
是不是很便捷,这是官方的例子
集成druid连接池
<dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.1.22</version> </dependency>
首先引入依赖
spring:
autoconfigure:
exclude: com.alibaba.druid.spring.boot.autoconfigure.DruidDataSourceAutoConfigure
再排除掉druid原生的自动配置
spring: datasource: #数据库链接相关配置 dynamic: druid: #以下是全局默认值,可以全局更改 #监控统计拦截的filters filters: stat #配置初始化大小/最小/最大 initial-size: 1 min-idle: 1 max-active: 20 #获取连接等待超时时间 max-wait: 60000 #间隔多久进行一次检测,检测需要关闭的空闲连接 time-between-eviction-runs-millis: 60000 #一个连接在池中最小生存的时间 min-evictable-idle-time-millis: 300000 validation-query: SELECT 'x' test-while-idle: true test-on-borrow: false test-on-return: false #打开PSCache,并指定每个连接上PSCache的大小。oracle设为true,mysql设为false。分库分表较多推荐设置为false pool-prepared-statements: false max-pool-prepared-statement-per-connection-size: 20 stat: merge-sql: true log-slow-sql: true slow-sql-millis: 2000 primary: master datasource: master: url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true&serverTimezone=GMT%2B8 username: root password: root driver-class-name: com.mysql.cj.jdbc.Driver gbase1: url: jdbc:gbase://127.0.0.1:5258/test?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&failOverReadOnly=false&useSSL=false&zeroDateTimeBehavior=convertToNull username: gbase password: gbase driver-class-name: com.gbase.jdbc.Driver druid: # 以下参数针对每个库可以重新设置druid参数 initial-size: validation-query: select 1 FROM DUAL #比如oracle就需要重新设置这个 public-key: #(非全局参数)设置即表示启用加密,底层会自动帮你配置相关的连接参数和filter。
配置好了就可以了,切换数据源的用法和上面的一样的,打@DS(“db1”)注解到service类或方法上就行了
详细配置参考这个配置类com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DynamicDataSourceProperties
service嵌套
这个就是特性的第九条:提供多层数据源嵌套切换。(ServiceA >>> ServiceB >>> ServiceC,每个Service都是不同的数据源)
借用源码中的demo:实现SchoolService >>> studentService、teacherService
@Service public class SchoolServiceImpl{ public void addTeacherAndStudent() { teacherService.addTeacherWithTx("ss", 1); teacherMapper.addTeacher("test", 111); studentService.addStudentWithTx("tt", 2); } } @Service @DS("teacher") public class TeacherServiceImpl { public boolean addTeacherWithTx(String name, Integer age) { return teacherMapper.addTeacher(name, age); } } @Service @DS("student") public class StudentServiceImpl { public boolean addStudentWithTx(String name, Integer age) { return studentMapper.addStudent(name, age); } }
这个addTeacherAndStudent调用数据源切换就是primary ->teacher->primary->student->primary
关于其他demo可以看官方wiki,里面写了很多用法,这里就不赘述了,重点在于学习原理。。。
为什么切换数据源不生效或事务不生效?
这种问题常见于上一节service嵌套,比如serviceA -> serviceB、serviceC,serviceA
加上@Transaction
简单来说:嵌套数据源的service中,如果操作了多个数据源,不能在最外层加上@Transaction开启事务,否则切换数据源不生效,因为这属于分布式事务了,需要用seata方案解决,如果是单个数据源(不需要切换数据源)可以用@Transaction开启事务,保证每个数据源自己的完整性
下面来粗略的分析加事务不生效的原因:
它这个切换数据源的原理就是实现了DataSource接口,实现了getConnection方法,只要在service中开启事务,service中对其他数据源操作只会使用开启事务的数据源,因为开启事务数据源会被缓存下来,可以在DataSourceTransactionManager的doBegin方法中看见那个txObject,如果在一个事务内,就会复用Connection,所以切换不了数据源
/** * This implementation sets the isolation level but ignores the timeout. */ @Override protected void doBegin(Object transaction, TransactionDefinition definition) { DataSourceTransactionObject txObject = (DataSourceTransactionObject) transaction; Connection con = null; try { if (!txObject.hasConnectionHolder() || txObject.getConnectionHolder().isSynchronizedWithTransaction()) { // 开启一个新事务会获取一个新的Connection,所以会调用DataSource接口的getConnection方法,从而切换数据源 Connection newCon = obtainDataSource().getConnection(); if (logger.isDebugEnabled()) { logger.debug("Acquired Connection [" + newCon + "] for JDBC transaction"); } txObject.setConnectionHolder(new ConnectionHolder(newCon), true); } txObject.getConnectionHolder().setSynchronizedWithTransaction(true); // 如果已经开启了事务,就从holder中获取Connection con = txObject.getConnectionHolder().getConnection(); ………… }
多数据源事务嵌套
看上面源码,说是新起一个事务才会重新获取Connection,才会成功切换数据源,那我在每个数据源的service方法上都加上@Transaction呢?(涉及spring事务传播行为)这里做个小实验,还是上面的例子,serviceA ->(嵌套) serviceB、serviceC,serviceA
加上@Transaction,现在给serviceB和serviceC的方法上也加上@Transaction,就是所有service里被调用的方法都打上@Transaction注解
@Transactional public void addTeacherAndStudentWithTx() { teacherService.addTeacherWithTx("ss", 1); studentService.addStudentWithTx("tt", 2); throw new RuntimeException("test"); }
类似这样,里面两个service也都加上了@Transaction
实际上这样数据源也不会切换,因为默认事务传播级别为required,父子service属于同一事物所以就会用同一Connection。而这里是多数据源,如果把事务传播方式改成require_new给子service起新事物,可以切换数据源,他们都是独立的事务了,然后父service回滚不会导致子service回滚(详见spring事务传播),这样保证了每个单独的数据源的数据完整性,如果要保证所有数据源的完整性,那就用seata分布式事务框架
@Transactional public void addTeacherAndStudentWithTx() { // 做了数据库操作 aaaDao.doSomethings(“test”); teacherService.addTeacherWithTx("ss", 1); studentService.addStudentWithTx("tt", 2); throw new RuntimeException("test"); }
关于事务嵌套,还有一种情况就是在外部service里面做DB1的一些操作,然后再调用DB2、DB3的service,再想保证DB1的事务,就需要在外部service上加@Transaction,如果想让里面的service正常切换数据源,根据事务传播行为,设置为propagation = Propagation.REQUIRES_NEW就可以了,里面的也能正常切换数据源了,因为它们是独立的事务
补充:关于@Transaction操作多数据源事务的问题
@Transaction public void insertDB1andDB2() { db1Service.insertOne(); db2Service.insertOne(); throw new RuntimeException("test"); }
类似于上面这种操作,我们通过注入多个DataSource、DataSourceTransactionManager、SqlSessionFactory、SqlSessionTemplate这四种Bean的方式来实现多数据源(最顶上第一篇博客提到的方式),然后在外部又加上了@Transaction想实现事务
我试过在中间抛异常查看能不能正常回滚,结果发现只会有一个数据源的事务生效,点开@Transaction注解,发现里面有个transactionManager属性,这个就是指定之前声明的transactionManager Bean,我们默认了DB1的transactionManager为@Primary,所以这时DB2的事务就不会生效,因为用的是DB1的TransactionManager。因为@Transactional只能指定一个事务管理器,并且注解不允许重复,所以就只能使用一个数据源的事务管理器了。如果DB2中的更新失败,我想回滚DB1和DB2以进行回滚,可以使用ChainedTransactionManager来解决,它可以最后尽最大努力回滚事务