From 3bea4498f7547c7ac06aa7f397d9b9772daef7c4 Mon Sep 17 00:00:00 2001
From: yedf2 <120050102@qq.com>
Date: Tue, 29 Mar 2022 15:39:01 +0800
Subject: [PATCH] update readme
---
LICENSE | 2 +-
README.md | 150 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 150 insertions(+), 2 deletions(-)
diff --git a/LICENSE b/LICENSE
index dffdede..9f5a798 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
BSD 3-Clause License
-Copyright (c) 2021, ivydad
+Copyright (c) 2021, yedf
All rights reserved.
Redistribution and use in source and binary forms, with or without
diff --git a/README.md b/README.md
index 8c3bd78..282bf6e 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,149 @@
-此仓库应常青藤爸爸公司要求，已停止维护。请移步 [https://github.com/dtm-labs/dtf](https://github.com/dtm-labs/dtf)
+
+
+[](https://codecov.io/gh/dtm-labs/dtm)
+[](https://goreportcard.com/report/github.com/dtm-labs/dtm)
+[](https://pkg.go.dev/github.com/dtm-labs/dtm)
+[](https://github.com/avelino/awesome-go#database)
+
+简体中文 | [English](https://github.com/dtm-labs/dtm/blob/main/helper/README-en.md)
+
+# 跨语言分布式事务管理器
+
+DTM是一款变革性的分布式事务框架，提供了傻瓜式的使用方式，极大的降低了分布式事务的使用门槛，改变了“能不用分布式事务就不用”的行业现状。 dtm 的应用范围非常广，可以应用于以下常见的领域：
+- [秒杀系统，保证Redis中精准的库存，和最终创建的订单完全一致，无需手动调整](https://dtm.pub/app/flash.html)
+- [保证缓存与DB的一致性](https://dtm.pub/app/cache.html)
+- [非单体的订单系统，大幅简化架构](https://dtm.pub/app/order.html)
+- 微服务架构(已原生支持[go-zero](https://github.com/zeromicro/go-zero)等框架)中跨服务更新数据保证一致性
+
+他优雅的解决了幂等、空补偿、悬挂等分布式事务难题，提供跨语言，跨存储引擎组合事务的强大功能：
+
+
+## 谁在使用DTM(仅列出部分)
+[Tencent 腾讯](https://dtm.pub/other/using.html#tencent)
+
+[Ivydad 常青藤爸爸](https://dtm.pub/other/using.html#ivydad)
+
+[Eglass 视咖镜小二](https://dtm.pub/other/using.html)
+
+[极欧科技](https://dtm.pub/other/using.html)
+
+## 亮点
+
+* 极易上手
+ - 零配置启动服务，提供非常简单的HTTP接口，极大降低上手分布式事务的难度，新手也能快速接入
+* 跨语言
+ - 可适合多语言栈的公司使用。方便go、python、php、nodejs、ruby、c# 各类语言使用。
+* 使用简单
+ - 开发者不再担心悬挂、空补偿、幂等各类问题，首创子事务屏障技术代为处理
+* 易部署、易扩展
+ - 依赖mysql/redis，部署简单，易集群化，易水平扩展
+* 多种分布式事务协议支持
+ - TCC、SAGA、XA、二阶段消息，一站式解决所有分布式事务问题
+
+## 与其他框架对比
+
+非Java语言类的，暂未看到除dtm之外的成熟框架，因此这里将DTM和Java中最成熟的Seata对比：
+
+| 特性| 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)|
|
|dtm从20210604发布0.1，发展快|
+
+从上面对比的特性来看，dtm在许多方面都具备很大的优势。如果考虑多语言支持、多存储引擎支持，那么dtm毫无疑问是您的首选
+
+详细的对比可以点击特性中的链接，跳到相关文档
+## [性能测试报告](https://dtm.pub/other/performance.html)
+
+## [教程与文档](https://dtm.pub)
+
+## [各语言客户端及示例](https://dtm.pub/ref/sdk.html#go)
+
+## 微服务框架支持
+- [go-zero](https://github.com/zeromicro/go-zero)：一开源就非常火爆的微服务框架，首家接入dtm的微服务框架。感谢go-zero作者[kevwan](https://github.com/kevwan)的大力支持
+- [kratos](https://github.com/go-kratos/kratos)：这是bilibili开源的一个微服务框架。感谢[lei liu](https://github.com/Leizhengzi)的贡献
+- [polaris](https://github.com/polarismesh/polaris): 腾讯开源的注册发现组件，以及在其上构建的微服务框架。感谢腾讯同学[ychensha](https://github.com/ychensha)的PR
+- 其他：看用户需求量，择机接入，参见[微服务支持](https://dtm.pub/ref/proto.html)
+
+## 快速开始
+
+如果您不是Go语言，可以跳转[各语言客户端及示例](https://dtm.pub/ref/sdk.html#go)，里面有相关的快速开始示例
+
+### 运行dtm
+
+``` bash
+git clone https://github.com/dtm-labs/dtm && cd dtm
+go run main.go
+```
+
+### 启动并运行一个saga示例
+下面运行一个类似跨行转账的示例，包括两个事务分支：资金转出（TransOut)、资金转入（TransIn)。DTM保证TransIn和TransOut要么全部成功，要么全部回滚，保证最终金额的正确性。
+
+``` bash
+git clone https://github.com/dtm-labs/dtmcli-go-sample && cd dtmcli-go-sample
+go run main.go
+```
+
+## 接入详解
+
+### 接入代码
+``` GO
+ // 具体业务微服务地址
+ const qsBusi = "http://localhost:8081/api/busi_saga"
+ req := &gin.H{"amount": 30} // 微服务的载荷
+ // DtmServer为DTM服务的地址，是一个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()
+```
+
+成功运行后，可以看到TransOut、TransIn依次被调用，完成了整个分布式事务
+
+### 时序图
+
+上述saga分布式事务的时序图如下：
+
+
+
+### 失败情况
+在实际的业务中，子事务可能出现失败，例如转入的子账号被冻结导致转账失败。我们对业务代码进行修改，让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 按照指引进群
+
+
+
+欢迎使用[dtm](https://github.com/dtm-labs/dtm)，或者通过dtm学习实践分布式事务相关知识，欢迎star支持我们
+