Seata整合SpringBoot和Mybatis

一、背景

在上一节中，我们学习了Seata的集群部署，在这篇文章中，我们使用SpringBoot整合Seata实现分布式事务功能，此处使用的是Seata的AT模式。

二、实现功能

我们存在2个服务 账户服务 account-service 和 订单服务 order-service，在订单服务中调用 账户服务。

订单服务中调用账户服务是通过 RestTemplate来实现的。

测试场景：

1、账户服务正常，订单服务正常，结果：账户服务正常扣款，产生订单。

2、账户服务正常，订单服务正常，在整个分布式事务中发生了异常，结果： 账户服务没有扣款，没有产生订单。

三、每个服务使用到的技术

1、账户服务

SpringBoot、Seata、Mybatis、nacos、druid

2、订单服务

SpringBoot、Seata、Mybatis、nacos、Hikari

其中 SpringBoot 整合 Seata 是通过 seata-spring-boot-starter 这个来实现的，不使用 seata-all来实现。

四、服务实现

1、账户服务实现

账户服务，提供一个简单的扣除账户余额的功能，比较简单。

注意项：

1、开启自动数据源代理。

2、引入druid，不需要自动配置数据源。

3、注意事务分组

1、引入jar包

此处只引入几个 核心的 包，其余的包没有列在下方，比如mybatis等，注意和seata整合使用的是seata-spring-boot-starter

<dependency>
  <groupId>io.seatagroupId>
  <artifactId>seata-spring-boot-starterartifactId>
  <version>1.4.2version>
dependency>
<dependency>
  <groupId>com.alibabagroupId>
  <artifactId>druid-spring-boot-starterartifactId>
  <version>1.2.4version>
dependency>
<dependency>
  <groupId>com.alibaba.nacosgroupId>
  <artifactId>nacos-clientartifactId>
  <version>1.3.2version>
dependency>

2、项目配置

3、建表语句

create database seata_account;
use seata_account;
create table account(
    id int unsigned auto_increment primary key comment '主键',
    name varchar(20) comment '用户名',
    balance bigint comment '账户余额,单位分'
) engine=InnoDB comment '账户表';
insert into account(id,name,balance) values (1,'张三',100000);
CREATE TABLE IF NOT EXISTS `undo_log`
(
    `branch_id`     BIGINT       NOT NULL COMMENT 'branch transaction id',
    `xid`           VARCHAR(128) NOT NULL COMMENT 'global transaction id',
    `context`       VARCHAR(128) NOT NULL COMMENT 'undo_log context,such as serialization',
    `rollback_info` LONGBLOB     NOT NULL COMMENT 'rollback info',
    `log_status`    INT(11)      NOT NULL COMMENT '0:normal status,1:defense status',
    `log_created`   DATETIME(6)  NOT NULL COMMENT 'create datetime',
    `log_modified`  DATETIME(6)  NOT NULL COMMENT 'modify datetime',
    UNIQUE KEY `ux_undo_log` (`xid`, `branch_id`)
) ENGINE = InnoDB COMMENT ='AT transaction mode undo table';

每个业务库必须存在一张 undo_log表

2、订单服务实现

提供一个接口，实现产生订单，扣除账户余额。

注意事项：

1、订单服务 关闭默认的数据源代理，自己配置数据源代理。

2、使用 Hikari数据源来实现，因为使用的是 AT模式，所以需要使用 DataSourceProxy 来代理数据源。

3、订单服务调用账户服务是采用的 RestTemplate，因此需要手动配置RestTemplate的拦截器，实现xid的传输。

4、在seata1.4.2中存在一个bug，如果业务表中数据类型是datetime类型，可能undolog无法序列化成功，可以采用timestamp或别的方式来处理。

5、业务库中需要存在 undo_log 表。

1、引入jar包

此处不引入 druid，注意和seata整合使用的是seata-spring-boot-starter

<dependency>
  <groupId>io.seatagroupId>
  <artifactId>seata-spring-boot-starterartifactId>
  <version>1.4.2version>
dependency>
<dependency>
  <groupId>com.alibaba.nacosgroupId>
  <artifactId>nacos-clientartifactId>
  <version>1.3.2version>
dependency>

2、项目配置

3、配置数据源代理

package com.huan.seata.config;

import com.zaxxer.hikari.HikariDataSource;
import io.seata.rm.datasource.DataSourceProxy;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

/**
 * @author huan.fu 2021/9/24 - 上午10:34
 */
@Configuration
public class DataSourceConfig {
    
    @Autowired
    private DataSourceProperties dataSourceProperties;
    
    @Bean
    public DataSource dataSourceProxy() {
        HikariDataSource hikariDataSource = new HikariDataSource();
        hikariDataSource.setJdbcUrl(dataSourceProperties.getUrl());
        hikariDataSource.setUsername(dataSourceProperties.getUsername());
        hikariDataSource.setPassword(dataSourceProperties.getPassword());
        hikariDataSource.setDriverClassName(dataSourceProperties.getDriverClassName());
        return new DataSourceProxy(hikariDataSource);
    }
}

在 AT模式种，数据源代理一定要是 DataSourceProxy这个。

4、配置RestTemplate传递xid

5、@GlobalTransactional分布式事务

@Service
@RequiredArgsConstructor
@Slf4j
public class BusinessServiceImpl implements BusinessService {
    
    private final OrderService orderService;
    private final RestTemplate restTemplate;
    
    @Override
    @GlobalTransactional(rollbackFor = Exception.class)
    public void createAccountOrder(Integer accountId, Long amount, boolean hasException) {
        System.out.println("createAccountOrder:" + RootContext.getXID());
        // 1、远程扣减账户余额
        remoteDebit(accountId, amount);
        
        // 2、下订单
        orderService.createOrder(accountId, amount);
        
        if (hasException) {
            throw new RuntimeException("发生了异常，分布式事物需要会滚");
        }
    }
    
