（C#版）使用TCC分布式事务改造现有下单流程（二）

引言

　　上篇赘述了好多，无非就是想把tcc分布式事务的流程给讲清楚，并介绍了它与另外两种常用的分布式事务“可靠消息队列”，“saga”的区别和适用场景。

　　那接下来就引出我们的主角“dtm”吧，它类似于阿里的分布式事务框架seata，可惜由于seata的语言局限性，让我们.neter们“望而却步”，但更可怜的是我们.net自己的生态圈中竟然找不到能使用的类似的框架或中间件。眼看着自己设计好的新的下单流程因为没有能够支撑业务的中间件而流产的时候，突然收到群友的消息，扔给我一个dtm项目的链接，说可以看看。在这里我很感谢群友发给我的这个信息，让我找到了能把订单改造继续做下去的信心。下面的篇幅针对我在dtm试用过程中遇到的问题，和一些细节做个记录。

dtm介绍

　　对于dtm这个跨语言的tcc分布式事务中间件的介绍，官网很多篇文章，循序渐进的看下来已经很清楚了，官网地址：https://dtm.pub/。

　　dtm官方推荐的c# sdk客户端，是由张善友大佬提供的，地址是：https://github.com/yedf/dtmcli-csharp

，对应的demo地址：https://github.com/yedf/dtmcli-csharp-sample。张队长“人狠话不多”，sdk和例子都提供了，但就是没有使用的细节文档，潜台词就是结合着例子自己看源码吧。sdk源码还是比较简单的，运行示例调试，并结合dtm服务端的数据库，最终掌握dtm的使用还是不难的。只不过初次使用还是会遇到各种各样的问题的。

dtm的使用

dtm服务端部署

关于docker-compose.yml的问题

我的部署环境是centos7.6和docker20.10，原始的docker-compose.yml内容如下：

 

 

其中，红线框起来的部分原版是没有的，因为使用中遇到了问题，通过跟作者的沟通请教，找到问题后加上去的。

1、 红框一的作用：让容器内的时间和时区与宿主机使用的一致，如果不加，会导致mysql容器使用了北京时间，而dtm服务程序使用的确是utc时间，相差8个小时，这样会造成dtm服务端在管理事务时，因为时间混乱而判断和查询失误，无法完成事务的正确调度。

2、红框二的作用：很明显是为了dtm服务端和mysql之间互联的需要。

备注：作者说他在ubuntu下不需要加红框部分也可以的，但centos7.6是需要的。

关于dtm服务程序和mysql容器的启动顺序问题

实际上，使用上述改过后的docker-compose.yml启动容器后，还是有问题，dtm服务程序会闪退，报错如下：

　　看报错应该是dtm没有连上数据库，在这里说一下作者本人真的是很负责，帮我看了下原因说应该是mysql还未启动就绪，dtm就开始创建库导致的，让我等mysql容器就绪后再启动dtm容器试试。经过作者的指点，我把退出的dtm容器，用docker start重新手动启动后，终于mysql上相应的库被dtm服务程序创建，而dtm再也不会报错退出了，环境至此搭建完毕。

sdk的使用

dtm服务端环境搭建完毕后，接下来我们就可以运行c#示例看效果啦。

dtm服务的注册：

public void ConfigureServices(IServiceCollection services)
{
    services.AddDtmcli(dtm => dtm.DtmUrl = "http://192.168.1.244:8080");

    services.AddControllers();

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "DtmTccSample", Version = "v1" });
    });
}

很简单，只需要一句话：services.AddDtmcli(dtm => dtm.DtmUrl = "http://192.168.1.244:8080");，其中DtmUrl就是dtm服务端的地址。

sdk的介绍文档和示例中只有如下一段代码：

首先要说的是，示例代码能够运行没有问题，但只是try阶段执行成功的情况下，子事务顺利提交的正常场景。

如果要测试try阶段不成功或异常，子事务应该回滚，示例代码要这样写：

[HttpPost]
public async Task<RestResult> Demo()
{
    var svc = "http://172.16.2.14:5000/api";
    TransRequest request = new TransRequest() { Amount = 30 };
    var cts = new CancellationTokenSource();
    try
    {
        var res1 = string.Empty;
        var res2 = string.Empty;
        var isTryOk = true;
        await globalTransaction.Excecute(async (tcc) =>
        {
            res1 = await tcc.CallBranch(request, svc + "/TransOut/Try", svc + "/TransOut/Confirm", svc + "/TransOut/Cancel", cts.Token);
            res2 = await tcc.CallBranch(request, svc + "/TransIn/Try", svc + "/TransIn/Confirm", svc + "/TransIn/Cancel",cts.Token);
            
            if (!res1.Contains("SUCCESS") || !res2.Contains("SUCCESS"))
            {
                //异常日志
                logger.LogError($"{res1}{res2}");
                //抛出异常：目的是让sdk客户端捕获异常，通知dtm服务端，try阶段遇到了异常，所有子事务回滚
                throw new AccessViolationException($"{res1}{res2}");
            }
            logger.LogInformation($"tcc returns: {res1}-{res2}");
        }, cts.Token);
        if (res1.Contains("SUCCESS") || res2.Contains("SUCCESS"))
        {
            logger.LogError($"{res1}{res2}");
            return new RestResult() { Result = "FAILURE" };
        }
    }
    catch(Exception ex)
    {

    }
    return new RestResult() { Result = "SUCCESS" };
}

