Tooark.Exceptions 3.3.6

Tooark.Exceptions

Biblioteca que fornece exceções padronizadas para projetos .NET, com mapeamento para status HTTP e suporte a múltiplas formas de construção de mensagens de erro.

Conteúdo

• Visão Geral
• Recursos Suportados
• Exceções Disponíveis
• Exemplos de Uso
• Dependências
• Contribuição
• Licença

Visão Geral

Todas as exceções específicas do pacote herdam de TooarkException, que por sua vez herda de Exception.

A classe base concentra:

• armazenamento de mensagens de erro (GetErrorMessages());
• armazenamento de notificações (GetNotifications());
• contrato para código HTTP (GetStatusCode()).

Recursos Suportados

As classes de exceção suportam os seguintes construtores:

• ExceptionType(string message)
• ExceptionType(IList<string> messages)
• ExceptionType(Notification notification)
• ExceptionType(string messageFormat, params object[] args)

Novos recursos documentados

• Mensagem formatada com placeholders: permite criar mensagens dinâmicas com string.Format.
• Integração com Notification: reutiliza mensagens/notificações já agregadas na camada de validação.
• Múltiplas mensagens: suporta lista de erros para cenários de validação com mais de uma falha.

Exceções Disponíveis

Exemplos de Uso

1) Mensagem simples

throw new BadRequestException("Payload inválido.");

2) Múltiplas mensagens

throw new BadRequestException([
  "Nome é obrigatório.",
  "E-mail inválido."
]);

3) Mensagem formatada (novo)

var userId = 42;
throw new NotFoundException("Usuário com ID {0} não encontrado.", userId);

4) A partir de Notification (novo)

using Tooark.Notifications;

public sealed class DomainNotification : Notification { }

var notification = new DomainNotification();
notification.AddNotification("Documento é obrigatório.", "Document");
notification.AddNotification("Telefone inválido.", "Phone");

throw new BadRequestException(notification);

5) Tratamento padronizado

using Tooark.Exceptions;

try
{
  throw new ServiceUnavailableException("Serviço externo indisponível.");
}
catch (TooarkException ex)
{
  var statusCode = ex.GetStatusCode();
  var errors = ex.GetErrorMessages();
  var notifications = ex.GetNotifications();

  Console.WriteLine($"Status: {(int)statusCode} - {statusCode}");
  Console.WriteLine($"Primeiro erro: {errors.FirstOrDefault()}");
  Console.WriteLine($"Total de notificações: {notifications.Count}");
}

6) Conflito de estado (409)

throw new ConflictException("Já existe um usuário com este e-mail.");

7) Payload muito grande (413)

throw new PayloadTooLargeException(
  "Arquivo excede o limite permitido de {0} MB.",
  10
);

8) Tipo de mídia não suportado (415)

throw new UnsupportedMediaTypeException("Content-Type 'text/plain' não é suportado.");

9) Entidade não processável (422)

throw new UnprocessableEntityException([
  "CPF inválido para a regra de negócio.",
  "Data de nascimento incompatível com o cadastro."
]);

10) Muitas requisições (429)

throw new TooManyRequestsException("Limite de requisições excedido. Tente novamente em alguns segundos.");

Dependências

• Microsoft.AspNetCore.Mvc
• Tooark.Notifications

Contribuição

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

Licença

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