- Notifications
You must be signed in to change notification settings - Fork27
The new client for dtm in csharp, including workflow, dtmcli, and dtmgrpc
License
dtm-labs/client-csharp
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
English |简体中文
client-csharp is the C# client of Distributed Transaction ManagerDTM.
| client | features | nuget |
|---|---|---|
| dtmcli | saga/tcc/2-phase message |   |
| dtmgrpc | saga/tcc/2-phase message |   |
| workflow | - | - |
DTM is a distributed transaction solution which provides cross-service eventually data consistency. It provides saga, tcc, xa, 2-phase message strategies for a variety of application scenarios. It also supports multiple languages and multiple store engine to form up a transaction as following:
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.
Easy to use
- Relieving developers from worrying about suspension, null compensation, idempotent transaction, and other tricky problems, the framework layer handles them all.
Language-agnostic
- Suit for companies with multiple-language stacks.Easy to write bindings for Go, Python, PHP, Node.js, Ruby, and other languages.
Easy to deploy, easy to extend
- DTM depends only on MySQL, easy to deploy, cluster, and scale horizontally.
Support for multiple distributed transaction protocol
- TCC, SAGA, XA, Transactional messages.
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.
The following is a comparison of the main features of dtm and Seata.
| Features | DTM | Seata | Remarks |
|---|---|---|---|
| Supported languages | Golang, C#, Java, Python, PHP, and others | Java | dtm allows easy access from a new language |
| Exception handling | Sub-transaction barrier | 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 |  |  | 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.
Add nuget package via the following command
dotnet add package Dtmcli
There are two ways to configure
- Configure with setup action
services.AddDtmcli(x=>{// DTM server HTTP addressx.DtmUrl="http://localhost:36789";// request timeout for DTM server, unit is millisecondsx.DtmTimeout=10000;// request timeout for trans branch, unit is millisecondsx.BranchTimeout=10000;// barrier database type, mysql, postgres, sqlserverx.SqlDbType="mysql";// barrier table namex.BarrierTableName="dtm_barrier.barrier";});
- Configure with
IConfiguration
services.AddDtmcli(Configuration,"dtm");
And the configuration file
{"dtm": {"DtmUrl":"http://localhost:36789","DtmTimeout":10000,"BranchTimeout":10000,"SqlDbType":"mysql","BarrierTableName":"dtm_barrier.barrier", }}publicclassMyBusi{privatereadonlyDtmcli.IDtmTransFactory_transFactory;publicMyBusi(Dtmcli.IDtmTransFactorytransFactory){this._transFactory=transFactory;}publicasyncTaskDoBusAsync(){vargid=Guid.NewGuid().ToString();varreq=newBusiReq{Amount=30};// NOTE: After DTM v1.12.2// when svc start with http or https, DTM server will send HTTP request to svc// when svc don't start with http or https, DTM server will send gRPC request to svcvarsvc="http://localhost:5005";varsaga=_transFactory.NewSaga(gid);// Add sub-transactionsaga.Add(// URL of forward actionsvc+"/api/TransOut",// URL of compensating actionsvc+"/api/TransOutCompensate",// Arguments of actionsreq);saga.Add(svc+"/api/TransIn",svc+"/api/TransInCompensate",req);awaitsaga.Submit();}}
publicclassMyBusi{privatereadonlyDtmcli.TccGlobalTransaction_globalTransaction;publicMyBusi(Dtmcli.TccGlobalTransactionglobalTransaction){this._globalTransaction=globalTransaction;}publicasyncTaskDoBusAsync(){vargid=Guid.NewGuid().ToString();varreq=newBusiReq{Amount=30};varsvc="http://localhost:5005";await_globalTransaction.Excecute(gid,async tcc=>{// Create tcc sub-transactionawaittcc.CallBranch(// Arguments of stagesreq,// URL of Try stagesvc+"/api/TransOutTry",// URL of Confirm stagesvc+"/api/TransOutConfirm",// URL of Cancel stagesvc+"/api/TransOutCancel");awaittcc.CallBranch(req,svc+"/api/TransInTry",svc+"/api/TransInConfirm",svc+"/api/TransInCancel");});}}
publicclassMyBusi{privatereadonlyDtmcli.IDtmTransFactory_transFactory;publicMyBusi(Dtmcli.IDtmTransFactorytransFactory){this._transFactory=transFactory;}publicasyncTaskDoBusAsync(){vargid=Guid.NewGuid().ToString();varreq=newBusiReq{Amount=30};varsvc="http://localhost:5005";varmsg=_transFactory.NewMsg(gid);// Add sub-transactionmsg.Add(// URL of actionsvc+"/api/TransOut",// Arguments of actionreq);msg.Add(svc+"/api/TransIn",req);// Usage 1:// Send prepare messageawaitmsg.Prepare(svc+"/api/QueryPrepared");// Send submit messageawaitmsg.Submit();// Usage 2:using(varconn=GetDbConnection()){awaitmsg.DoAndSubmitDB(svc+"/api/QueryPrepared",conn,async tx=>{awaitconn.ExecuteAsync("insert ....",new{},tx);awaitconn.ExecuteAsync("update ....",new{},tx);awaitconn.ExecuteAsync("delete ....",new{},tx);});}}}
publicclassMyBusi{privatereadonlyDtmcli.XaGlobalTransaction_globalTransaction;publicMyBusi(Dtmcli.XaGlobalTransactionglobalTransaction){this._globalTransaction=globalTransaction;}publicasyncTaskDoBusAsync(CancellationTokencancellationToken){varsvc="http://localhost:5005";await_globalTransaction.ExcecuteAsync(async(Xaxa)=>{// NOTE: Limitations of using Xa mode// The current mode only supports mysql, postgresDB, please modify the corresponding client configuration, such as SqlDbType, etc.// Connection pooling needs to be turned off for mysql versions below 8.0// Create XA sub-transactionawaitxa.CallBranch(// Arguments of actionnewTransRequest("1",-30),// URL of actionsvc+"/XaTransOut",// Cancel tokencancellationToken);awaitxa.CallBranch(newTransRequest("2",30),svc+"/XaTransIn",cancellationToken);},cancellationToken);}}
Refer tohttps://github.com/dtm-labs/dtmcli-csharp-sampleclient-csharp/samples · dtm-labs/client-csharp
Add wechat friend with idyedf2008, or scan the OR code. Fill incsharp as verification.
About
The new client for dtm in csharp, including workflow, dtmcli, and dtmgrpc