Implements the Sqrs desing for the clear separation of command and query operations, enhancing the maintainability and scalability of your applications.
Get Started
$ dotnet add package Pavas.Patterns.CqrsReadme
CQRS Design Pattern In .NET
Overview
The CQRS (Command Query Responsibility Segregation) pattern is a design pattern that separates the responsibilities of commands and queries in a system. Commands are used to modify the state, while queries are used to retrieve data. This separation leads to a more maintainable and scalable architecture.
Interfaces
Command Interfaces
- ICommandDispatcher: Dispatches commands to their respective handlers.
- ICommandHandler: Handles commands and optionally returns a result.
- ICommandHandlerAsync: An asynchronous version of
ICommandHandler.
public interface ICommandDispatcher
{
Task<TValue> DispatchCommandAsync<TCommand, TValue>(TCommand command, CancelationToken cancelationToken = new());
Task DispatchCommandAsync<TCommand>(TCommand command, CancelationToken cancelationToken = new());
TValue DispatchCommand<TCommand, TValue>(TCommand command);
void DispatchCommand<TCommand>(TCommand command);
}
public interface ICommandHandler<in TCommand>
{
void Handle(TCommand command);
}
public interface ICommandHandler<in TCommand, out TResult>
{
TResult Handle(TCommand command);
}
public interface ICommandHandlerAsync<in TCommand>
{
Task HandleAsync(TCommand command, CancellationToken cancellationToken = new());
}
public interface ICommandHandlerAsync<in TCommand, TResult>
{
Task<TResult> HandleAsync(TCommand command, CancellationToken cancellationToken = new());
}
Query Interfaces
- IQueryDispatcher: Dispatches queries to their respective handlers.
- IQueryHandler: Handles queries and returns a result.
- IQueryHandlerAsync: An asynchronous version of IQueryHandler.
public interface IQueryDispatcher
{
Task<TValue> DispatchQueryAsync<TQuery, TValue>(TQuery query, CancelationToken cancelationToken = new());
Task<TValue> DispatchQueryAsync<TValue>(CancelationToken cancelationToken = new());
TValue DispatchQuery<TQuery, TValue>(TQuery query);
TValue DispatchQuery<TValue>();
}
public interface IQueryHandler<in TQuery, out TResult>
{
TResult Handle(TQuery query);
}
public interface IQueryHandler<out TResult>
{
TResult Handle();
}
public interface IQueryHandlerAsync<TResult>
{
Task<TResult> HandleAsync(CancellationToken cancellationToken = new());
}
public interface IQueryHandlerAsync<in TQuery, TResult>
{
Task<TResult> HandleAsync(TQuery query, CancellationToken cancellationToken = new());
}