.NET Core Polly (開発者向けの仕組み)

Pollyのポリシー

一時的なフォルトは、アプリケーションがHTTPリクエスト、データベース、またはその他の外部リソースを通じてWebサービスに接続しようとする際に頻繁に発生します。 これらのフォルトは、ネットワーク障害、ネットワーク接続の一時的な問題、またはタイムアウトなど、短時間で自然治癒することが一般的です。

Pollyは、リトライポリシー、高度なサーキットブレーカポリシー、タイムアウトポリシー、フォールバックポリシー、およびバルクヘッド分離ポリシーなどの異なる戦略を適用して、これらの一時的なフォルトを管理します。

ポリシーの作成と設定

// Retry policy for handling HttpRequestException with exponential back-off
var retryPolicy = Policy
    .Handle<HttpRequestException>()
    .WaitAndRetryAsync(3, retryAttempt => TimeSpan.FromSeconds(Math.Pow(2, retryAttempt)), 
    (exception, timeSpan, retryCount, context) =>
    {
        // This is the OnRetry delegate, where you can log or monitor failed requests
        Console.WriteLine($"Retry {retryCount} after {timeSpan}. Exception: {exception.Message}");
    });

// Retry policy for handling HttpRequestException with exponential back-off
var retryPolicy = Policy
    .Handle<HttpRequestException>()
    .WaitAndRetryAsync(3, retryAttempt => TimeSpan.FromSeconds(Math.Pow(2, retryAttempt)), 
    (exception, timeSpan, retryCount, context) =>
    {
        // This is the OnRetry delegate, where you can log or monitor failed requests
        Console.WriteLine($"Retry {retryCount} after {timeSpan}. Exception: {exception.Message}");
    });

// Circuit breaker policy to handle failing requests with open and half-open states
var circuitBreakerPolicy = Policy
    .Handle<HttpRequestException>()
    .CircuitBreakerAsync(5, TimeSpan.FromMinutes(1));

// Circuit breaker policy to handle failing requests with open and half-open states
var circuitBreakerPolicy = Policy
    .Handle<HttpRequestException>()
    .CircuitBreakerAsync(5, TimeSpan.FromMinutes(1));

// Timeout policy with a 30-second optimistic timeout
var timeoutPolicy = Policy.TimeoutAsync(30); // 30 seconds

// Timeout policy with a 30-second optimistic timeout
var timeoutPolicy = Policy.TimeoutAsync(30); // 30 seconds

// Bulkhead isolation policy to limit concurrency and queue length
var bulkheadIsolationPolicy = Policy.BulkheadAsync(10, 20); // 10 concurrent actions, 20 queue slots

// Bulkhead isolation policy to limit concurrency and queue length
var bulkheadIsolationPolicy = Policy.BulkheadAsync(10, 20); // 10 concurrent actions, 20 queue slots

// Fallback policy to provide a default result on failure
var fallbackPolicy = Policy
    .Handle<Exception>()
    .FallbackAsync<FallbackResult>(
        FallbackResult.SomethingWentWrong, 
        (exception, context) => 
        {
            Console.WriteLine($"Fallback triggered due to: {exception.Message}");
            return Task.CompletedTask;
        });

// Fallback policy to provide a default result on failure
var fallbackPolicy = Policy
    .Handle<Exception>()
    .FallbackAsync<FallbackResult>(
        FallbackResult.SomethingWentWrong, 
        (exception, context) => 
        {
            Console.WriteLine($"Fallback triggered due to: {exception.Message}");
            return Task.CompletedTask;
        });

// Combining multiple policies using PolicyWrap
var policyWrap = Policy.WrapAsync(fallbackPolicy, retryPolicy, circuitBreakerPolicy, timeoutPolicy, bulkheadIsolationPolicy);

// Combining multiple policies using PolicyWrap
var policyWrap = Policy.WrapAsync(fallbackPolicy, retryPolicy, circuitBreakerPolicy, timeoutPolicy, bulkheadIsolationPolicy);

開始方法

PollyをIronPDFと一緒に使用するには、Visual Studioをインストールし、.NET Coreの新しいコンソールアプリケーションプロジェクトを作成してください。 Visual StudioでNuGetパッケージマネージャーコンソールを開き、PollyとIronPDFパッケージをインストールしてください:

Install-Package Polly

Install-Package IronPdf

Pollyを使ってIronPDFでURLをPDFに変換する

IronPDFの目立つ機能はそのHTML to PDF機能で、レイアウトとスタイルを維持します。 この機能はウェブコンテンツをPDFに変換し、報告書や請求書、文書化にも適しています。 HTMLファイル、URL、HTML文字列をPDFに変換することができます。

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

PollyとIronPDFを使用してURLをPDFに変換する例を見てみましょう。 一時的なフォルトにより時折失敗するWebサービスがあり、それらの失敗をPollyを使用して円滑に処理したいと仮定します。

まず、Program.cs ファイルに必要な名前空間をインポートします:

using System;
using System.Threading.Tasks;
using Polly;
using Polly.Wrap;
using IronPdf;

using System;
using System.Threading.Tasks;
using Polly;
using Polly.Wrap;
using IronPdf;

次に、ポリシーを定義します。 この例では、失敗を処理するためにリトライポリシーとサーキットブレーカポリシーの組み合わせを使用します:

// Retry policy with exponential backoff
var retryPolicy = Policy
    .Handle<Exception>()
    .WaitAndRetryAsync(3, i => TimeSpan.FromSeconds(2 * i));

// Circuit breaker policy to block requests after consecutive failures
var circuitBreakerPolicy = Policy
    .Handle<Exception>()
    .CircuitBreakerAsync(2, TimeSpan.FromSeconds(30));

// Retry policy with exponential backoff
var retryPolicy = Policy
    .Handle<Exception>()
    .WaitAndRetryAsync(3, i => TimeSpan.FromSeconds(2 * i));

// Circuit breaker policy to block requests after consecutive failures
var circuitBreakerPolicy = Policy
    .Handle<Exception>()
    .CircuitBreakerAsync(2, TimeSpan.FromSeconds(30));

retryPolicy は、指数関数的バックオフ戦略を使用して、失敗したリクエストを最大3回まで再試行し、リトライ間に2秒、4秒、8秒待機します。 circuitBreakerPolicy は、30秒間隔内で2回連続して失敗するとサーキットを開きます。

次にURLをPDFに変換するためのIronPDFコードを定義します:

var htmlToPdf = new ChromePdfRenderer();
var pdfBytes = await retryPolicy
    .WrapAsync(circuitBreakerPolicy)
    .ExecuteAsync(async () =>
    {
        Console.WriteLine("Attempting to convert URL to PDF...");
        var result = await htmlToPdf.RenderUrlAsPdfAsync("https://example.com");
        Console.WriteLine("Conversion successful!");
        return result;
    });

pdfBytes.SaveAs("output.pdf");

var htmlToPdf = new ChromePdfRenderer();
var pdfBytes = await retryPolicy
    .WrapAsync(circuitBreakerPolicy)
    .ExecuteAsync(async () =>
    {
        Console.WriteLine("Attempting to convert URL to PDF...");
        var result = await htmlToPdf.RenderUrlAsPdfAsync("https://example.com");
        Console.WriteLine("Conversion successful!");
        return result;
    });

pdfBytes.SaveAs("output.pdf");

この例のコードでは、retryPolicy と circuitBreakerPolicy を WrapAsync メソッドを使用して包んでいます。 これにより、新しいリクエストに複数のポリシーを順次適用することができます。 ExecuteAsync メソッドは、指定されたデリゲートを実行し、このコードではIronPDFからのRenderUrlAsPdfAsyncメソッドです。

Pollyポリシーを適用することで、コードが一時的なフォルトにレジリエントであることを保証します。 リクエストが失敗した場合、Pollyはリトライポリシーに従って自動的に再試行します。 連続した失敗数が事前設定された閾値を超えた場合、サーキットブレーカポリシーがサーキットを開き、指定された期間中の更なるリクエストを防ぎます。

Pollyポリシーのテストケース

Pollyポリシーの効果をテストするため、いくつかの失敗したリクエストをシミュレートします。 存在しないエンドポイントにURLを変更し、いくつかのテストケースを追加します:

var testUrls = new[]
{
    "https://ironpdf.com",
    "https://notexistingdomain.com/",
    "http://httpbin.org/delay/120"
};

foreach (var url in testUrls)
{
    try
    {
        var pdfBytes = await retryPolicy
            .WrapAsync(circuitBreakerPolicy)
            .ExecuteAsync(() => htmlToPdf.RenderUrlAsPdfAsync(url));

        pdfBytes.SaveAs($"{Guid.NewGuid()}.pdf");
        Console.WriteLine($"Successfully converted {url} to PDF.");
    }
    catch (Exception ex)
    {
        Console.WriteLine($"Failed to convert {url} to PDF: {ex.Message}");
    }
}

var testUrls = new[]
{
    "https://ironpdf.com",
    "https://notexistingdomain.com/",
    "http://httpbin.org/delay/120"
};

foreach (var url in testUrls)
{
    try
    {
        var pdfBytes = await retryPolicy
            .WrapAsync(circuitBreakerPolicy)
            .ExecuteAsync(() => htmlToPdf.RenderUrlAsPdfAsync(url));

        pdfBytes.SaveAs($"{Guid.NewGuid()}.pdf");
        Console.WriteLine($"Successfully converted {url} to PDF.");
    }
    catch (Exception ex)
    {
        Console.WriteLine($"Failed to convert {url} to PDF: {ex.Message}");
    }
}

上記のコードでは、一連のテストURLを繰り返し、それらの各々をPDFに変換しようとします。 リクエストが失敗した場合、例外がキャッチされ、コンソールに適切なメッセージが表示されます。

！.NET Core Polly(開発者向けの使い方): 図1 - URLのPDF出力

結論

Pollyは.NET Coreアプリケーションでレジリエンスと一時的なフォルトのハンドリングを実装するためのパワフルで柔軟なライブラリです。 リトライやサーキットブレーカといったポリシーを組み合わせることで、開発者は事態に優雅に失敗を処理するための堅牢で故障に耐性のあるシステムを構築できます。

このチュートリアルでは、Pollyを使ってIronPDFでURLをPDFに変換する方法を探りました。 リトライとサーキットブレーカを含むPollyポリシーの定義と適用方法を学びました。 異なるURLでポリシーのテストも行いました。 HTMLをPDFに変換する場合にも同様に行えます。

IronPDFは無料トライアルを提供しており、ライセンスは競争力のある価格でスタートし、プロジェクトにその能力を活用することができます。