实际上，核心代码是17-23行，要想将try阶段的失败告知dtm，我们要做的就是捕获所有子事务try阶段的返回值，并判断是否有任何一个返回值不是我们想要的（例子中子事务的返回值是res1和res2），如果返回值不正确，就在 globalTransaction.Excecute方法内抛出一个异常。抛出去的异常会被sdk客户端捕获，并告知dtm应该对子事务进行回滚了，具体源码如下：

public async Task<string> Excecute(Func<Tcc,Task> tcc_cb, CancellationToken cancellationToken =default)
{
    var tcc = new Tcc(this.dtmClient, await this.GenGid());
    
    var tbody = new TccBody
    { 
        Gid = tcc.Gid,
        Trans_Type ="tcc"
    };
 

    try
    {
        await dtmClient.TccPrepare(tbody, cancellationToken);

        await tcc_cb(tcc);

        await dtmClient.TccSubmit(tbody, cancellationToken);
    }
    catch(Exception ex)
    {
        logger.LogError(ex,"submitting or abort global transaction error");
        await this.dtmClient.TccAbort(tbody, cancellationToken);
        return string.Empty;
    }
    return tcc.Gid;
}

catch块中，this.dtmClient.TccAbort就是去告知dtm，应该回滚子事务。

关于Confirm和Cancel阶段失败后的重试

　　try阶段执行成功，所有子事务会执行Confirm的接口，如果try阶段失败，则所有子事务会执行Cancel阶段的接口。如果Confirm或Cancel阶段有任何子事务执行失败，dtm则会不断地去重试这个子事务，直至成功为止，所以Confirm或Cancel阶段，进行“最大努力交付”，没有回头路可走。

　　这里要说明一点的是，Confirm或Cancel子事务的执行是按顺序的，如果有哪个子事务因为执行失败而不断的重试，那么其余未执行的子事务也会被它阻塞而无法执行。

　　重试第一次会间隔10s，后续的重试时间都会翻倍，20 40 80 160这样子的间隔。

　　如果子事务在try阶段是按照ab的顺序执行，那么cancel阶段则是按照ba的顺序执行。

dtm的日志

dtm的日志还是很详细的，包括对事务接口的调用还有数据库的执行以及错误异常，容器内查看dtm日志的命令：

docker container logs dtm-api-1 --follow

dtm相关表

tcc事务设计的表如下图：

其中trans_global是全局事务表，trans_branch是分支子事务表。注释也都一目了然，sql如下：

CREATE TABLE `trans_global` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `gid` varchar(128) NOT NULL COMMENT '事务全局id',
  `trans_type` varchar(45) NOT NULL COMMENT '事务类型: saga | xa | tcc | msg',
  `status` varchar(12) NOT NULL COMMENT '全局事务的状态 prepared | submitted | aborting | finished | rollbacked',
  `query_prepared` varchar(128) NOT NULL COMMENT 'prepared状态事务的查询api',
  `protocol` varchar(45) NOT NULL COMMENT '通信协议 http | grpc',
  `create_time` datetime DEFAULT NULL,
  `update_time` datetime DEFAULT NULL,
  `commit_time` datetime DEFAULT NULL,
  `finish_time` datetime DEFAULT NULL,
  `rollback_time` datetime DEFAULT NULL,
  `next_cron_interval` int(11) DEFAULT NULL COMMENT '下次定时处理的间隔',
  `next_cron_time` datetime DEFAULT NULL COMMENT '下次定时处理的时间',
  `owner` varchar(128) NOT NULL DEFAULT '' COMMENT '正在处理全局事务的锁定者',
  PRIMARY KEY (`id`),
  UNIQUE KEY `gid` (`gid`),
  KEY `owner` (`owner`),
  KEY `create_time` (`create_time`),
  KEY `update_time` (`update_time`),
  KEY `status_next_cron_time` (`status`,`next_cron_time`) COMMENT '这个索引用于查询超时的全局事务，能够合理的走索引'
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4;

CREATE TABLE `trans_branch` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `gid` varchar(128) NOT NULL COMMENT '事务全局id',
  `url` varchar(128) NOT NULL COMMENT '动作关联的url',
  `data` text COMMENT '请求所携带的数据',
  `branch_id` varchar(128) NOT NULL COMMENT '事务分支名称',
  `branch_type` varchar(45) NOT NULL COMMENT '事务分支类型 saga_action | saga_compensate | xa',
  `status` varchar(45) NOT NULL COMMENT '步骤的状态 submitted | finished | rollbacked',
  `finish_time` datetime DEFAULT NULL,
  `rollback_time` datetime DEFAULT NULL,
  `create_time` datetime DEFAULT NULL,
  `update_time` datetime DEFAULT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `gid_uniq` (`gid`,`branch_id`,`branch_type`),
  KEY `create_time` (`create_time`),
  KEY `update_time` (`update_time`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb4;

 最后附上dtm c#沟通微信群，有问题可以一起来讨论：