Polly

Polly

.NET应用程序的弹性和故障处理库

Polly是一个面向.NET的开源弹性库,提供了多种故障处理策略,如重试、断路器、超时等。它支持流畅的API设计和线程安全操作,可以轻松集成到应用中以增强系统稳定性。Polly还提供了依赖注入支持和详细文档,有助于开发者快速实现复杂的弹性模式。

Polly弹性策略.NET异常处理故障处理Github开源项目

Polly

Polly 是一个 .NET 弹性和瞬态故障处理库,允许开发人员以流畅和线程安全的方式表达重试、断路器、对冲、超时、速率限制和回退等弹性策略。

<img align="right" src="https://yellow-cdn.veclightyear.com/2b54e442/2e13d611-a415-46e1-bd3f-42cce4a39396.png" width="100" alt=".NET Foundation 标志" /> 我们是 .NET Foundation 的成员!

通过 www.thepollyproject.org 了解新功能公告、提示和技巧以及其他新闻

构建状态 代码覆盖率 OpenSSF 记分卡

<!-- markdownlint-disable MD042 -->

Polly 标志

<!-- markdownlint-enable MD034 -->

[!重要] 此文档描述了新的 Polly v8 API。如果您正在使用 v7 API,请参考之前版本的文档。

NuGet 包

包名最新版本说明
Polly.CoreNuGet核心抽象和内置策略
Polly.ExtensionsNuGet遥测依赖注入支持。
Polly.RateLimitingNuGetSystem.Threading.RateLimiting API 集成。
Polly.TestingNuGetPolly 库的测试支持
PollyNuGet此包包含 Polly 库 8 版本之前的旧版 API。

文档

本 README 旨在快速概述一些 Polly 功能 - 包括足够让您开始使用任何弹性策略的内容。要深入了解任何弹性策略以及 Polly 的许多其他方面,请务必查看 pollydocs.org

快速入门

要使用 Polly,您必须提供一个回调并使用弹性管道执行它。弹性管道是一个或多个弹性策略的组合,如重试、超时和速率限制器。Polly 使用构建器将这些策略集成到管道中。

要开始使用,首先通过运行以下命令将 Polly.Core 包添加到您的项目中:

dotnet add package Polly.Core

您可以使用 ResiliencePipelineBuilder 类创建 ResiliencePipeline,如下所示:

// 创建一个公开各种扩展以添加弹性策略的构建器实例 ResiliencePipeline pipeline = new ResiliencePipelineBuilder() .AddRetry(new RetryStrategyOptions()) // 使用默认选项添加重试 .AddTimeout(TimeSpan.FromSeconds(10)) // 添加 10 秒超时 .Build(); // 构建弹性管道 // 异步执行管道 await pipeline.ExecuteAsync(static async token => { /* 您的自定义逻辑放在这里 */ }, cancellationToken);

依赖注入

如果您更喜欢使用 IServiceCollection 定义弹性管道,您需要安装 Polly.Extensions 包:

dotnet add package Polly.Extensions

然后,您可以使用 AddResiliencePipeline(...) 扩展方法定义弹性管道,如下所示:

var services = new ServiceCollection(); // 使用名称 "my-pipeline" 定义弹性管道 services.AddResiliencePipeline("my-pipeline", builder => { builder .AddRetry(new RetryStrategyOptions()) .AddTimeout(TimeSpan.FromSeconds(10)); }); // 构建服务提供程序 var serviceProvider = services.BuildServiceProvider(); // 检索动态创建和缓存弹性管道的 ResiliencePipelineProvider var pipelineProvider = serviceProvider.GetRequiredService<ResiliencePipelineProvider<string>>(); // 使用注册时的名称检索弹性管道 ResiliencePipeline pipeline = pipelineProvider.GetPipeline("my-pipeline"); // 或者,您可以使用键控服务检索弹性管道 pipeline = serviceProvider.GetRequiredKeyedService<ResiliencePipeline>("my-pipeline"); // 执行管道 await pipeline.ExecuteAsync(static async token => { // 您的自定义逻辑放在这里 });

弹性策略

Polly 提供了多种弹性策略。除了每种策略的综合指南外,wiki 还包括每种策略在弹性工程中扮演角色的概述

Polly 将弹性策略分为两个主要组:

反应性

这些策略处理通过策略执行的回调抛出的特定异常,或返回的结果。

策略前提又称缓解
重试系列许多故障是暂时的,可能在短暂延迟后自行纠正。可能只是暂时的问题允许配置自动重试。
断路器系列当系统严重挣扎时,快速失败比让用户/调用者等待更好。 <br/><br/>保护故障系统免受过载可以帮助其恢复。如果它造成伤害就停止 <br/><br/>给系统一个休息当故障超过某个预配置的阈值时,断开电路(阻塞执行)一段时间。
回退事情仍会失败 - 计划在发生这种情况时该怎么办。优雅降级定义在失败时返回的替代值(或要执行的操作)。
对冲有时事情可能会很慢,计划在发生这种情况时该怎么办。对冲你的赌注当事情变慢时执行并行操作,并等待最快的一个。

