{"id":19073391,"url":"https://github.com/dtm-labs/dtmgrpc-csharp","last_synced_at":"2025-04-28T19:15:34.313Z","repository":{"id":37960997,"uuid":"459116058","full_name":"dtm-labs/dtmgrpc-csharp","owner":"dtm-labs","description":"A c# gRPC client of distributed transaction manager DTM.","archived":false,"fork":false,"pushed_at":"2022-06-13T14:55:40.000Z","size":101,"stargazers_count":22,"open_issues_count":0,"forks_count":3,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-28T19:15:27.495Z","etag":null,"topics":["csharp","distributed-transaction","dtm","grpc","msg","saga","tcc","transaction"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dtm-labs.png","metadata":{"files":{"readme":"README-cn.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-14T10:31:01.000Z","updated_at":"2024-12-07T07:10:12.000Z","dependencies_parsed_at":"2022-07-14T22:00:33.135Z","dependency_job_id":null,"html_url":"https://github.com/dtm-labs/dtmgrpc-csharp","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtm-labs%2Fdtmgrpc-csharp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtm-labs%2Fdtmgrpc-csharp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtm-labs%2Fdtmgrpc-csharp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtm-labs%2Fdtmgrpc-csharp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dtm-labs","download_url":"https://codeload.github.com/dtm-labs/dtmgrpc-csharp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251372531,"owners_count":21578967,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","distributed-transaction","dtm","grpc","msg","saga","tcc","transaction"],"created_at":"2024-11-09T01:46:40.674Z","updated_at":"2025-04-28T19:15:34.296Z","avatar_url":"https://github.com/dtm-labs.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"[English](./README.md) | 简体中文\n\n# dtmgrpc-csharp\n\n`dtmgrpc-csharp` 是分布式事务管理器 [DTM](https://github.com/dtm-labs/dtm) 的 C# 客户端，使用 gRPC 协议和 DTM 服务端进行交互。 \n\n目前已经支持 SAGA 、 TCC 和二阶段消息三种事务模式。\n\n![Build_And_UnitTest](https://github.com/catcherwong/dtmgrpc-csharp/actions/workflows/build_and_ut.yml/badge.svg) ![Build_And_IntegrationTests](https://github.com/catcherwong/dtmgrpc-csharp/actions/workflows/build_and_it.yml/badge.svg)\n\n![](https://img.shields.io/nuget/v/Dtmgrpc.svg)  ![](https://img.shields.io/nuget/vpre/Dtmgrpc.svg) ![](https://img.shields.io/nuget/dt/Dtmgrpc) ![](https://img.shields.io/github/license/catcherwong/dtmgrpc-csharp)\n\n## 安装\n\n通过下面的命名安装 nuget 包\n\n```sh\ndotnet add package Dtmgrpc\n```\n\n## 配置\n\n这里有两种方式进行配置\n\n1. 使用 setup action\n\n```cs\nservices.AddDtmGrpc(x =\u003e\n{\n    // DTM server 的 gRPC 地址\n    x.DtmGrpcUrl = \"http://localhost:36790\";\n    \n    // 请求 DTM server 的超时时间, 单位是毫秒\n    x.DtmTimeout = 10000; \n    \n    // 请求分支事务的超时时间, 单位是毫秒\n    x.BranchTimeout = 10000;\n    \n    // 子事务屏障的数据库类型, mysql, postgres, sqlserver\n    x.DBType = \"mysql\";\n\n    // 子事务屏障的数据表名\n    x.BarrierTableName = \"dtm_barrier.barrier\";\n});\n```\n\n2. 使用 `IConfiguration`\n\n```cs\nservices.AddDtmGrpc(Configuration, \"dtm\");\n```\n\n添加配置文件，以 JSON 为例： \n\n```JSON\n{\n  \"dtm\": {\n    \"DtmGrpcUrl\": \"http://localhost:36790\",\n    \"DtmTimeout\": 10000,\n    \"BranchTimeout\": 10000,\n    \"DBType\": \"mysql\",\n    \"BarrierTableName\": \"dtm_barrier.barrier\",\n  }\n}\n```\n\n## 用法\n\n### SAGA\n\n```cs\npublic class MyBusi\n{ \n    private readonly Dtmgrpc.IDtmTransFactory _transFactory;\n\n    public MyBusi(Dtmgrpc.IDtmTransFactory transFactory)\n    {\n        this._transFactory = transFactory;\n    }\n\n    public async Task DoBusAsync()\n    {\n        var gid = Guid.NewGuid().ToString();\n        var req = new BusiReq {  Amount = 30 };\n        var svc = \"localhost:5005\";\n\n        var saga = _transFactory.NewSagaGrpc(gid);\n        // 添加子事务操作\n        saga.Add(\n            // 正向操作 URL\n            svc + \"/busi.Busi/TransOut\",\n            \n            // 逆向操作 URL\n            svc + \"/busi.Busi/TransOutCompensate\",\n\n            // 参数\n            req);\n        saga.Add(\n            svc + \"/busi.Busi/TransIn\",\n            svc + \"/busi.Busi/TransInCompensate\",\n            req);\n\n        await saga.Submit();\n    }\n}\n```\n\n### TCC\n\n```cs\npublic class MyBusi\n{ \n    private readonly Dtmgrpc.TccGlobalTransaction _globalTransaction;\n\n    public MyBusi(Dtmgrpc.TccGlobalTransaction globalTransaction)\n    {\n        this._globalTransaction = globalTransaction;\n    }\n\n    public async Task DoBusAsync()\n    {\n        var gid = Guid.NewGuid().ToString();\n        var req = new BusiReq {  Amount = 30 };\n        var svc = \"localhost:5005\";\n\n        await _globalTransaction.Excecute(gid, async tcc =\u003e\n        {\n            // 调用 TCC 子事务\n            await tcc.CallBranch\u003cBusiReq, Empty\u003e(\n                // 参数\n                req,\n\n                // Try 阶段的 URL\n                svc + \"/busi.Busi/TransOutTry\",\n\n                // Confirm 阶段的 URL \n                svc + \"/busi.Busi/TransOutConfirm\",\n\n                 // Cancel 阶段的 URL\n                svc + \"/busi.Busi/TransOutCancel\");\n\n            await tcc.CallBranch\u003cBusiReq, Empty\u003e(\n                req,\n                svc + \"/busi.Busi/TransInTry\",\n                svc + \"/busi.Busi/TransInConfirm\",\n                svc + \"/busi.Busi/TransInCancel\");\n        });\n    }\n}\n```\n\n\n### 二阶段消息\n\n```cs\npublic class MyBusi\n{ \n    private readonly Dtmgrpc.IDtmTransFactory _transFactory;\n\n    public MyBusi(Dtmgrpc.IDtmTransFactory transFactory)\n    {\n        this._transFactory = transFactory;\n    }\n\n    public async Task DoBusAsync()\n    {\n        var gid = Guid.NewGuid().ToString();\n        var req = new BusiReq {  Amount = 30 };\n        var svc = \"localhost:5005\";\n\n        var msg = _transFactory.NewMsgGrpc(gid);\n        // 添加子事务操作\n        msg.Add(\n            // 操作的 URL\n            svc + \"/busi.Busi/TransOut\",\n\n            // 参数\n            req);\n        msg.Add(\n            svc + \"/busi.Busi/TransIn\",\n            req);\n\n        // 用法 1:\n        // 发送 prepare 消息\n        await msg.Prepare(svc + \"/busi.Busi/QueryPrepared\");\n        // 发送 submit 消息\n        await msg.Submit();\n\n        // 用法 2:\n        using (MySqlConnection conn = new MySqlConnection(\"You connection string ....\"))\n        {\n            await msg.DoAndSubmitDB(svc + \"/busi.Busi/QueryPrepared\", conn, async tx =\u003e \n            {\n                await conn.ExecuteAsync(\"insert ....\", new { }, tx);\n                await conn.ExecuteAsync(\"update ....\", new { }, tx);\n                await conn.ExecuteAsync(\"delete ....\", new { }, tx);\n            });\n        }\n    }\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdtm-labs%2Fdtmgrpc-csharp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdtm-labs%2Fdtmgrpc-csharp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdtm-labs%2Fdtmgrpc-csharp/lists"}