Polly Retry (How It Works For Developers)

安裝 Polly

您可以使用下列指令透過 NuGet 套件管理員控制台安裝 Polly：

Install-Package Polly

或透過 .NET CLI：

dotnet add package Polly

新增 Polly 使用語句

在您的 C# 檔案中，包含 Polly 命名空間：

using Polly;

using Polly;

Exponential Backoff

Exponential backoff 是一種流行的重試策略，其中請求與重試之間的延遲會以指數方式增加。 Polly 提供了一個方便的方法，使用 WaitAndRetry() 來實現指數回溯。

var retryPolicy = Policy
    .Handle<HttpRequestException>()
    .WaitAndRetry(
        retryCount: 3, // Max retry attempts
        sleepDurationProvider: attempt => TimeSpan.FromSeconds(Math.Pow(2, attempt)), // Exponential delay
        onRetry: (exception, timeSpan, retryCount, context) =>
        {
            Console.WriteLine($"Retry {retryCount} due to {exception.Message}");
        });

var retryPolicy = Policy
    .Handle<HttpRequestException>()
    .WaitAndRetry(
        retryCount: 3, // Max retry attempts
        sleepDurationProvider: attempt => TimeSpan.FromSeconds(Math.Pow(2, attempt)), // Exponential delay
        onRetry: (exception, timeSpan, retryCount, context) =>
        {
            Console.WriteLine($"Retry {retryCount} due to {exception.Message}");
        });

使用斷路器重試

將重試與斷路器結合，可以在服務持續失敗時防止重複重試，進而進一步提升彈性。 Polly 可讓您輕鬆結合重試與斷路策略。

// Define a circuit breaker policy
var circuitBreakerPolicy = Policy
    .Handle<HttpRequestException>()
    .CircuitBreaker(
        exceptionsAllowedBeforeBreaking: 3, // Number of exceptions before breaking
        durationOfBreak: TimeSpan.FromSeconds(30), // Time circuit stays open
        onBreak: (ex, breakDelay) =>
        {
            Console.WriteLine($"Circuit broken due to {ex.Message}. Retry after {breakDelay.TotalSeconds} seconds.");
        },
        onReset: () =>
        {
            Console.WriteLine("Circuit reset.");
        });

// Define a retry policy
var retryPolicy = Policy
    .Handle<HttpRequestException>()
    .WaitAndRetry(
        retryCount: 3, // Max retry attempts
        sleepDurationProvider: attempt => TimeSpan.FromSeconds(2), // Fixed retry delay
        onRetry: (exception, timeSpan, retryCount, context) =>
        {
            Console.WriteLine($"Retry {retryCount} due to {exception.Message}");
        });

// Combine both policies into a single policy wrap
var policyWrap = Policy.Wrap(circuitBreakerPolicy, retryPolicy);

// Define a circuit breaker policy
var circuitBreakerPolicy = Policy
    .Handle<HttpRequestException>()
    .CircuitBreaker(
        exceptionsAllowedBeforeBreaking: 3, // Number of exceptions before breaking
        durationOfBreak: TimeSpan.FromSeconds(30), // Time circuit stays open
        onBreak: (ex, breakDelay) =>
        {
            Console.WriteLine($"Circuit broken due to {ex.Message}. Retry after {breakDelay.TotalSeconds} seconds.");
        },
        onReset: () =>
        {
            Console.WriteLine("Circuit reset.");
        });

// Define a retry policy
var retryPolicy = Policy
    .Handle<HttpRequestException>()
    .WaitAndRetry(
        retryCount: 3, // Max retry attempts
        sleepDurationProvider: attempt => TimeSpan.FromSeconds(2), // Fixed retry delay
        onRetry: (exception, timeSpan, retryCount, context) =>
        {
            Console.WriteLine($"Retry {retryCount} due to {exception.Message}");
        });

// Combine both policies into a single policy wrap
var policyWrap = Policy.Wrap(circuitBreakerPolicy, retryPolicy);

在這個範例中

• CircuitBreaker()定義了一個斷路器原則，它會在 3 個異常之後斷開，並維持開啟 30 秒。
• Policy.Wrap()將斷路器和重試政策合併為單一政策。

使用 IronPdf 重試

在使用 IronPDF 時，可能會遇到需要從外部來源取得資料或在產生 PDF 之前執行複雜操作的情況。

在這種情況下，您可能會遇到可能導致 PDF 生成失敗的暫態故障或臨時問題。 要優雅地處理這些瞬間故障，您可以將 Polly Retry 與 IronPDF 配合使用。

安裝 IronPDF 和 Polly

在開始之前，請務必先在您的專案中安裝 IronPDF NuGet 套件。