主动性

与反应性策略不同,主动性策略不关注处理回调可能抛出或返回的错误。 它们可以主动决定取消或拒绝执行回调。

策略前提又称预防
超时超过某个等待时间,成功结果不太可能。不要永远等待保证调用者不会等待超过超时时间。
速率限制器限制系统处理请求的速率是控制负载的另一种方法。 <br/> <br/> 这可以应用于您的系统接受传入调用的方式,和/或您调用下游服务的方式。慢一点,好吗?限制执行不超过某个速率。

访问弹性策略文档,了解如何更详细地配置单个弹性策略。

重试

// 使用默认选项重试。 // 有关默认值,请参见 https://www.pollydocs.org/strategies/retry#defaults。 var optionsDefaults = new RetryStrategyOptions(); // 立即重试,无延迟 var optionsNoDelay = new RetryStrategyOptions { Delay = TimeSpan.Zero }; // 对重试行为进行高级控制,包括尝试次数、 // 重试之间的延迟以及要处理的异常类型。 var optionsComplex = new RetryStrategyOptions { ShouldHandle = new PredicateBuilder().Handle<SomeExceptionType>(), BackoffType = DelayBackoffType.Exponential, UseJitter = true, // 为延迟添加随机因素 MaxRetryAttempts = 4, Delay = TimeSpan.FromSeconds(3), }; // 使用自定义函数生成重试的延迟 var optionsDelayGenerator = new RetryStrategyOptions { MaxRetryAttempts = 2, DelayGenerator = static args => { var delay = args.AttemptNumber switch { 0 => TimeSpan.Zero, 1 => TimeSpan.FromSeconds(1), _ => TimeSpan.FromSeconds(5) }; // 此示例使用同步延迟生成器, // 但 API 也支持异步实现。 return new ValueTask<TimeSpan?>(delay); } }; // 从结果对象中提取延迟 var optionsExtractDelay = new RetryStrategyOptions<HttpResponseMessage> { DelayGenerator = static args => { if (args.Outcome.Result is HttpResponseMessage responseMessage && TryGetDelay(responseMessage, out TimeSpan delay)) { return new ValueTask<TimeSpan?>(delay); } // 返回 null 意味着重试策略将对此尝试使用其内部延迟。 return new ValueTask<TimeSpan?>((TimeSpan?)null); } }; // 在执行重试时获取通知 var optionsOnRetry = new RetryStrategyOptions { MaxRetryAttempts = 2, OnRetry = static args => { Console.WriteLine("OnRetry, Attempt: {0}", args.AttemptNumber); // 事件处理程序可以是异步的;这里我们返回一个空的 ValueTask。 return default; } }; // 要无限重试或直到成功,请使用 int.MaxValue。 var optionsIndefiniteRetry = new RetryStrategyOptions { MaxRetryAttempts = int.MaxValue, }; // 将带有 RetryStrategyOptions{<TResult>} 实例的重试策略添加到管道 new ResiliencePipelineBuilder().AddRetry(optionsDefaults); new ResiliencePipelineBuilder<HttpResponseMessage>().AddRetry(optionsExtractDelay);

如果所有重试都失败,重试策略会将最后的异常重新抛出给调用代码。

有关更多详细信息,请访问重试策略文档。

断路器

// 使用默认选项的断路器。 // 有关默认值,请参见 https://www.pollydocs.org/strategies/circuit-breaker#defaults。 var optionsDefaults = new CircuitBreakerStrategyOptions(); // 自定义选项的断路器: // 如果在任何 10 秒采样时间内,超过 50% 的操作导致处理的异常, // 且至少处理了 8 个操作,则电路将断开。 var optionsComplex = new CircuitBreakerStrategyOptions { FailureRatio = 0.5, Samp // 如果操作失败则使用动态生成的值。 var optionsFallbackAction = new FallbackStrategyOptions<UserAvatar> { ShouldHandle = new PredicateBuilder<UserAvatar>() .Handle<SomeExceptionType>() .HandleResult(r => r is null), FallbackAction = static args => { var avatar = UserAvatar.GetRandomAvatar(); return Outcome.FromResultAsValueTask(avatar); } }; // 使用默认或动态生成的值,并在触发后备时执行额外操作。 var optionsOnFallback = new FallbackStrategyOptions<UserAvatar> { ShouldHandle = new PredicateBuilder<UserAvatar>() .Handle<SomeExceptionType>() .HandleResult(r => r is null), FallbackAction = static args => { var avatar = UserAvatar.GetRandomAvatar(); return Outcome.FromResultAsValueTask(UserAvatar.Blank); }, OnFallback = static args => { // 添加在触发后备时要执行的额外逻辑,比如日志记录。 return default; // 返回一个空的ValueTask } }; // 将带有FallbackStrategyOptions<TResult>实例的后备策略添加到管道中 new ResiliencePipelineBuilder<UserAvatar>().AddFallback(optionsOnFallback);

