Tooark.Mediator.Abstractions 4.0.1

Tooark.Mediator.Abstractions

Biblioteca com os contratos base do padrão Mediator para projetos .NET, utilizada por implementações como Tooark.Mediator.

Conteúdo

• Visão Geral
• Instalação
• Componentes
• Exemplos de Uso
• Dependências
• Contribuição
• Licença

Visão Geral

O pacote Tooark.Mediator.Abstractions define os contratos para:

• requests (IRequest, IRequest<TResponse>);
• commands (ICommand, ICommand<TResponse>);
• queries (IQuery<TResponse>);
• notifications (INotify);
• envio e publicação (ISender, IPublisher);
• interface principal (IMediator);
• retorno vazio (Unit).

🔧 Instalação

dotnet add package Tooark.Mediator.Abstractions

📦 Componentes

Contratos de mensagem

• IRequest<TResponse>: contrato base de requisição com resposta.
• IRequest: atalho para requisição sem payload de resposta (Unit).
• ICommand<TResponse>: comando com resposta.
• ICommand: comando sem resposta explícita (Unit).
• IQuery<TResponse>: consulta com resposta.
• INotify: notificação/evento sem resposta.

Contratos de orquestração

• ISender
  • Task<TResponse> SendAsync<TResponse>(IRequest<TResponse> request, CancellationToken cancellationToken = default)
• IPublisher
  • Task PublishAsync(INotify notify, CancellationToken cancellationToken = default)
• IMediator: combina ISender e IPublisher.

Tipo utilitário

• Unit
  • Unit.Value: a única instância de Unit.
  • Unit.Task: tarefa concluída com Unit.Value, criada uma única vez e reutilizada a cada acesso.

📝 Exemplos de Uso

Definindo mensagens

using Tooark.Mediator.Abstractions;

public sealed record CreateOrderCommand(string CustomerName) : ICommand<Guid>;

public sealed record GetOrderByIdQuery(Guid Id) : IQuery<string>;

public sealed record OrderCreatedNotify(Guid OrderId) : INotify;

Dependendo dos contratos no serviço

using Tooark.Mediator.Abstractions;

public sealed class OrderApplicationService(ISender sender, IPublisher publisher)
{
  public async Task<Guid> CreateAsync(string customerName, CancellationToken cancellationToken)
  {
    var id = await sender.SendAsync(new CreateOrderCommand(customerName), cancellationToken);

    await publisher.PublishAsync(new OrderCreatedNotify(id), cancellationToken);

    return id;
  }

  public Task<string> GetByIdAsync(Guid id, CancellationToken cancellationToken)
  {
    return sender.SendAsync(new GetOrderByIdQuery(id), cancellationToken);
  }
}

Usando Unit em comandos sem retorno

using Tooark.Mediator.Abstractions;

public sealed record DeactivateOrderCommand(Guid Id) : ICommand;

// ICommand é atalho para ICommand<Unit>: o envio retorna Task<Unit>
public sealed class OrderMaintenanceService(ISender sender)
{
  public Task<Unit> DeactivateAsync(Guid id, CancellationToken cancellationToken)
  {
    // Curto-circuito síncrono: Unit.Task reutiliza a tarefa pré-construída, sem nova alocação
    if (id == Guid.Empty)
    {
      return Unit.Task;
    }

    return sender.SendAsync(new DeactivateOrderCommand(id), cancellationToken);
  }
}

📋 Dependências

🪪 Contribuição

Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests no repositório Tooark.Mediator.Abstractions.

📄 Licença

Este projeto está licenciado sob a licença BSD 3-Clause. Veja o arquivo LICENSE para mais detalhes.