在 .NET Core 中实现 Saga 设计模式
Chronicle is simple process manager/saga pattern implementation for .NET Core that helps you manage long-living and distirbuted transactions.
| master | develop | |
|---|---|---|
| AppVeyor | ||
| CodeCov |
Chornicle is available on NuGet
Install-Package Chronicle_ -Version 3.2.1dotnet add package Chronicle_ --version 3.2.1In order to create and process a saga you need to go through a few steps:
Saga or Saga.ISagaStartAction and ISagaAction to implement HandleAsync() and CompensateAsync() methods for each message type. An initial step must be implemented as an ISagaStartAction, while the rest can be ISagaAction. It's worth mentioning that you can implement as many ISagaStartAction as you want. In this case, the first incoming message is going to initialize the saga and any subsequent ISagaStartAction or ISagaAction will only update the current saga state.Startup.cs by calling services.AddChronicle(). By default, AddChronicle() will use the InMemorySagaStateRepository and InMemorySagaLog for maintaining SagaState and for logging SagaLogData in the SagaLog. The SagaLog maintains a historical record of which message handlers have been executed. Optionally, AddChronicle() accepts an Action parameter which provides access to UseSagaStateRepository() and UseSagaLog() for custom implementations of ISagaStateRepository and ISagaLog. If either method is called, then both methods need to be called.ISagaCoordinator and invoke ProcessAsync() methods passing a message. The coordinator will take care of everything by looking for all implemented sagas that can handle a given message.CompleteSaga() or CompleteSagaAsync(). This will update the SagaState to Completed. To flag a saga which has failed or been rejected, call the Reject() or RejectAsync() methods to update the SagaState to Rejected. Doing so will utilize the SagaLog to call each message type's CompensateAsync() in the reverse order of their respective HandleAsync() method was called. Additionally, an unhanded exception thrown from a HandleAsync() method will cause Reject() to be called and begin the compensation.Below is the very simple example of saga that completes once both messages (Message1 and Message2) are received:
…Both messages are processed by mentioned coordinator:
var coordinator = app.ApplicationServices.GetService();
var context = SagaContext
.Create()
.WithCorrelationId(Guid.NewGuid())
.Build();
coordinator.ProcessAsync(new Message1 { Text = "Hello" }, context);
coordinator.ProcessAsync(new Message2 { Text = "World" }, context);The result looks as follows:
If you're looking for documentation, you can find it here.
Icon made by Smashicons from www.flaticon.com is licensed by Creative Commons BY 3.0
暂无开放 Issues,或尚未同步最近议题。