聊聊@DSTransactional的坑

为什么写这篇文章

最近项目里面使用了多数据源功能，使用的包是

xml 复制代码

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>3.5.1</version>
</dependency>

使用过程中就出现一个问题，在一个@DSTransactional注解里面标注的方法，前面插入的数据后面却查不出来。经过一番测试，终于找到问题的根源，特此记录以备后续查阅

问题复现

配置如下

yml 复制代码

spring:
  datasource:
    dynamic:
      primary: yrt
      strict: false
      datasource:
        yrt:
          url: xxx
          username: xxx
          password: xxx
        ent:
          url: xxx
          username: xxx
          password: xxx

为了打印数据源切换的日志，还增加了如下配置

yml 复制代码

logging:
  config: classpath:logback.xml
  level:
    org.springframework.transaction: DEBUG
    org.springframework.jdbc.datasource: DEBUG
    com.baomidou.dynamic.datasource: DEBUG

坑描述

写了@DS和没写@DS的类中的方法，@DS("primary")和@DS("yrt")，即使primary对应的数据库就是yrt也会导致事务切换，事务切换就意味着前面插入的代码在后面无法查询，下面给出列子

代码描述

DsTransactionalTest

java 复制代码

public class DsTransactionalTest {

    @Autowired
    DsTransactionalTestService dsTransactionalTestService;

    @org.junit.Test
    public void testDsTransactional() {
        dsTransactionalTestService.dsTransactionalTest();
    }
}

DsTransactionalTestService

java 复制代码

@Service
@AllArgsConstructor
public class DsTransactionalTestService {

    private final VendorMPService vendorMPService;
    private final DealerMPService dealerMPService;

    @DSTransactional
    public void dsTransactionalTest() {
        Integer vid = 40048;
        vendorMPService.saveTest(vid);
        dealerMPService.testQueryVendor(vid);
    }
}

VendorMPService

java 复制代码

@Service
public class VendorMPService extends ServiceImpl<VendorMPMapper, VendorMP> {
    public void saveTest(Integer vid) {
        VendorMP vendorMP = new VendorMP();
        vendorMP.setVendorInnerSn(vid);
        vendorMP.setName("测试厂商" + vid);
        // 省略其他字段
        this.save(vendorMP);
    }
}

DealerMPService

java 复制代码

@Service
@AllArgsConstructor
@DS("primary")
public class DealerMPService extends ServiceImpl<DealerMPMapper, DealerMP> {
    private final VendorMPService vendorMPService;

    public void testQueryVendor(Integer vid) {
        System.out.println("厂商信息:" + vendorMPService.getById(vid));
    }
}

此时安装我们的理解，应该后面要能查询出来数据才对，但运行结果如下

虽然有inser语句，但是并没有查询出来数据，那么此时我们来修改代码，把@DS("primary") 也在VendorMPService 上面新增一份，就能查出来数据了

java 复制代码

@Service
@DS("primary")
public class VendorMPService extends ServiceImpl<VendorMPMapper, VendorMP> {
// 省略
}

我比较懒篇幅所限，另一种情况，一个标注的是@DS("primary")，另一个标注的是@DS("yrt")，即使primary对应的数据源就是yrt 也是跟上面的情况是一样的，这里就不贴代码了。

回滚情况

我测试过程中，如果在后面的方法报错，前面的插入会回滚，即使一个标注的是@DS("primary")，另一个标注的是@DS("yrt")，或者一个标注了@DS("primary")另一个没标，都会回滚，也就是说：查询的时候虽然查询不出来，但是报错时能正常回滚。这就很奇怪，猜测是虽然有事务的切换，但是事务的ID是一样的，所以本质上还是同一个事务。

总结或最佳实践

理论上不要出现前面插入后面又查询是最好，直接把插入的对象传值到后面就行了，但是在实际项目大了以后，方法之间的调用错综复杂，有时候会经常出现开发某个新方法，但是有部分逻辑过于复杂进而直接调用的情况，如果项目对@DSTransactional和@DS注解的使用不够熟练，没有做好规定，很容易会引发这个BUG。
对于@DS的使用，要规范团队统一使用如@DS("primary"), 并且对于领域范围确定的service, 都要标注这个 @DS("primary")，不要一部分标注一部分不标，这样应该可以减少BUG
千万不要在 @DSTransactional 里面调用 @Transactional 标注的方法，两种注解混着用，得到的结果很奇怪，我目前还没测出会有什么奇怪的情况~，但是不要混着用时对的。
非必要时不要使用 @DSTransactional ，如果在某个方法里面需要新增A数据库的数据，然后查询B数据库的数据，此时直接给方法标注为@Transactional 然后在查询B数据库的时候，使用@Transactional(propagation = Propagation.NOT_SUPPORTED, rollbackFor = Exception.class)，即事务不传播。