.NET Polly Essential

1
2
3
4
5
6
7
8

// 基本的 Retry Policy 就是這樣設定，Retry 的第一個參數表示發生 NullReferenceException 就讓它再打兩次
// 第二個參數表示每次 retry 前要呼叫的委派方法（這是個 Action 不用回傳值）
ISyncPolicy redoPolicy = Policy.Handle<NullReferenceException>()
                               .Retry(2,
                               (exception, count) =>
                               {
                                   Console.WriteLine($"NullReferenceException, exception:{exception.Message}, count:{count}");
                                });

1
2
3
4
5
6
7
8
9

// WairAndRetry 第一個參數跟 Retry 一樣都是表示要再打幾次
// 第二個參數則是個委派，表示要等待多久再打一次 （這是個 Func 需要回傳 Timespan 表示間隔時間）
// WaitAndRetry 的委派的第一個參數是目前已經 retry 的次數
ISyncPolicy redoPolicy = Policy.Handle<ApplicationException>()
                               .WaitAndRetry(2, retryDurationProvider =>
                               {
                                   Console.WriteLine($"ApplicationException, count:{retryDurationProvider}");
                                   return TimeSpan.FromSeconds(Math.Pow(2, retryDurationProvider));
                                });

1
2
3
4
5

// 將你要套用 Policy 的方法利用這個方式執行，這個方法可以接受 Func 跟 Action 兩種委派
redoPolicy.Execute(() =>
{
    // the method you want to execute
});

1
2
3
4
5

// 這段設定是說，若該呼叫觸發指定的 Exception 兩次的話，在 3 秒內的呼叫就直接返回該 Exception，並不會呼叫到該方法。
Policy.Handle<Exception>()
          .CircuitBreaker(
                exceptionsAllowedBeforeBreaking: 2,
                durationOfBreak: TimeSpan.FromSeconds(3))

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

Policy.Handle<Exception>()
      .AdvancedCircuitBreaker(
          // 這是說呼叫時有大於等於 50% 的機率發生捕捉的 Exception 發生時
          failureThreshold: 0.5,
          // 取樣的時間。這邊就是說 10 秒內發生捕捉 Exception 的機率大於等於 50% 時
          samplingDuration: TimeSpan.FromSeconds(10),
          // 斷路器要打開的另一個條件，在取樣時間內至少要有 8 次或以上的呼叫
          minimumThroughput: 8,
          // 設定要斷開連結多久
          durationOfBreak: TimeSpan.FromSeconds(10),
          onBreak: (exception, timespan) =>
          {
              /*
              這是當斷路器狀態為 CircuitState.Open 時會觸發的 function
              */
          },
          onReset: () =>
          {
              /*
              當呼叫 CircuitBreakerPolicy 的 Reset 方法時會觸發的方法。
              或是當斷路器的狀態從 Half Open 因為成功呼叫而自動恢復到 Closed 時會觸發。
              ps. Reset 方法是可以主動呼叫的
              */
          },
          onHalfOpen: () =>
          {
              /*
              這是當斷路器狀態為 CircuitState.HalfOpen 時會觸發的 function。
              斷路器的狀態會切到 Half Open 會發生在狀態已為 Open 但是已經過指定的時間（這邊就是 durationOfBreak 所指定的時間）時，當下一個 request 再來時，會將狀態切為 Half Open。
              */
          });

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

ISyncPolicy rule1 = Policy.Handle<ApplicationException>()
                          .Retry(1,
                          (exception, count) =>
                          {
                              Console.WriteLine($"ApplicationException, exception:{exception.Message}, count:{count}");
                          });
ISyncPolicy rule2 = Policy.Handle<InvalidOperationException>()
                          .CircuitBreaker(
                              exceptionsAllowedBeforeBreaking: 2,
                              durationOfBreak: TimeSpan.FromSeconds(3));

// Warp 參數接受任何有實做 ISyncPolicy 的物件，所以其實可以將上述的變數用 var 來宣告是可以的。
ISyncPolicy myPolicyWrap =
            Policy.Wrap(rule1,
                        rule2);

myPolicyWrap.Execute(
    () =>
    // do the work
    );