Polly Retry（開発者向けの動作方法）

Pollyのインストール

NuGetパッケージ マネージャー コンソールを使用して、以下のコマンドでPollyをインストールできます。

Install-Package Polly

.NET CLIを通じて：

dotnet add package Polly

Pollyのusingステートメントを追加

C#ファイルにPolly名前空間を含めてください。

using Polly;

using Polly;

指数バックオフ

指数バックオフは、要求と再試行の間の遅延が指数関数的に増加する人気のあるリトライ戦略です。 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() は、サーキットブレーカーとリトライポリシーを1つのポリシーにまとめます。

Polly RetryとIronPDF

IronPDFを使用する際には、外部ソースからデータを取得したり、PDFを生成する前に複雑な操作を行ったりする必要があるシナリオがあるかもしれません。

そのような場合、一時的な障害や一時的な問題によりPDF生成が失敗することがあります。 これらの一時的な障害をスムーズに処理するために、Polly RetryをIronPDFと組み合わせて使用できます。

IronPDFとPollyのインストール

始める前に、プロジェクトにIronPDFのNuGetパッケージをインストールしてください。

Install-Package IronPdf

Polly RetryをIronPDFと一緒に使用する

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#コードは、IronPDFを使用してPDFドキュメントを生成するリトライポリシーを実装するためのPollyライブラリの使用方法を示しています。 Mainメソッドは、PollyのWaitAndRetryAsyncメソッドを使用してリトライポリシーを初期化します。

このポリシーは、3回まで操作を再試行し、最初の試行と再試行の間に2秒の遅延を指定して、HttpRequestExceptionを処理するように指定します。 リトライ失敗が発生した場合、リトライ試行番号と例外メッセージを示すメッセージがコンソールに印刷されます。

Mainメソッド内では、retryPolicy.ExecuteAsync()を使用してリトライポリシーのロジックが非同期に実行されます。 この実行では、FetchDataFromExternalApiAsync()とGeneratePdfFromData(data)という2つの非同期操作が連鎖しています。

FetchDataFromExternalApiAsync()が失敗した場合（設定されているように、意図的に例外を発生させるため）、リトライポリシーはHttpRequestExceptionをキャッチし、リトライ試行を記録し、操作を再試行します。

FetchDataFromExternalApiAsync()メソッドは、外部APIからのデータ取得をシミュレートし、遅延を伴い、失敗したリクエストをシミュレートするために意図的にHttpRequestExceptionを投げるように設定されています。