更多详情,请访问后备策略文档。

对冲

// 使用默认选项的对冲。 // 查看 https://www.pollydocs.org/strategies/hedging#defaults 了解默认值。 var optionsDefaults = new HedgingStrategyOptions<HttpResponseMessage>(); // 一个自定义的对冲策略,如果执行时间超过1秒,或因异常失败,或返回HTTP 500内部服务器错误,最多重试3次。 var optionsComplex = new HedgingStrategyOptions<HttpResponseMessage> { ShouldHandle = new PredicateBuilder<HttpResponseMessage>() .Handle<SomeExceptionType>() .HandleResult(response => response.StatusCode == HttpStatusCode.InternalServerError), MaxHedgedAttempts = 3, Delay = TimeSpan.FromSeconds(1), ActionGenerator = static args => { Console.WriteLine("准备执行对冲操作。"); // 返回一个委托函数,用动作上下文调用原始动作。 // 您也可以选择创建一个全新的动作来执行。 return () => args.Callback(args.ActionContext); } }; // 订阅对冲事件。 var optionsOnHedging = new HedgingStrategyOptions<HttpResponseMessage> { OnHedging = static args => { Console.WriteLine($"OnHedging: 尝试次数 {args.AttemptNumber}"); return default; } }; // 将带有HedgingStrategyOptions<TResult>实例的对冲策略添加到管道中 new ResiliencePipelineBuilder<HttpResponseMessage>().AddHedging(optionsDefaults);

如果所有对冲尝试都失败,对冲策略将重新抛出原始异常或向调用者返回原始失败结果。

更多详情,请访问对冲策略文档。

超时

超时弹性策略假设您执行的委托支持协作取消。您必须使用接受CancellationTokenExecute/Async(...)重载,且执行的委托必须遵守该CancellationToken

// 添加具有自定义TimeSpan持续时间的超时 new ResiliencePipelineBuilder().AddTimeout(TimeSpan.FromSeconds(3)); // 使用默认选项的超时。 // 查看 https://www.pollydocs.org/strategies/timeout#defaults 了解默认值。 var optionsDefaults = new TimeoutStrategyOptions(); // 使用自定义超时生成器函数添加超时 var optionsTimeoutGenerator = new TimeoutStrategyOptions { TimeoutGenerator = static args => { // 注意:超时生成器支持异步操作 return new ValueTask<TimeSpan>(TimeSpan.FromSeconds(123)); } }; // 添加超时并监听超时事件 var optionsOnTimeout = new TimeoutStrategyOptions { TimeoutGenerator = static args => { // 注意:超时生成器支持异步操作 return new ValueTask<TimeSpan>(TimeSpan.FromSeconds(123)); }, OnTimeout = static args => { Console.WriteLine($"{args.Context.OperationKey}: 执行在 {args.Timeout.TotalSeconds} 秒后超时。"); return default; } }; // 将带有TimeoutStrategyOptions实例的超时策略添加到管道中 new ResiliencePipelineBuilder().AddTimeout(optionsDefaults);

超时策略在发生超时时抛出TimeoutRejectedException

更多详情,请访问超时策略文档。

速率限制器

// 添加具有默认选项的速率限制器。 // 查看 https://www.pollydocs.org/strategies/rate-limiter#defaults 了解默认值。 new ResiliencePipelineBuilder() .AddRateLimiter(new RateLimiterStrategyOptions()); // 创建一个速率限制器,允许最多100个并发执行和50的队列。 new ResiliencePipelineBuilder() .AddConcurrencyLimiter(100, 50); // 创建一个速率限制器,每分钟允许100次执行。 new ResiliencePipelineBuilder() .AddRateLimiter(new SlidingWindowRateLimiter( new SlidingWindowRateLimiterOptions { PermitLimit = 100, Window = TimeSpan.FromMinutes(1) }));

如果执行被拒绝,速率限制器策略会抛出RateLimiterRejectedException

更多详情,请访问速率限制器策略文档。

混沌工程

从版本8.3.0开始,Polly已将混沌工程库Simmy直接集成到其核心中。欲了解更多信息,请参阅专门的混沌工程文档

下一步

要了解更多关于Polly的信息,请访问pollydocs.org

示例

  • 示例:本仓库中作为Polly介绍的示例。
  • Polly-Samples:包含使用Polly各种实现的实际示例。请随时为Polly-Samples仓库做出贡献,以帮助那些初次学习Polly的人,或寻找由我们慷慨的社区提供的高级示例和新颖方法的人。
  • Microsoft的eShopOnContainers项目:演示.NET微服务架构并使用Polly进行弹性处理的示例项目。

赞助商

感谢以下公司赞助Polly的持续开发。

通过GitHub Sponsors成为赞助商来帮助支持这个项目。

许可证

根据New BSD License的条款许可

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多