diff --git a/README.md b/README.md index db78432..b3184e8 100644 --- a/README.md +++ b/README.md @@ -5,143 +5,127 @@ [![Go Reference](https://pkg.go.dev/badge/github.com/dtm-labs/dtm.svg)](https://pkg.go.dev/github.com/dtm-labs/dtm) [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/avelino/awesome-go#database) -# [English Docs](https://en.dtm.pub) -# 跨语言分布式事务管理器 +# [中文文档](http://dtm.pub) -DTM是一款变革性的分布式事务框架,提供了傻瓜式的使用方式,极大的降低了分布式事务的使用门槛,改变了“能不用分布式事务就不用”的行业现状。 dtm 的应用范围非常广,可以应用于以下常见的领域: -- [非单体的订单系统,大幅简化架构](https://dtm.pub/app/order.html) -- [秒杀系统,做到在Redis中精准扣库存](https://dtm.pub/app/flash.html) -- [保证缓存与DB的一致性](https://dtm.pub/app/cache.html) -- 微服务架构(已原生支持[go-zero](https://github.com/zeromicro/go-zero)等框架)中跨服务更新数据保证一致性 +# A Cross Language Distributed Transaction Manager -他优雅的解决了幂等、空补偿、悬挂等分布式事务难题,提供跨语言,跨存储引擎组合事务的强大功能: - +## Who's using DTM -## 谁在使用DTM(仅列出部分) -[Tencent 腾讯](https://dtm.pub/other/using.html#tencent) +[Tencent](https://www.tencent.com/) -[Ivydad 常青藤爸爸](https://dtm.pub/other/using.html#ivydad) +[Ivydad](https://ivydad.com) -[Eglass 视咖镜小二](https://dtm.pub/other/using.html) +[Eglass](https://epeijing.cn) -[极欧科技](https://dtm.pub/other/using.html) +[Jiou](http://jiou.me) -## 亮点 +[GoldenData]() -* 极易上手 - - 零配置启动服务,提供非常简单的HTTP接口,极大降低上手分布式事务的难度,新手也能快速接入 -* 跨语言 - - 可适合多语言栈的公司使用。方便go、python、php、nodejs、ruby、c# 各类语言使用。 -* 使用简单 - - 开发者不再担心悬挂、空补偿、幂等各类问题,首创子事务屏障技术代为处理 -* 易部署、易扩展 - - 依赖mysql|redis,部署简单,易集群化,易水平扩展 -* 多种分布式事务协议支持 - - TCC、SAGA、XA、二阶段消息,一站式解决所有分布式事务问题 +## What is DTM -## 与其他框架对比 +DTM is the first distributed transaction management framework in Golang. Unlike other frameworks, DTM provides extremely easy access interfaces of HTTP and gRPC, supports multiple language bindings, and handles tricky problems of unordered sub-transactions at the framework level. -非Java语言类的,暂未看到除dtm之外的成熟框架,因此这里将DTM和Java中最成熟的Seata对比: +## Features -| 特性| DTM | SEATA |备注| -|:-----:|:----:|:----:|:----:| -|[支持语言](https://dtm.pub/other/opensource.html#lang) |Go、c#、Java、python、php...|Java|dtm可轻松接入一门新语言| -|[存储引擎](https://dtm.pub/other/opensource.html#store) |支持数据库、Redis、Mongo等|数据库|| -|[异常处理](https://dtm.pub/other/opensource.html#exception)| 子事务屏障自动处理 |手动处理 |dtm解决了幂等、悬挂、空补偿| -|[SAGA事务](https://dtm.pub/other/opensource.html#saga) |极简易用 |复杂状态机 || -|[二阶段消息](https://dtm.pub/other/opensource.html#msg)|||最简消息最终一致性架构| -|[TCC事务](https://dtm.pub/other/opensource.html#tcc)| ||| -|[XA事务](https://dtm.pub/other/opensource.html#xa)|||| -|[AT事务](https://dtm.pub/other/opensource.html#at)|建议使用XA||AT与XA类似,但有脏回滚| -|[单服务多数据源](https://dtm.pub/other/opensource.html#multidb)|||| -|[通信协议](https://dtm.pub/other/opensource.html#protocol)|HTTP、gRPC、go-zero|dubbo等协议|dtm对云原生更加友好| -|[star数量](https://dtm.pub/other/opensource.html#star)|github stars|github stars|dtm从20210604发布0.1,发展快| +* Extremely easy to adapt + - Support HTTP and gRPC, provide easy-to-use programming interfaces, lower substantially the barrier of getting started with distributed transactions. Newcomers can adapt quickly. -从上面对比的特性来看,dtm在许多方面都具备很大的优势。如果考虑多语言支持、多存储引擎支持,那么dtm毫无疑问是您的首选 +* Easy to use + - Relieving developers from worrying about suspension, null compensation, idempotent transaction, and other tricky problems, the framework layer handles them all. -详细的对比可以点击特性中的链接,跳到相关文档 -## [性能测试报告](https://dtm.pub/other/performance.html) +* Language-agnostic + - Suit for companies with multiple-language stacks. + Easy to write bindings for Go, Python, PHP, Node.js, Ruby, and other languages. -## [教程与文档](https://dtm.pub) +* Easy to deploy, easy to extend + - DTM depends only on MySQL, easy to deploy, cluster, and scale horizontally. -## [各语言客户端及示例](https://dtm.pub/ref/sdk.html#go) +* Support for multiple distributed transaction protocol + - TCC, SAGA, XA, Transactional messages. -## 微服务框架支持 -- [go-zero](https://github.com/zeromicro/go-zero):一开源就非常火爆的微服务框架,首家接入dtm的微服务框架。感谢go-zero作者[kevwan](https://github.com/kevwan)的大力支持 -- [polaris](https://github.com/polarismesh/polaris): 腾讯开源的注册发现组件,以及在其上构建的微服务框架。感谢腾讯同学[ychensha](https://github.com/ychensha)的PR -- 其他:看用户需求量,择机接入,参见[微服务支持](https://dtm.pub/ref/proto.html) +## DTM vs. others -## 快速开始 +There is no mature open-source distributed transaction framework for non-Java languages. +Mature open-source distributed transaction frameworks for Java language include Ali's Seata, Huawei's ServiceComb-Pack, Jingdong's shardingsphere, himly, tcc-transaction, ByteTCC, and so on, of which Seata is most widely used. -如果您不是Go语言,可以跳转[各语言客户端及示例](https://dtm.pub/ref/sdk.html#go),里面有相关的快速开始示例 +The following is a comparison of the main features of dtm and Seata. -### 运行dtm + +| Features | DTM | Seata | Remarks | +| :-----: | :----: | :----: | :----: | +| Supported languages | Golang, Python, PHP, and others | Java | dtm allows easy access from a new language | +| Exception handling | [Sub-transaction barrier](https://zhuanlan.zhihu.com/p/388444465) | manual | dtm solves idempotent transaction, hanging, null compensation | +| TCC | | | | +| XA | | | | +| AT | suggest XA | | AT is similar to XA with better performance but with dirty rollback | +| SAGA | support concurrency | complicated state-machine mode | dtm's state-machine mode is being planned | +| Transactional Messaging | | | dtm provides Transactional Messaging similar to RocketMQ | +| Multiple DBs in a service |||| +| Communication protocols | HTTP, gRPC | Dubbo, no HTTP | | +| Star count | github stars | github stars | dtm 0.1 is released from 20210604 and under fast development | + +From the features' comparison above, if your language stack includes languages other than Java, then dtm is the one for you. +If your language stack is Java, you can also choose to access dtm and use sub-transaction barrier technology to simplify your business development. + +## [Cook Book](https://en.dtm.pub) + +# Quick start + +### run dtm ``` bash git clone https://github.com/dtm-labs/dtm && cd dtm go run main.go ``` -### 启动并运行一个saga示例 -下面运行一个类似跨行转账的示例,包括两个事务分支:资金转出(TransOut)、资金转入(TransIn)。DTM保证TransIn和TransOut要么全部成功,要么全部回滚,保证最终金额的正确性。 +### Start the example ``` bash git clone https://github.com/dtm-labs/dtmcli-go-sample && cd dtmcli-go-sample go run main.go ``` -## 接入详解 +# Code -### 接入代码 -``` GO - // 具体业务微服务地址 +### Use +``` go + // business micro-service address const qsBusi = "http://localhost:8081/api/busi_saga" - req := &gin.H{"amount": 30} // 微服务的载荷 - // DtmServer为DTM服务的地址,是一个url + // The address where DtmServer serves DTM, which is a url DtmServer := "http://localhost:36789/api/dtmsvr" - saga := dtmcli.NewSaga(DtmServer, dtmcli.MustGenGid(DtmServer)). - // 添加一个TransOut的子事务,正向操作为url: qsBusi+"/TransOut", 补偿操作为url: qsBusi+"/TransOutCom" - Add(qsBusi+"/TransOut", qsBusi+"/TransOutCom", req). - // 添加一个TransIn的子事务,正向操作为url: qsBusi+"/TransIn", 补偿操作为url: qsBusi+"/TransInCom" - Add(qsBusi+"/TransIn", qsBusi+"/TransInCom", req) - // 提交saga事务,dtm会完成所有的子事务/回滚所有的子事务 - err := saga.Submit() + req := &gin.H{"amount": 30} // micro-service payload + // DtmServer is the address of DTM micro-service + saga := dtmcli.NewSaga(DtmServer, dtmcli.MustGenGid(DtmServer)). + // add a TransOut subtraction,forward operation with url: qsBusi+"/TransOut", reverse compensation operation with url: qsBusi+"/TransOutCom" + Add(qsBusi+"/TransOut", qsBusi+"/TransOutCom", req). + // add a TransIn subtraction, forward operation with url: qsBusi+"/TransIn", reverse compensation operation with url: qsBusi+"/TransInCom" + Add(qsBusi+"/TransIn", qsBusi+"/TransInCom", req) + // submit the created saga transaction,dtm ensures all subtractions either complete or get revoked + err := saga.Submit() ``` +### Complete example -成功运行后,可以看到TransOut、TransIn依次被调用,完成了整个分布式事务 +Refer to [dtm-examples](https://github.com/dtm-labs/dtm-examples). -### 时序图 +### Slack -上述saga分布式事务的时序图如下: +You can join the [DTM slack channel here](https://join.slack.com/t/dtm-w6k9662/shared_invite/zt-vkrph4k1-eFqEFnMkbmlXqfUo5GWHWw). - +### Wechat -### 失败情况 -在实际的业务中,子事务可能出现失败,例如转入的子账号被冻结导致转账失败。我们对业务代码进行修改,让TransIn的正向操作失败,然后看看结果 - -``` go - app.POST(qsBusiAPI+"/TransIn", func(c *gin.Context) { - logger.Infof("TransIn") - c.JSON(409, "") // Status 409 表示失败,不再重试,直接回滚 - }) -``` - -再运行这个例子,整个事务最终失败,时序图如下: - - - -在转入操作失败的情况下,TransIn和TransOut的补偿操作被执行,保证了最终的余额和转账前是一样的。 - -### 更多示例 -参考[dtm-labs/dtm-examples](https://github.com/dtm-labs/dtm-examples) - -## 联系我们 -### 公众号 -dtm官方公众号:分布式事务,大量干货分享,以及dtm的最新消息 -### 交流群 -请加 yedf2008 好友或者扫码加好友,验证回复 dtm 按照指引进群 +Add wechat friend with id yedf2008, or scan the OR code. Fill in dtm as verification. ![yedf2008](http://service.ivydad.com/cover/dubbingb6b5e2c0-2d2a-cd59-f7c5-c6b90aceb6f1.jpeg) -欢迎使用[dtm](https://github.com/dtm-labs/dtm),或者通过dtm学习实践分布式事务相关知识,欢迎star支持我们 +### Give a star! ⭐ + +If you think this project is good, or helpful to you, please give a star! +### Who is using +
+ Tencent + Ivydad + Eglass + Jiou + GoldenData +