    private void remoteDebit(Integer accountId, Long amount) {
        String url = "http://localhost:50001/account/debit?id=" + accountId + "&amount=" + amount;
        String result = restTemplate.getForObject(url, String.class);
        log.info("远程扣减库存结果:[{}]", result);
    }
}

3、事务分组需要和配置中心对应上

此处以订单服务来演示，如何和配置中心对应上的。

每个服务的事务分组可能不一样，但是需要和配置中心对应上。
比如：
order-service 中的配置分组为：seata.tx-service-group=tx_order_service_group
配置中心必须存在 service.vgroupMapping.tx_order_service_group=default 配置项，default是集群，是服务端配置文件中指定的

五、演示

1、没有发生异常

访问：http://localhost:50002/createOrder?accountId=1&amount=10&hasException=false

正常创建订单，和扣除余额。

2、发生异常

访问： http://localhost:50002/createOrder?accountId=1&amount=10&hasException=true

不产生订单，不扣除余额。

六、可能遇到的问题

1.Nacos 作为 Seata 配置中心时，项目启动报错找不到服务。如何排查，如何处理?

A： 异常：io.seata.common.exception.FrameworkException: can not register RM,err:can not connect to services-server.

1. 查看nacos配置列表，seata配置是否已经导入成功
2. 查看nacos服务列表，serverAddr是否已经注册成功
3. 检查client端的registry.conf里面的namespace，registry.nacos.namespace和config.nacos.namespace填入nacos的命名空间ID，默认""，server端和client端对应，namespace 为public是nacos的一个保留控件，如果您需要创建自己的namespace，最好不要和public重名，以一个实际业务场景有具体语义的名字来命名
4. nacos上服务列表，serverAddr地址对应ip地址应为seata启动指定ip地址，如：sh seata-server.sh -p 8091 -h 122.51.204.197 -m file
5. 查看seata/conf/nacos-config.txt 事务分组service.vgroupMapping.trade_group=default配置与项目分组配置名称是否一致
6. telnet ip 端口 查看端口是都开放，以及防火墙状态

2、使用 AT 模式需要的注意事项有哪些 ？

1. 必须使用代理数据源，有 3 种形式可以代理数据源：

• 依赖 seata-spring-boot-starter 时，自动代理数据源，无需额外处理。
• 依赖 seata-all 时，使用 @EnableAutoDataSourceProxy (since 1.1.0) 注解，注解参数可选择 jdk 代理或者 cglib 代理。
• 依赖 seata-all 时，也可以手动使用 DatasourceProxy 来包装 DataSource。

2. 配置 GlobalTransactionScanner，使用 seata-all 时需要手动配置，使用 seata-spring-boot-starter 时无需额外处理。
3. 业务表中必须包含单列主键，若存在复合主键，请参考问题 13 。
4. 每个业务库中必须包含 undo_log 表，若与分库分表组件联用，分库不分表。
5. 跨微服务链路的事务需要对相应 RPC 框架支持，目前 seata-all 中已经支持：Apache Dubbo、Alibaba Dubbo、sofa-RPC、Motan、gRpc、httpClient，对于 Spring Cloud 的支持，请大家引用 spring-cloud-alibaba-seata。其他自研框架、异步模型、消息消费事务模型请结合 API 自行支持。
6. 目前AT模式支持的数据库有：MySQL、Oracle、PostgreSQL和 TiDB。
7. 使用注解开启分布式事务时，若默认服务 provider 端加入 consumer 端的事务，provider 可不标注注解。但是，provider 同样需要相应的依赖和配置，仅可省略注解。
8. 使用注解开启分布式事务时，若要求事务回滚，必须将异常抛出到事务的发起方，被事务发起方的 @GlobalTransactional 注解感知到。provide 直接抛出异常 或 定义错误码由 consumer 判断再抛出异常。

3、AT 模式和 Spring @Transactional 注解连用时需要注意什么 ？

@Transactional 可与 DataSourceTransactionManager 和 JTATransactionManager 连用分别表示本地事务和XA分布式事务，大家常用的是与本地事务结合。当与本地事务结合时，@Transactional和@GlobalTransaction连用，@Transactional 只能位于标注在@GlobalTransaction的同一方法层次或者位于@GlobalTransaction 标注方法的内层。这里分布式事务的概念要大于本地事务，若将 @Transactional 标注在外层会导致分布式事务空提交，当@Transactional 对应的 connection 提交时会报全局事务正在提交或者全局事务的xid不存在。

4、数据库开启自动更新时间戳导致脏数据无法回滚

由于业务提交，seata记录当前镜像后，数据库又进行了一次时间戳的更新，导致镜像校验不通过。

**解决方案1: **关闭数据库的时间戳自动更新。数据的时间戳更新，如修改、创建时间由代码层面去维护，比如MybatisPlus就能做自动填充。

解决方案2: update语句别把没更新的字段也放入更新语句。

5、Seata 使用注册中心注册的地址有什么限制？

Seata 注册中心不能注册 0.0.0.0 或 127.0.0.1 的地址，当自动注册为上述地址时可以通过启动参数 -h 或容器环境变量SEATA_IP来指定。当和业务服务处于不同的网络时注册地址可以指定为 NAT_IP或公网IP，但需要保证注册中心的健康检查探活是通畅的。

以上的几个问题，来自seata官网 : http://seata.io/zh-cn/docs/overview/faq.html

七、代码地址

代码地址：https://gitee.com/huan1993/spring-cloud-parent/tree/master/seata/seata-springboot-mybatis