mybatis-plus实战(一)多数据源@DS和@Transactional冲突

背景介绍

因为一次使用mybatis plus @DS 注解实现多数据源切换时,在一个controller中同时操作多个数据源的service方法,为了保证这一组操作下数据的完整性,则需要使用事务@Transaction进行保证,于是乎,粗暴的在controller方法上加上了该注解,原以为可以万事大吉,一运行程序发现数据源切换失败了!一泼凉水浇的是透心凉~ ,好在问题比较简单,仔细一想便知道问题出在哪里,废话不多说,咱们先看代码

代码演示

首先看一下,使用mybatis-plus 如何配置多数据源,application-local.yml配置如下

spring:
  datasource:
    dynamic:
      # 是否开启 SQL日志输出,生产环境建议关闭,有性能损耗
      p6spy: true
      hikari:
        connection-timeout: 30000
        max-lifetime: 1800000
        max-pool-size: 15
        min-idle: 5
        connection-test-query: select 1
        pool-name: OpsHikariCP
      # 配置默认数据源
      primary: base
      datasource:
        # 数据源-1,名称为 base
        base:
          username: root
          password: 123456
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://127.0.0.1:3306/smart_ops?characterEncoding=utf-8&autoReconnect=true&useSSL=false&serverTimezone=GMT%2b8
        # 数据源-2,名称为 quartz
        quartz:
          username: root
          password: 123456
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql:/127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=GMT%2b8

需要引入maven依赖

  		 <!-- MyBatis增强插件 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!-- MyBatis plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.1.0</version>
        </dependency>
        <!-- MyBatis plus core -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-core</artifactId>
            <version>3.1.0</version>
            <scope>compile</scope>
        </dependency>

添加@DS(“quartz”)注解只用支持多数据源切换,value是你配置文件里面datasource数据源的名称即可。

package com.cnhqd.quartz.service;

import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.baomidou.mybatisplus.extension.service.IService;
import com.cnhqd.quartz.entity.JobInfo;
import com.xxl.job.core.biz.model.ReturnT;


/**
 * @author afj
 * @date 2020-12-31 11:18:29
 * (JobInfo)表服务接口
 */
@DS("quartz")
@Transactional(propagation = Propagation.REQUIRES_NEW, rollbackFor = Exception.class)
public interface JobInfoService extends IService<JobInfo> {

    /**
     * 通过ID查询单条数据
     *
     * @param id 主键
     * @return 实例对象
     */
    JobInfo queryById(Integer id);

    /**
     * add job
     *
     * @param cron            cron
     * @param desc            desc
     * @param jobId           job id
     * @param status          status default 0
     * @param executorHandler handler
     * @return ReturnT<String>
     */
    ReturnT<String> createJob(String cron, String desc, String jobId, String executorHandler, final Integer status);

    /**
     * update job
     *
     * @param jobInfo
     * @return
     */
    ReturnT<String> updateJob(JobInfo jobInfo);

    /**
     * remove job
     * *
     *
     * @param id
     * @return
     */
    ReturnT<String> remove(Integer id);

    /**
     * start job
     *
     * @param id
     * @return
     */
    ReturnT<String> start(Integer id);

    /**
     * stop job
     *
     * @param id
     * @return
     */
    ReturnT<String> stop(Integer id);
}

相关的业务代码如下,简单列举 JobController 中的createJob方法(这里吐槽一下,代码很low,当前版本仅为了快速实现功能)

/**
 * 定时工单表(Job)控制层
 * 下个版本计划:添加eventBus 事件监听进行应用解耦,抽取定时任务相关的依赖,形成组件
 *
 * @author afj
 */
@RestController
@RequestMapping("job")
@Api(tags = "定时工单相关接口")
@Slf4j
public class JobController {

    private final JobService jobService;
    private final JobConfigService jobConfigService;
    private final JobInfoService jobInfoService;