Install-Package IronPdf

在 IronPDF 中使用 Polly Retry

讓我們來看看一個範例，在使用 IronPDF 產生 PDF 時，我們使用 Polly Retry 來處理暫態故障。 在以下範例中，我們將模擬從外部 API 取得資料，然後根據這些資料產生 PDF。 我們會使用 Polly Retry 來執行資料擷取作業，以防失敗。

using System;
using System.Net.Http;
using System.Threading.Tasks;
using IronPdf;
using Polly;

namespace IronPdfWithPollyRetry
{
    public class Program
    {
        public static async Task Main(string[] args)
        {
            // Define a retry policy with async capability
            var retryPolicy = Policy
                .Handle<HttpRequestException>() // Specify exception type to handle
                .WaitAndRetryAsync(
                    3, // Retry attempts
                    retryAttempt => TimeSpan.FromSeconds(2), // Calculated retry delay
                    (exception, timeSpan, retryCount, context) =>
                    {
                        Console.WriteLine("Retry " + retryCount + " due to " + exception.Message);
                    });

            // Execute the retry policy asynchronously
            var pdf = await retryPolicy.ExecuteAsync(async () =>
            {
                var data = await FetchDataFromExternalApiAsync(); // Fetch data from an external source
                return GeneratePdfFromData(data); // Generate PDF using fetched data
            });

            pdf.SaveAs("GeneratedDocument.pdf");
        }

        // Simulate fetching data from an external API
        static async Task<string> FetchDataFromExternalApiAsync()
        {
            await Task.Delay(100); // Simulate delay
            throw new HttpRequestException("Failed to fetch data from external API");
        }

        // Generate PDF using IronPDF based on the fetched data
        static PdfDocument GeneratePdfFromData(string data)
        {
            var htmlContent = "<html><body><h1>Data: " + data + "</h1></body></html>";
            var renderer = new ChromePdfRenderer();
            return renderer.RenderHtmlAsPdf(htmlContent);
        }
    }
}

using System;
using System.Net.Http;
using System.Threading.Tasks;
using IronPdf;
using Polly;

namespace IronPdfWithPollyRetry
{
    public class Program
    {
        public static async Task Main(string[] args)
        {
            // Define a retry policy with async capability
            var retryPolicy = Policy
                .Handle<HttpRequestException>() // Specify exception type to handle
                .WaitAndRetryAsync(
                    3, // Retry attempts
                    retryAttempt => TimeSpan.FromSeconds(2), // Calculated retry delay
                    (exception, timeSpan, retryCount, context) =>
                    {
                        Console.WriteLine("Retry " + retryCount + " due to " + exception.Message);
                    });

            // Execute the retry policy asynchronously
            var pdf = await retryPolicy.ExecuteAsync(async () =>
            {
                var data = await FetchDataFromExternalApiAsync(); // Fetch data from an external source
                return GeneratePdfFromData(data); // Generate PDF using fetched data
            });

            pdf.SaveAs("GeneratedDocument.pdf");
        }

        // Simulate fetching data from an external API
        static async Task<string> FetchDataFromExternalApiAsync()
        {
            await Task.Delay(100); // Simulate delay
            throw new HttpRequestException("Failed to fetch data from external API");
        }

        // Generate PDF using IronPDF based on the fetched data
        static PdfDocument GeneratePdfFromData(string data)
        {
            var htmlContent = "<html><body><h1>Data: " + data + "</h1></body></html>";
            var renderer = new ChromePdfRenderer();
            return renderer.RenderHtmlAsPdf(htmlContent);
        }
    }
}

此 C# 程式碼示範如何使用 Polly 函式庫與 IronPDF 實作重試政策，以產生 PDF 文件。 Main 方法使用 Polly 的 WaitAndRetryAsync 方法初始化重試原則。

此政策指定應處理 HttpRequestException 並重試操作最多 3 次，且初次嘗試與重試之間的延遲時間為 2 秒。 如果重試失敗，則會將訊息列印到控制台，指出重試嘗試的次數和異常訊息。

在 Main 方法中，重試原則邏輯會使用 retryPolicy.ExecuteAsync() 以異步方式執行。 在此執行中，兩個異步操作被串連在一起：FetchDataFromExternalApiAsync() 和 GeneratePdfFromData(data).

如果FetchDataFromExternalApiAsync()失敗（就像它故意設定的模擬異常一樣），重試原則會捕捉HttpRequestException，記錄重試嘗試，並重試操作。

FetchDataFromExternalApiAsync() 方法模擬在延遲的情況下從外部 API 取得資料，並故意拋出 HttpRequestException 以模擬失敗的請求。