WebApiClient中实现请求失败自动重试机制的最佳实践

在基于WebApiClient开发API客户端时，我们经常会遇到需要处理特定错误码并自动重试请求的场景。本文将深入探讨如何利用WebApiClient的特性实现这一功能。

核心需求分析

在实际业务中，常见的重试场景包括：

• 访问令牌(Token)过期时自动刷新并重试
• 服务端返回限流错误码时延迟重试
• 网络抖动导致的临时失败自动重试

解决方案架构

WebApiClient提供了完善的拦截器机制，我们可以通过实现IApiActionFilter接口来创建自定义的请求过滤器。以下是实现自动重试的核心步骤：

1. 创建重试过滤器：

public class RetryFilter : Attribute, IApiActionFilter
{
    public async Task OnRequestAsync(ApiRequestContext context)
    {
        // 请求前逻辑
    }

    public async Task OnResponseAsync(ApiResponseContext context)
    {
        if (NeedRetry(context))
        {
            // 执行重试逻辑
            await RetryRequestAsync(context);
        }
    }
}

2. 判断重试条件：

private bool NeedRetry(ApiResponseContext context)
{
    // 解析响应内容
    var json = context.ResponseMessage.Content.ReadAsStringAsync().Result;
    var result = JsonConvert.DeserializeObject<ApiResult>(json);
    
    // 检查错误码
    return result.Code == 401; // Token过期
}

3. 实现重试逻辑：

private async Task RetryRequestAsync(ApiResponseContext context)
{
    // 1. 刷新Token
    var newToken = await RefreshTokenAsync();
    
    // 2. 更新请求头
    context.HttpApiConfig.HttpClient.DefaultRequestHeaders
        .Authorization = new AuthenticationHeaderValue("Bearer", newToken);
    
    // 3. 重新发送请求
    var response = await context.HttpApiClient.SendAsync(
        context.ApiActionDescriptor, 
        context.HttpApiConfig, 
        context.RequestMessage);
    
    // 4. 更新响应上下文
    context.ResponseMessage = response;
}

高级配置选项

对于更复杂的场景，我们可以扩展重试策略：

1. 指数退避重试：

private async Task RetryWithBackoff(ApiResponseContext context, int retryCount)
{
    var delay = (int)Math.Pow(2, retryCount) * 100;
    await Task.Delay(delay);
    await RetryRequestAsync(context);
}

2. 最大重试次数限制：

[AttributeUsage(AttributeTargets.Method)]
public class RetryFilter : Attribute, IApiActionFilter
{
    public int MaxRetryCount { get; set; } = 3;
    
    // 在OnResponseAsync中使用计数器控制重试次数
}

实际应用示例

将重试过滤器应用到API接口：

public interface IUserApi : IHttpApi
{
    [HttpGet("/api/users")]
    [RetryFilter(MaxRetryCount = 3)]
    ITask<List<User>> GetUsersAsync();
}

最佳实践建议

1. 幂等性考虑：确保重试的操作是幂等的，避免重复提交导致数据不一致
2. 性能监控：记录重试次数和延迟时间，用于性能分析和优化
3. 熔断机制：当重试失败达到阈值时，应触发熔断避免系统雪崩
4. 差异化处理：根据不同的错误码采用不同的重试策略

通过以上实现，我们可以构建出健壮的API客户端，自动处理各种临时性故障，提升系统的稳定性和用户体验。