    /**
     * Instantiates a new Meta data controller.
     *
     * @param jobService       the meta data service.
     * @param jobConfigService the meta data service.
     */
    @Autowired(required = false)
    public JobController(final JobService jobService, final JobConfigService jobConfigService, final JobInfoService jobInfoService) {
        this.jobService = jobService;
        this.jobConfigService = jobConfigService;
        this.jobInfoService = jobInfoService;
    }


    /**
     * create job.
     *
     * @param dto job.
     * @return {@linkplain JsonResult}
     */
    @PostMapping("add")
    @ApiOperation(value = "新增定时工单")
    @Transactional(rollbackFor = Exception.class)
    @Synchronized
    public JsonResult createJob(@RequestBody JobDto dto) {
        if (dto.getId()!=null){
            JsonResult.error("参数错误");
        }
        JsonResult jsonResult = jobService.saveOrUpdate(dto);
        if (jsonResult.getCode() == ERROR_CODE) {
            return jsonResult;
        }
        Job job = (Job) jsonResult.getData();
        JobConfig jobConfig = BeanUtil.copy(dto.getCronInfo(), JobConfig.class);
        jobConfig.setJobId(job.getId());
        jobConfig.setCron(job.getCron());
        this.jobConfigService.add(jobConfig);
        ReturnT<String> returnT = this.jobInfoService.createJob(job.getCron(), job.getJobName(), job.getId().toString(), ORDER_HANDLER, 0);
        if (ReturnT.FAIL_CODE == returnT.getCode()) {
            throw new OpsException("任务调度创建出错");
        }
        job.setXxlJobId(Integer.valueOf(returnT.getContent()));
        return jobService.update(job);
    }
}

到这里就可以实现,在保证事务的同时解决多数据源切换的问题了。

分析解决

现在我们先来看一下,是怎么解决问题的。
首先,在JobController 中的createJob方法上加 @Transactional(rollbackFor = Exception.class),默认事务的传播机制是,PROPAGATION_REQUIRED ,可以不指定。
然后,在JobInfoServic 类上,添加 @Transactional(propagation = Propagation.REQUIRES_NEW, rollbackFor = Exception.class) ,指定事务的传播机制是,Propagation.REQUIRES_NEW。
至此,冲突解决!

原因解析

看到这里,是不是恍然大悟。对的,就是将原本的一个事务拆分成两个事务。你可以试一下,只在JobController 中的createJob方法加事务,你会发现在切面里看数据源切换了,但事务内的数据源依然是旧的,这样就会报出XXX表找不到的问题。那么到底是什么原因导致一个事务内的数据源没有随着@DS(“quartz”)注解做出动态数据源切换呢?这里我直接说原因了,具体的解析留在下一篇来讲。

  1. 因为spring在开启事务的同时,会去数据库连接池拿数据库连接。如果仅在JobController 中的createJob方法上添加@Transactional,那么,TransactionInterceptor 会使用 Spring DataSourceTransactionManager 创建事务,并将事务信息(获取数据源connection连接,此时获取到的数据源是默认配置的base数据源信息)连接信息,通过 ThreadLocal 绑定在当前线程。
  2. 此时当前线程事务绑定的连接信息是base数据源,当我们在内层JobInfoServic使用@DS切换数据源,并没有重新开启新事务,没有改变当前线程事务的连接信息,仅仅是做了一次拦截,改变了DataSourceHolder的栈顶dataSource,对于整个事务的连接是没有影响的,所以会产生数据源没有切换的问题。
  3. 所以我这里的解决办法是,将保证createJob操作数据完整性的事务,拆解成两个事务,在JobInfoServic 类上,除了添加切换数据源的注解@DS(“quartz”),再添加@Transactional(propagation = Propagation.REQUIRES_NEW, rollbackFor = Exception.class),新建开一个事务,获取新数据源connection连接。
Logo

为开发者提供学习成长、分享交流、生态实践、资源工具等服务,帮助开发者快速成长。

更多推荐