Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplesoft-pt/mediator
Small .NET library that helps with the implementation of mediator pattern for commands, events and queries
https://github.com/simplesoft-pt/mediator
csharp dotnet dotnet-core mediator netcore patterns
Last synced: about 1 month ago
JSON representation
Small .NET library that helps with the implementation of mediator pattern for commands, events and queries
- Host: GitHub
- URL: https://github.com/simplesoft-pt/mediator
- Owner: simplesoft-pt
- License: mit
- Created: 2017-08-12T01:23:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T09:07:12.000Z (about 2 years ago)
- Last Synced: 2024-05-29T21:32:04.163Z (8 months ago)
- Topics: csharp, dotnet, dotnet-core, mediator, netcore, patterns
- Language: C#
- Homepage:
- Size: 893 KB
- Stars: 39
- Watchers: 7
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mediator
Small .NET library that helps with the implementation of mediator pattern for commands, events and queries.
Using a mediator instance, send commands, broadcast events and fetch queries from their respective generic handlers.
## Articles
* [Introduction to the mediator pattern in ASP.NET Core applications](https://medium.com/swlh/mediator-pattern-in-asp-net-core-applications-109b4231c0f8)
* [Using Mediator Pipelines in ASP.NET Core Applications](https://medium.com/swlh/mediator-pattern-in-asp-net-core-applications-pipelines-ec0926e71bc8)
* [Validation with Mediator Pipelines in ASP.NET Core Applications](https://medium.com/swlh/validation-with-mediator-pipelines-in-asp-net-core-applications-7878a56ec604)
* [Transaction Management with Mediator Pipelines in ASP.NET Core](https://medium.com/swlh/transaction-management-with-mediator-pipelines-in-asp-net-core-39317a19bb8d)
* [Auditing with Mediator Pipelines in ASP.NET Core](https://joaoprsimoes.medium.com/auditing-with-mediator-pipelines-in-asp-net-core-be34cf3551b)
## Installation
The library is available via [NuGet](https://www.nuget.org/packages?q=SimpleSoft.Mediator) packages:
| NuGet | Description | Version |
| --- | --- | --- |
| [SimpleSoft.Mediator.Abstractions](https://www.nuget.org/packages/simplesoft.mediator.abstractions) | interfaces and abstract implementations (commands, events, queries, mediator, ...) | [](https://www.nuget.org/packages/simplesoft.mediator.abstractions) |
| [SimpleSoft.Mediator](https://www.nuget.org/packages/simplesoft.mediator) | core implementation | [](https://www.nuget.org/packages/simplesoft.mediator) |
| [SimpleSoft.Mediator.Microsoft.Extensions](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions) | specialized methods and classes for the Microsoft dependency injection container and logging facades | [](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions) |
| [SimpleSoft.Mediator.Microsoft.Extensions.DatabaseTransactionPipeline](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions.databasetransactionpipeline) | mediator pipeline to enforce SimpleSoft.Database transactions | [](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions.databasetransactionpipeline) |
| [SimpleSoft.Mediator.Microsoft.Extensions.EFCoreTransactionPipeline](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions.efcoretransactionpipeline) | mediator pipeline to enforce Entity Framework Core transactions | [](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions.efcoretransactionpipeline) |
| [SimpleSoft.Mediator.Microsoft.Extensions.LoggingPipeline](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions.loggingpipeline) | pipeline that serializes commands, queries, events and results into the logging | [](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions.loggingpipeline) |
| [SimpleSoft.Mediator.Microsoft.Extensions.ValidationPipeline](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions.validationpipeline) | pipeline that enforces validation into commands, queries and events before entering the handlers by using `FluentValidation` | [](https://www.nuget.org/packages/simplesoft.mediator.microsoft.extensions.validationpipeline) |
### Package Manager
```powershell
Install-Package SimpleSoft.Mediator.Abstractions
Install-Package SimpleSoft.Mediator
Install-Package SimpleSoft.Mediator.Microsoft.Extensions
Install-Package SimpleSoft.Mediator.Microsoft.Extensions.DatabaseTransactionPipeline
Install-Package SimpleSoft.Mediator.Microsoft.Extensions.EFCoreTransactionPipeline
Install-Package SimpleSoft.Mediator.Microsoft.Extensions.LoggingPipeline
Install-Package SimpleSoft.Mediator.Microsoft.Extensions.ValidationPipeline
```
### .NET CLI
```powershell
dotnet add package SimpleSoft.Mediator.Abstractions
dotnet add package SimpleSoft.Mediator
dotnet add package SimpleSoft.Mediator.Microsoft.Extensions
dotnet add package SimpleSoft.Mediator.Microsoft.Extensions.DatabaseTransactionPipeline
dotnet add package SimpleSoft.Mediator.Microsoft.Extensions.EFCoreTransactionPipeline
dotnet add package SimpleSoft.Mediator.Microsoft.Extensions.LoggingPipeline
dotnet add package SimpleSoft.Mediator.Microsoft.Extensions.ValidationPipeline
```
## Compatibility
This library is compatible with the following frameworks:
* `SimpleSoft.Mediator.Abstractions`
* .NET Framework 4.0+;
* .NET Standard 1.0+;
* `SimpleSoft.Mediator`
* .NET Framework 4.0+;
* .NET Standard 1.0+;
* `SimpleSoft.Mediator.Microsoft.Extensions`
* .NET Standard 1.1+;
* `SimpleSoft.Mediator.Microsoft.Extensions.DatabaseTransactionPipeline`
* .NET Standard 1.1+;
* `SimpleSoft.Mediator.Microsoft.Extensions.EFCoreTransactionPipeline`
* .NET Standard 1.3+;
* `SimpleSoft.Mediator.Microsoft.Extensions.LoggingPipeline`
* .NET Standard 1.1+;
* `SimpleSoft.Mediator.Microsoft.Extensions.ValidationPipeline`
* .NET Standard 1.1+;
## Usage
Documentation is available via [wiki](https://github.com/simplesoft-pt/Mediator/wiki) or you can check the [working](https://github.com/simplesoft-pt/Mediator/tree/master/work/) examples or [test](https://github.com/simplesoft-pt/Mediator/tree/master/test) code.
Here is an example of a command handler that also sends some events:
```csharp
public class CreateUserCommand : Command {
public string Email { get; set; }
public string Password { get; set; }
}
public class UserCreatedEvent : Event {
public User User { get; set; }
}
public class UserByIdQuery : Query {
public Guid UserId { get; set; }
}
public class User {
public Guid Id { get; set; }
public string Email { get; set; }
}
public class ExampleHandlers : ICommandHandler, IQueryHandler {
private readonly IMediator _mediator;
public UsersService(IMediator mediator) {
_mediator = mediator;
}
public async Task HandleAsync(CreateUserCommand cmd, CancellationToken ct) {
var userId = Guid.NewGuid();
// try add the user to some store
await _mediator.BroadcastAsync(new UserCreatedEvent {
User = new User {
Id = userId,
Email = cmd.Email
}
}, ct);
}
public async Task HandleAsync(UserByIdQuery query, CancellationToken ct) {
User user = null;
// search the store by user id
return user;
}
}
```