Nuuvify.CommonPack.BackgroundService
2.1.0-test.25100702
dotnet add package Nuuvify.CommonPack.BackgroundService --version 2.1.0-test.25100702
NuGet\Install-Package Nuuvify.CommonPack.BackgroundService -Version 2.1.0-test.25100702
<PackageReference Include="Nuuvify.CommonPack.BackgroundService" Version="2.1.0-test.25100702" />
<PackageVersion Include="Nuuvify.CommonPack.BackgroundService" Version="2.1.0-test.25100702" />
<PackageReference Include="Nuuvify.CommonPack.BackgroundService" />
paket add Nuuvify.CommonPack.BackgroundService --version 2.1.0-test.25100702
#r "nuget: Nuuvify.CommonPack.BackgroundService, 2.1.0-test.25100702"
#:package Nuuvify.CommonPack.BackgroundService@2.1.0-test.25100702
#addin nuget:?package=Nuuvify.CommonPack.BackgroundService&version=2.1.0-test.25100702&prerelease
#tool nuget:?package=Nuuvify.CommonPack.BackgroundService&version=2.1.0-test.25100702&prerelease
Nuuvify.CommonPack.BackgroundService
Biblioteca para criação de serviços de background que processam mensagens do Azure Service Bus de forma robusta e com telemetria integrada.
Características
- ✅ Classe base abstrata para implementação de workers
- ✅ Integração completa com Azure Service Bus
- ✅ Telemetria e observabilidade com OpenTelemetry
- ✅ Tratamento robusto de erros com diagnóstico avançado
- ✅ Propriedades de diagnóstico para Dead Letter Queue e Abandon
- ✅ Rastreamento detalhado de falhas com metadados contextuais
- ✅ Configuração flexível via connection strings ou Azure credentials
- ✅ Suporte a dead letter queue e message abandonment
- ✅ Arquitetura modular com separação de responsabilidades
- ✅ Complexidade cognitiva reduzida para melhor manutenibilidade
- ✅ Logging estruturado
- ✅ Testes unitários incluídos
Instalação
dotnet add package Nuuvify.CommonPack.BackgroundService
Uso Básico
1. Implementação da Classe Concreta
public class OrderProcessingService : BackgroundServiceAbstract<OrderProcessingService>
{
public OrderProcessingService(
ILogger<OrderProcessingService> logger,
IConfigurationCustom configurationCustom,
RequestConfiguration requestConfiguration,
ActivitySource activitySource)
: base(logger, configurationCustom, requestConfiguration, activitySource,
maxConcurrentCalls: 10, maxAutoLockRenewalDuration: TimeSpan.FromMinutes(10))
{
// Configurar comportamento em caso de falha
AbandonMessageIfFailed = true; // ou false para usar dead letter queue
}
public override async Task<bool> ExecuteRule(
ServiceBusReceivedMessage message,
ActivitySource activitySource,
CancellationToken cancellationToken)
{
using var activity = activitySource.StartActivity("ProcessOrder");
try
{
// Sua lógica de processamento aqui
var messageBody = message.Body.ToString();
var orderData = JsonSerializer.Deserialize<OrderData>(messageBody);
// Adicionar telemetria
activity?.SetTag("order.id", orderData.OrderId);
Logger.LogInformation("Processando pedido {OrderId}", orderData.OrderId);
// Processar o pedido
await ProcessOrderAsync(orderData, cancellationToken);
return true; // Sucesso
}
catch (Exception ex)
{
Logger.LogError(ex, "Erro ao processar mensagem {MessageId}", message.MessageId);
activity?.SetStatus(ActivityStatusCode.Error, ex.Message);
return false; // Falha
}
}
private async Task ProcessOrderAsync(OrderData orderData, CancellationToken cancellationToken)
{
// Implementar lógica de negócio
await Task.Delay(1000, cancellationToken);
}
}
2. Configuração no appsettings.json
{
"AppConfig": {
"ServiceBus": {
"Cnn": "ServiceBusConnection",
"Topic": "orders-topic",
"Subscription": "order-processing-subscription"
}
},
"ConnectionStrings": {
"ServiceBusConnection": "Endpoint=sb://your-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=your-key"
}
}
3. Registro no DI Container
public void ConfigureServices(IServiceCollection services)
{
// Registrar dependências
services.AddSingleton<IConfigurationCustom, ConfigurationCustom>();
services.AddScoped<RequestConfiguration>();
services.AddSingleton(new ActivitySource("YourApp"));
// Registrar o background service
services.AddHostedService<OrderProcessingService>();
}
Configuração com Azure Credentials
Para ambientes de produção, recomenda-se usar Azure Managed Identity:
public override void ConfigureServiceBus(
ServiceBusClientOptions serviceBusClientOptions,
TokenCredential credential,
ServiceBusProcessorOptions serviceBusProcessorOptions)
{
base.ConfigureServiceBus(serviceBusClientOptions, credential, serviceBusProcessorOptions);
}
Configure no appsettings.json:
{
"AppConfig": {
"ServiceBus": {
"FullyQualifiedNamespace": "your-namespace.servicebus.windows.net",
"Topic": "orders-topic",
"Subscription": "order-processing-subscription"
}
}
}
Interface IBackgroundServiceAbstract
A biblioteca fornece uma interface que define o contrato:
public interface IBackgroundServiceAbstract<T>
{
Task<bool> ExecuteRule(
ServiceBusReceivedMessage message,
ActivitySource activitySource,
CancellationToken cancellationToken);
bool AbandonMessageIfFailed { get; set; }
}
Tratamento de Erros
A classe base trata automaticamente diferentes tipos de erros com diagnóstico avançado:
- ServiceBusException: Erros específicos do Service Bus (lock perdido, quota excedida, etc.)
- OperationCanceledException: Cancelamento de operação
- Exception: Erros gerais
Comportamento de Falhas
Configure o comportamento quando uma mensagem falha:
// Abandonar mensagem (retorna para a fila)
AbandonMessageIfFailed = true;
// Enviar para dead letter queue (padrão)
AbandonMessageIfFailed = false;
🆕 Propriedades de Diagnóstico
Todas as mensagens que falham agora incluem propriedades de diagnóstico contextuais:
Dead Letter Queue Properties:
{
"ErrorDetails": "Unhandled exception: Database connection failed",
"FailureTime": "2025-10-07T19:26:30.123Z",
"WorkerVersion": "1.2.3.0",
"CorrelationId": "abc-123-def-456",
"DeliveryAttempt": 3,
"MessageId": "msg-789",
"ExceptionType": "SqlException",
"WorkerInstance": "SERVER01",
"ProcessedBy": "OrderProcessingService"
}
Abandon Message Properties:
{
"AbandonReason": "Operation was cancelled",
"AbandonTime": "2025-10-07T19:26:30.123Z",
"RetryCount": 2,
"CorrelationId": "abc-123-def-456",
"MessageId": "msg-789",
"WorkerInstance": "SERVER01",
"ProcessedBy": "OrderProcessingService",
"NextRetryHint": "2025-10-07T19:27:30.123Z"
}
Benefícios do Diagnóstico Avançado:
- 🔍 Troubleshooting Melhorado: Informações detalhadas sobre falhas
- 📊 Observabilidade: Rastreamento de padrões de erro
- 🎯 Root Cause Analysis: Identificação rápida de problemas sistêmicos
- 📈 Métricas: Criação de dashboards baseados nas propriedades
Telemetria e Observabilidade
A classe integra automaticamente com OpenTelemetry:
- Traces: Cada processamento de mensagem gera um trace
- Tags: CorrelationId, dados da mensagem
- Status: Success/Error com detalhes
Logs Estruturados
A biblioteca gera logs estruturados em vários níveis:
Information
: Início/fim do processamentoWarning
: Operações canceladasError
: Falhas no processamentoDebug
: Detalhes internos (quando habilitado)
🆕 Arquitetura Modular
A partir desta versão, o código foi refatorado para melhor manutenibilidade:
Separação de Responsabilidades
ServiceBusBackgroundService.cs
: Classe principal com lógica coreServiceBusBackgroundService.ExceptionHandling.cs
: Tratamento especializado de exceções
Métodos de Tratamento de Exceções
// Métodos especializados para cada tipo de erro
protected virtual async Task HandleServiceBusSpecificExceptionAsync(...)
protected virtual async Task HandleServiceBusCommunicationExceptionAsync(...)
protected virtual async Task HandleOperationCanceledExceptionAsync(...)
protected virtual async Task HandleGenericExceptionAsync(...)
protected virtual async Task HandleBusinessLogicFailureAsync(...)
Métodos de Diagnóstico
// Criação de propriedades contextuais
protected virtual Dictionary<string, object> CreateDeadLetterProperties(...)
protected virtual Dictionary<string, object> CreateAbandonProperties(...)
Benefícios da Refatoração:
- ✅ Complexidade Cognitiva Reduzida: Métodos menores e mais focados
- ✅ Manutenibilidade: Mais fácil de modificar e estender
- ✅ Testabilidade: Métodos especializados podem ser testados individualmente
- ✅ Reutilização: Métodos podem ser sobrescritos em classes derivadas
- ✅ Clean Code: Seguindo princípios SOLID
Configurações Avançadas
Parâmetros do Construtor
protected BackgroundServiceAbstract(
ILogger<BackgroundServiceAbstract<T>> logger,
IConfigurationCustom configurationCustom,
RequestConfiguration requestConfiguration,
ActivitySource activitySourceCustom,
int maxConcurrentCalls = 10, // Máximo de mensagens processadas simultaneamente
TimeSpan maxAutoLockRenewalDuration = TimeSpan.FromMinutes(5)) // Tempo de renovação do lock
Propriedades Protegidas
Logger
: Instância do loggerConfigurationCustom
: Configuração da aplicaçãoRequestConfiguration
: Configuração da requisiçãoActivitySourceCustom
: Source para telemetria
Métodos Personalizáveis
Você pode sobrescrever os métodos de tratamento de exceções para comportamento customizado:
protected override async Task HandleGenericExceptionAsync(
ProcessMessageEventArgs args,
Exception ex,
CancellationToken cancellationToken)
{
// Seu tratamento customizado
Logger.LogError(ex, "Erro customizado: {Message}", ex.Message);
// Chamar implementação base se necessário
await base.HandleGenericExceptionAsync(args, ex, cancellationToken);
}
Exemplo Completo
Veja o arquivo Examples/OrderProcessingBackgroundService.cs
para um exemplo completo de implementação.
Testes
A biblioteca inclui testes unitários abrangentes. Para executar:
dotnet test test/Nuuvify.CommonPack.BackgroundService.xTest/
Dependências
- Azure.Messaging.ServiceBus
- Microsoft.Extensions.Hosting.Abstractions
- Azure.Monitor.OpenTelemetry.AspNetCore
- Nuuvify.CommonPack.Middleware.Abstraction
Licença
Este projeto está licenciado sob a licença MIT. Veja o arquivo LICENSE para detalhes.
Contribuição
Contribuições são bem-vindas! Por favor, veja o arquivo CONTRIBUTING.md para diretrizes.
Changelog
Veja o arquivo CHANGELOG.md para histórico de versões e mudanças.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net8.0
- Azure.Messaging.ServiceBus (>= 7.20.1)
- Azure.Monitor.OpenTelemetry.AspNetCore (>= 1.3.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 9.0.0)
- Nuuvify.CommonPack.Middleware.Abstraction (>= 2.1.0-test.25100702)
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last Updated |
---|---|---|
2.1.0-test.25100702 | 2 | 10/8/2025 |
2.1.0-test.25100602 | 10 | 10/6/2025 |
2.1.0-test.25100507 | 5 | 10/6/2025 |
2.1.0-test.25100505 | 5 | 10/5/2025 |
2.1.0-test.25100503 | 3 | 10/5/2025 |
2.1.0-test.25093008 | 16 | 9/30/2025 |
2.1.0-test.25093006 | 0 | 9/30/2025 |
2.1.0-test.25092903 | 0 | 9/30/2025 |
2.1.0-test.25071808 | 0 | 7/19/2025 |
# Changelog - Nuuvify.CommonPack.BackgroundService
Todas as mudanças notáveis deste projeto serão documentadas neste arquivo.
O formato é baseado em [Keep a Changelog](https://keepachangelog.com/pt-BR/1.0.0/),
e este projeto adere ao [Semantic Versioning](https://semver.org/lang/pt-BR/).
## [Unreleased]
### Added
- **🆕 Propriedades de diagnóstico avançado** para Dead Letter Queue e Abandon Message
- **🆕 Métodos especializados de tratamento de exceções** com separação de responsabilidades
- **🆕 Classe parcial `ServiceBusBackgroundService.ExceptionHandling.cs`** para organização modular
- **🆕 Método `CreateDeadLetterProperties`** para criação de metadados contextuais
- **🆕 Método `CreateAbandonProperties`** para criação de propriedades de diagnóstico
- **🆕 Rastreamento detalhado** com informações de versão, instância e correlação
- Interface `IBackgroundServiceAbstract<T>` para definir o contrato da classe base
- Documentação XML completa para todos os métodos e propriedades
- Tratamento robusto de erros com diferentes estratégias (abandon vs dead letter)
- Validação do resultado do `ExecuteRule` para determinar o destino da mensagem
- Telemetria integrada com OpenTelemetry
- Logs estruturados com diferentes níveis de severidade
- Exemplo de implementação com `OrderProcessingBackgroundService`
- Testes unitários abrangentes
- Suporte para configuração via connection string ou Azure credentials
- Documentação completa no README.md
### Changed
- **🔧 Refatoração do método `HandleMessageAsync`** para reduzir complexidade cognitiva (16 → <15)
- **🔧 Arquitetura modular** com separação em arquivos especializados
- **🔧 Métodos de tratamento de exceções especializados**:
- `HandleServiceBusSpecificExceptionAsync`
- `HandleServiceBusCommunicationExceptionAsync`
- `HandleOperationCanceledExceptionAsync`
- `HandleGenericExceptionAsync`
- `HandleBusinessLogicFailureAsync`
- **🔧 Uso do parâmetro `propertiesToModify`** em todas as chamadas de DeadLetter e Abandon
- Método `ExecuteRule` alterado de virtual para abstract
- Melhorado o tratamento de cancelamento de operações
- Aprimorado o método `Dispose` para seguir as melhores práticas
- Parâmetro `cancellationToken` renomeado para `stoppingToken` no `ExecuteAsync`
- Melhorada a configuração do Service Bus com validações mais robustas
### Fixed
- **✅ Complexidade cognitiva** do método `HandleMessageAsync` reduzida
- **✅ Maintainability** melhorada com métodos menores e mais focados
- **✅ Code quality** aprimorada seguindo princípios SOLID
- **✅ Suppressão CA1031** com justificativa técnica adequada
- Propagação correta do `CancellationToken` em todas as operações assíncronas
- Tratamento adequado de recursos disposable
- Correção de warnings do analisador de código
- Implementação correta do padrão Dispose
### Security
- **🔒 Informações sensíveis** protegidas nas propriedades de diagnóstico
- **🔒 Validação robusta** de parâmetros de configuração
- Validação de parâmetros de configuração para evitar falhas de segurança
- Tratamento seguro de credenciais Azure
### Technical Debt
- **📉 Complexidade cognitiva reduzida** de 16 para <15 no método principal
- **📉 Código duplicado eliminado** com métodos especializados
- **📈 Testabilidade aumentada** com métodos menores
- **📈 Reutilização melhorada** com métodos virtuais sobrescrevíveis
### Observability & Debugging
- **🔍 Troubleshooting aprimorado** com propriedades contextuais detalhadas
- **📊 Métricas customizáveis** baseadas em propriedades de diagnóstico
- **🎯 Root cause analysis** facilitado com informações de contexto
- **📈 Monitoramento avançado** com timestamps, versões e instâncias
- **🔗 Rastreamento de correlação** end-to-end melhorado
- **📝 Logs estruturados** com informações de diagnóstico integradas
### Example Properties Added:
```json
// Dead Letter Properties
{
"ErrorDetails": "Business logic returned false",
"FailureTime": "2025-10-07T19:26:30.123Z",
"WorkerVersion": "1.2.3.0",
"CorrelationId": "abc-123-def",
"DeliveryAttempt": 3,
"ExceptionType": "BusinessLogicFailure",
"WorkerInstance": "SERVER01",
"ProcessedBy": "OrderProcessingService"
}
// Abandon Properties
{
"AbandonReason": "Operation was cancelled",
"AbandonTime": "2025-10-07T19:26:30.123Z",
"RetryCount": 2,
"NextRetryHint": "2025-10-07T19:27:30.123Z",
"WorkerInstance": "SERVER01",
"ProcessedBy": "OrderProcessingService"
}
```
## [1.0.0] - 2025-01-XX
### Added
- Versão inicial da classe `BackgroundServiceAbstract<T>`
- Integração básica com Azure Service Bus
- Processamento de mensagens com Service Bus Processor
---
Para mais informações, visite: [https://github.com/nuuvify/Nuuvify.CommonPack](https://github.com/nuuvify/Nuuvify.CommonPack)