使用Polly库实现基于返回结果的异步重试策略

概述

在现代分布式系统开发中，处理暂时性故障是每个开发者必须面对的挑战。Polly作为.NET生态中广受欢迎的弹性与瞬态故障处理库，提供了强大的重试机制来应对这类问题。本文将深入探讨如何使用Polly的最新版本(V8)实现基于方法返回结果而非异常的重试策略。

重试策略的核心概念

Polly的重试策略允许开发者在操作失败时自动重试，这里的"失败"不仅限于抛出异常，还包括返回特定结果值的情况。这种机制特别适用于以下场景：

1. 调用外部API返回特定错误码时需要重试
2. 数据库查询返回空或特定状态码时需要重试
3. 任何需要根据业务逻辑判断是否重试的情况

实现细节

定义数据模型

首先，我们需要定义一个简单的数据模型作为示例：

public class MyClass
{
    public short ReturnCode { get; set; } = 0;
}

这个模型包含一个ReturnCode属性，我们将基于这个属性的值来决定是否需要重试。

配置重试策略

Polly V8引入了全新的构建器模式来配置策略：

var retryStrategyOptions = new RetryStrategyOptions<MyClass>
{
    MaxRetryAttempts = 10,
    DelayGenerator = static args =>
    {
        var delay = args.AttemptNumber switch
        {
            0 => TimeSpan.Zero,
            1 => TimeSpan.FromSeconds(1),
            _ => TimeSpan.FromSeconds(5)
        };        
        return new ValueTask<TimeSpan?>(delay);
    },
    OnRetry = static args =>
    {
        Console.WriteLine("OnRetry, Attempt: {0}", args.AttemptNumber);
        return default;
    },
    ShouldHandle = new PredicateBuilder<MyClass>()
        .HandleResult(static result => result == null || result.ReturnCode != 0)
};

关键配置说明：

1. MaxRetryAttempts：设置最大重试次数
2. DelayGenerator：自定义重试延迟时间，支持按尝试次数设置不同的等待时间
3. OnRetry：重试时触发的回调，可用于日志记录等
4. ShouldHandle：核心配置，使用PredicateBuilder定义何种结果应触发重试

构建并执行策略

配置完成后，我们可以构建并执行策略：

var pipeline = new ResiliencePipelineBuilder<MyClass>()
    .AddRetry(retryStrategyOptions)
    .AddTimeout(TimeSpan.FromSeconds(10))
    .Build();

var context = ResilienceContextPool.Shared.Get();

var outcome = await pipeline.ExecuteOutcomeAsync(
    (context, state) =>
    {
        var result = GetData(); // 获取数据的方法
        if (result == null) 
            return Outcome.FromExceptionAsValueTask<MyClass>(new Exception("Data not found"));
        
        return Outcome.FromResultAsValueTask(result);
    },
    context,
    "state-object");

ResilienceContextPool.Shared.Return(context);

策略执行分析

当执行上述代码时，Polly会按照以下逻辑工作：

1. 首次执行委托方法
2. 检查返回结果：
   • 如果结果为null或ReturnCode不为0，触发重试
   • 否则视为成功
3. 重试时：
   • 第一次重试立即执行
   • 第二次重试等待1秒
   • 后续重试每次等待5秒
4. 达到最大重试次数后仍未成功，则返回最后一次的结果

最佳实践建议

1. 合理设置重试次数：避免无限重试导致系统资源耗尽
2. 使用退避策略：如示例中的递增延迟，避免重试风暴
3. 记录重试事件：通过OnRetry回调记录重试信息，便于问题排查
4. 结合超时策略：如示例所示，为操作设置总超时时间
5. 资源清理：使用ResilienceContextPool管理上下文，提高性能

版本差异说明

Polly V8相比V7有显著变化：

1. 更简洁的API设计
2. 更好的性能
3. 更灵活的配置方式
4. 内置对异步操作的支持
5. 更完善的上下文管理

对于从V7迁移的用户，需要注意策略配置方式的差异，特别是结果处理从HandleResult方法变为PredicateBuilder的方式。

总结

Polly提供的基于返回结果的重试机制为处理复杂业务场景提供了强大支持。通过合理配置重试条件、次数和间隔，开发者可以构建出既健壮又高效的应用程序。本文展示的示例可以作为实现类似需求的起点，开发者应根据具体业务场景调整配置参数。