.NET 開源專案 Polly 介紹
今天介紹一個 .NET 開源庫:Polly,它是支援 .NET Core 的,目前在 GitHub 的 Star 數量已經接近 5 千,它是一個強大且實用的 .NET 庫。
Polly 介紹
官方對 Polly 的介紹是這樣的:
Polly is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner.
翻譯過來大概意思是:Polly 是一個 .NET 彈性和瞬態故障處理庫,允許開發人員以 Fluent 和執行緒安全的方式來實現重試、斷路、超時、隔離和回退策略。
這個描述有點抽象,我們一起來理解一下。
首先這裡的說的瞬態故障包含了程式發生的異常和出現不符合開發者預期的結果。所謂瞬態故障,就是說故障不是必然會發生的,而是偶然可能會發生的,比如網路偶爾會突然出現不穩定或無法訪問這種故障。至於彈性,就是指應對故障 Polly 的處理策略具有多樣性和靈活性,它的各種策略可以靈活地定義和組合。
下面來演示一個例子,大家就更清楚了。
故障處理策略示例
安慣例,建立一個空的 Console 專案,和安裝 NuGet 包:
Install-Package Polly
Polly 的異常處理策略的基本用法可以分為三個步驟,步驟說明包含在下面程式碼中:
static void Main(string[] args)
{
Policy
// 1. 指定要處理什麼異常
.Handle<HttpRequestException>()
// 或者指定需要處理什麼樣的錯誤返回
.OrResult<HttpResponseMessage>(r => r.StatusCode == HttpStatusCode.BadGateway)
// 2. 指定重試次數和重試策略
.Retry(3, (exception, retryCount, context) =>
{
Console.WriteLine($"開始第 {retryCount} 次重試:");
})
// 3. 執行具體任務
.Execute(ExecuteMockRequest);
Console.WriteLine("程式結束,按任意鍵退出。");
Console.ReadKey();
}
static HttpResponseMessage ExecuteMockRequest()
{
// 模擬網路請求
Console.WriteLine("正在執行網路請求...");
Thread.Sleep(3000);
// 模擬網路錯誤
return new HttpResponseMessage(HttpStatusCode.BadGateway);
}
從例子中可以看到,Polly 的 API 支援流式(Fluent)呼叫,使用起來很方便。這個示例對錯誤處理的策略很簡單,當發生請求異常或網路錯誤時,就重試 3 次。我們可以從下面的執行結果圖看到這個策略的執行過程:
下面具體來看 Polly 支援的各種故障處理策略。
Polly 的七種策略
Polly 可以實現重試、斷路、超時、隔離、回退和快取策略,下面給出這些策略的應用場景說明和基本使用方法。
重試(Retry)
出現故障自動重試,這個是很常見的場景,上面也已經給出例子了,這裡不再細述。
斷路(Circuit-breaker)
當系統遇到嚴重問題時,快速回饋失敗比讓使用者/呼叫者等待要好,限制系統出錯的體量,有助於系統恢復。比如,當我們去調一個第三方的 API,有很長一段時間 API 都沒有響應,可能對方伺服器癱瘓了。如果我們的系統還不停地重試,不僅會加重系統的負擔,還會可能導致系統其它任務受影響。所以,當系統出錯的次數超過了指定的閾值,就要中斷當前線路,等待一段時間後再繼續。
下面是一個基本的斷路策略的使用方式:
Policy.Handle<SomeException>()
.CircuitBreaker(2, TimeSpan.FromMinutes(1));
這句程式碼設定的策略是,當系統出現兩次某個異常時,就停下來,等待 1 分鐘後再繼續。這是基本的用法,你還可以在斷路時定義中斷的回撥和重啟的回撥。
超時(Timeout)
當系統超過一定時間的等待,我們就幾乎可以判斷不可能會有成功的結果。比如平時一個網路請求瞬間就完成了,如果有一次網路請求超過了 30 秒還沒完成,我們就知道這次大概率是不會返回成功的結果了。因此,我們需要設定系統的超時時間,避免系統長時間做無謂的等待。
下面是超時策略的一個基本用法:
Policy.Timeout(30, onTimeout: (context, timespan, task) =>
{
// do something
});
這裡設定了超時時間不能超過 30 秒,否則就認為是錯誤的結果,並執行回撥。
隔離(Bulkhead Isolation)
當系統的一處出現故障時,可能促發多個失敗的呼叫,很容易耗盡主機的資源(如 CPU)。下游系統出現故障可能導致上游的故障的呼叫,甚至可能蔓延到導致系統崩潰。所以要將可控的操作限制在一個固定大小的資源池中,以隔離有潛在可能相互影響的操作。
下面是隔離策略的一個基本用法:
Policy.Bulkhead(12, context =>
{
// do something
});
這個策略是最多允許 12 個執行緒併發執行,如果執行被拒絕,則執行回撥。
回退(Fallback)
有些錯誤無法避免,就要有備用的方案。這個就像瀏覽器不支援一些新的 CSS 特性就要額外引用一個 polyfill 一樣。一般情況,當無法避免的錯誤發生時,我們要有一個合理的返回來代替失敗。
比如很常見的一個場景是,當用戶沒有上傳頭像時,我們就給他一個預設頭像,這種策略可以這樣定義:
Policy.Handle<Whatever>()
.Fallback<UserAvatar>(() => UserAvatar.GetRandomAvatar())
快取(Cache)
一般我們會把頻繁使用且不會怎麼變化的資源快取起來,以提高系統的響應速度。如果不對快取資源的呼叫進行封裝,那麼我們呼叫的時候就要先判斷快取中有沒有這個資源,有的話就從快取返回,否則就從資源儲存的地方(比如資料庫)獲取後快取起來,再返回,而且有時還要考慮快取過期和如何更新快取的問題。Polly 提供了快取策略的支援,使得問題變得簡單。
var memoryCacheProvider = new MemoryCacheProvider(myMemoryCache);
var cachePolicy = Policy.Cache(memoryCacheProvider, TimeSpan.FromMinutes(5));
TResult result = cachePolicy.Execute(context => getFoo(), new Context("FooKey"));
這是官方的一個使用示例用法,它定義了快取 5 分鐘過期的策略,然後把這個策略應用在指定的 Key(即 FooKey
)上。
這一塊內容值得用一整篇的內容來講,下次有機會再詳細講講 Polly 的快取策略。
策略包(Policy Wrap)
一種操作會有多種不同的故障,而不同的故障處理需要不同的策略。這些不同的策略必須包在一起,作為一個策略包,才能應用在同一種操作上。這就是文章開頭說的 Polly 的彈性,即各種不同的策略能夠靈活地組合起來。
策略包的基本用法是這樣的:
var policyWrap = Policy
.Wrap(fallback, cache, retry, breaker, timeout, bulkhead);
policyWrap.Execute(...);
先是把預先定義好的多種不同的策略包在一起,作為一個整體策略,然後應用在同一個操作上。
總結
本文先是對 Polly 做了一個簡單介紹,通過一個例子讓大家知道了 Polly 的基本用法和步驟,然後分別介紹了 Polly 的七種策略。其實 Polly 遠比本文講的要強大,但由於篇幅的限制和精力有限,只能籠統地給大家做個介紹,更多的應用場景還需要結合實際的例子才能講清楚。要深入研究,可以前往檢視 Polly 的 GitHub 主頁和 Wiki 文件。
參考:
https://github.com/App-vNext/Polly
https://github.com/App-vNext/Polly/wiki