Polly项目中利用依赖注入实现重试日志记录的最佳实践

引言

在分布式系统开发中，重试机制是处理瞬时故障的常见策略。Polly作为.NET生态中知名的弹性与瞬时故障处理库，提供了强大的重试功能。本文将深入探讨如何在Polly项目中结合依赖注入(DI)机制，优雅地实现重试操作的日志记录。

问题背景

开发者在配置Polly重试策略时，常常需要在重试发生时记录相关日志。当使用依赖注入方式配置Polly管道时，由于日志记录器(ILogger)的生命周期管理问题，直接在策略配置阶段获取日志记录器会面临挑战。

解决方案

Polly提供了AddResiliencePipeline方法的多个重载版本，其中包含接受AddResiliencePipelineContext参数的重载。这个上下文对象提供了访问服务容器(IServiceProvider)的能力，使我们能够在重试回调中动态获取日志记录器。

推荐实现方式

services.AddResiliencePipeline("my-key", (builder, context) =>
{
    builder.AddRetry(new RetryStrategyOptions()
    {
        OnRetry = args => 
        {
            var logger = context.ServiceProvider.GetService<ILogger>();
            logger.LogError($"重试操作触发，当前尝试次数: {args.AttemptNumber}");
            return default;
        }
    });
});

这种实现方式有以下优势：

1. 生命周期安全：每次重试时动态获取日志记录器，确保与当前请求的生命周期一致
2. 灵活性：可以根据需要获取不同类型的日志记录器(ILogger或ILoggerFactory)
3. 可测试性：便于在单元测试中模拟服务容器行为

深入理解

Polly的默认日志行为

值得注意的是，Polly框架本身已经内置了对弹性事件的日志记录功能。当配置重试策略时，框架会自动记录包含以下信息的日志：

• 事件名称(如"OnRetry")
• 事件来源(管道名称和策略名称)
• 操作键(Operation Key)
• 异常信息

不过，默认日志中不包含重试次数和延迟时间等详细信息，开发者需要通过自定义回调来补充这些信息。

生命周期管理

在.NET依赖注入体系中，服务实例的生命周期分为：

1. 单例(Singleton)
2. 作用域(Scoped)
3. 瞬时(Transient)

通过上下文动态获取日志记录器的方式，可以确保日志记录器与当前请求的作用域一致，避免潜在的生命周期问题。

高级用法

对于需要更复杂日志记录的场景，可以考虑以下模式：

services.AddResiliencePipeline("advanced-retry", (builder, context) =>
{
    var loggerFactory = context.ServiceProvider.GetRequiredService<ILoggerFactory>();
    var logger = loggerFactory.CreateLogger("CustomRetryLogger");
    
    builder.AddRetry(new RetryStrategyOptions
    {
        OnRetry = args =>
        {
            logger.LogWarning("操作失败，正在进行第{AttemptNumber}次重试，延迟{Delay}ms",
                args.AttemptNumber,
                args.RetryDelay.TotalMilliseconds);
            
            // 可以在这里添加额外的诊断信息
            if(args.Outcome.Exception is HttpRequestException httpEx)
            {
                logger.LogDebug("HTTP请求异常，状态码: {StatusCode}", 
                    httpEx.StatusCode);
            }
            
            return default;
        }
    });
});

结论

在Polly项目中结合依赖注入实现重试日志记录时，通过AddResiliencePipelineContext动态获取日志服务是最佳实践。这种方式既保持了代码的整洁性，又确保了日志记录器生命周期的正确性。开发者可以根据实际需求，灵活扩展日志记录的内容和形式，构建更加健壮的弹性系统。