DTM 分布式事务管理器入门指南

DTM 分布式事务管理器入门指南

dtm项目地址:https://gitcode.com/gh_mirrors/dtm/dtm

1. 项目介绍

DTM (Distributed Transaction Manager) 是一个开源分布式事务框架，它提供了一种优雅的方式解决微服务架构中的数据一致性问题。不同于传统的一阶段提交或两阶段提交的模型，DTM 设计了基于 Saga 模型和 TCC（Try-Confirm-Cancel）模型的解决方案，允许在分布式系统中实现复杂的业务逻辑并保持事务的一致性。

DTM 的核心特性包括：

• 支持Saga模式和TCC模式下的分布式事务处理。
• 提供了丰富的API接口用于事务控制。
• 跨语言支持，使得不同服务间可以进行交互而不论它们是用哪种编程语言编写的。
• 高可用性和容错能力设计，确保在节点故障时也能正确地完成事务操作。
• 易于集成到现有的微服务架构中。

为了更好地理解 DTM 如何工作，下面我们将详细介绍如何快速启动和使用 DTM 来解决实际场景中的事务一致性问题。

2. 快速启动

环境搭建

首先，确保你的开发环境中已经安装了必要的组件，如Go语言环境（推荐版本为1.15以上）。接下来，从GitHub上克隆DTM仓库:

git clone https://github.com/yedf/dtm.git
cd dtm/cmd/dtmd/
go build
./dtmd start

这将启动本地的 DTM server。默认情况下，DTM 使用端口 8080 监听请求。

开发服务

对于开发者而言，通常需要创建两个或更多的服务来模拟真实的分布式交易场景。这里以 Go 为例，创建两个简单的服务: branch1 和 branch2。

创建服务Branch1

在你的工作目录下新建文件夹 branch1 并进入其中，在该目录下创建主文件 main.go，内容如下:

package main

import (
	"context"
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
)

func branch1() {
	fmt.Println("branch1 operation")
}

func main() {
	router := gin.Default()
	router.POST("/branch1", func(c *gin.Context) {
		ctx := context.Background()
		branch1()
		c.JSON(http.StatusOK, map[string]string{"status": "ok"})
	})
	router.Run(":9999")
}

运行上面的服务:

go run . &

创建服务Branch2

类似地，在根目录下建立文件夹 branch2，并在其中创建 main.go 文件，然后在服务里定义分支 branch2 操作。此处不再赘述具体代码，参照上面的步骤即可。

发起分布式事务

现在我们有了两个服务，我们可以使用 DTM 来发起一个分布式的事务。首先，在任意位置创建一个 main.go 文件作为客户端，通过调用 DTM API 来发起并控制事务，示例如下：

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"time"

	dtmcli "github.com/yedf/dtm/dtmcli/dtmimp"
)

type BranchAction struct{}

// 定义分支动作
func (*BranchAction) Branch2Commit(ctx context.Context, dict json.RawMessage) error {
	resp, err := http.Post("http://localhost:9999/branch1", "application/x-www-form-urlencoded", nil)
	if err != nil {
		return fmt.Errorf("call branch1 failed:%v", err)
	}
	defer resp.Body.Close()

	if resp.StatusCode >= 400 {
		return fmt.Errorf("response %d from branch1", resp.StatusCode)
	}
	
	// 同理，调用branch2服务

	// 返回nil表示成功，否则代表失败
	return nil
}

// 定义全局事务
func (ba *BranchAction) GlobalTx(ctx context.Context) error {
	log.Printf("global transaction begin.")

	// 构建分支事务并将其添加至dtm client实例
	var manager = dtmcli.New(ba)

	// 开始全局事务
	err := manager.GlobalTransaction(ctx,
		"db",
		ba.Branch2Commit,
	)
	if err != nil {
		log.Fatalf("manager.GlobalTransaction error: %s\n", err.Error())
	}

	log.Printf("global transaction commit.")
	return nil
}

func main() {
	ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
	defer cancel()

	action := &BranchAction{}
	err := action.GlobalTx(ctx)
	if err != nil {
		log.Fatalf("GlobalTx error: %s\n", err.Error())
	}
}

这个例子展示了如何使用 DTM 的 API 来构建并执行一次全局的事务，其中包含了对两个服务的调用。当两个服务都成功响应时，全局事务视为成功；反之，则触发回滚流程。

3. 应用案例与最佳实践

在实际应用场景中，例如电商订单创建流程可能涉及库存扣减、支付确认等多个服务，此时 DTM 可以有效地保证整个流程的一致性。实践中应当注意以下几点：

• 异常捕捉与回退：设计时要充分考虑各种可能发生的错误情况，并能够及时回滚或者补偿。
• 日志记录：详细记录每次事务操作有助于后续排查问题和审计跟踪。
• 性能优化：避免在事务处理过程中存在过多网络I/O操作，减少等待时间提高效率。

4. 典型生态项目

• Kratos：一个现代的云原生Go应用开发框架，内置了DTM的集成示例。
• HTTP Integration：提供了与HTTP协议的无缝对接功能，适用于广泛的应用场景。

DTM 的强大之处在于其高度可定制化的能力以及对多种编程语言的支持，使开发者能够在不同的技术栈之间灵活切换，解决分布式系统的复杂问题。

dtm项目地址:https://gitcode.com/gh_mirrors/dtm/dtm