C# ConfigureAwait (開発者のための仕組み)

開発者として、非同期プログラミングは非常に有益であり、アプリケーションのパフォーマンス、効率、応答性を向上させることができます。 **ConfigureAwait(false)** を使用することで、特定の状況でデッドロックを回避することができます。 デッドロックは、デスクトップアプリケーションのUIスレッドのように、非同期プログラミングにおいて同期コンテキストが操作の完了を待ち受けて、それが完了するまで先に進むことができない場合に発生します。 それでも、待ち望まれているタスクは、同期コンテキストが利用可能になるのを待っており、循環待ちを生み出している。

今日は、ConfigureAwait を使用して、IronPDFと非同期プログラミングを通じて効率的にPDF処理タスクを実行する方法を検討します。 IronPDFはPDF関連の作業を簡単にする.NET PDFライブラリです。 堅牢な機能セット、強力なクロスプラットフォーム互換性、豊富なドキュメントを備えたこのツールは、開発者のツールキットに備えておくべき強力なPDFツールです。

C#で理解する非同期プログラミング；

非同期プログラミングとは？

非同期プログラミングとは、メインのアプリケーションスレッドから独立して特定の処理を実行できるようにするコードの記述方法を指します。 これは、I/O操作のような待機を必要とする長時間実行タスクに役立ちます。 メインスレッドをブロックすることなくこれらのタスクを実行できるようにすることで、これらのタスクの完了に時間がかかっている間もアプリケーションの実行を継続することができ、最終的にアプリケーションのパフォーマンスと応答性が向上します。

非同期コードにおけるConfigureAwaitの役割

ConfigureAwaitは、非同期プログラミングにおいて継続の実行方法を制御するために使用されるメソッドです。 継続処理は、await 式の後に実行されるコードです。デフォルトでは、**await** は現在のコンテキストをキャプチャし、そのコンテキストに継続処理を戻そうとしますが、これは非効率的である可能性があります。ConfigureAwait を使用すると、継続処理をキャプチャされたコンテキストで実行するかどうかを指定できます。これは、**ConfigureAwait(true)** と示されるか、または**ConfigureAwait(false)** として示されます。

`ConfigureAwait(false)` を使用するとデッドロックを回避するのに役立ちます。これは、使用する際に、現在の同期コンテキストをキャプチャしないこと、そして元のコンテキストで再開しようとしないことをタスクに指示しているためです。 これにより、元のコンテキストの代わりにスレッドプールのスレッドで続きが実行されるため、メインスレッドがブロックされるのを防ぐことができます。

`ConfigureAwait(false)` は、ライブラリコードや元のコンテキストに戻る必要がない場合に特に有用であり、その結果、コードの柔軟性を維持し、デッドロックを回避することができます。

IronPDFでのConfigureAwaitの使い方

.NETプロジェクトでのIronPDFのセットアップ

.NETプロジェクトでIronPDFを使用し始めるには、IronPDF NuGetパッケージをインストールしてください。 tools > NuGet Package Manager > NuGet Package Manager for Solutionに移動し、IronPDFを検索することで可能です：

あるいは、パッケージマネージャーコンソールで次のコマンドを実行してください：

Install-Package IronPdf

Install-Package IronPdf

'INSTANT VB TODO TASK: The following line uses invalid syntax:
'Install-Package IronPdf

コードでIronPDFの使用を開始するには、コードファイルの先頭に`using IronPdf`文を配置していることを確認してください。IronPDFを環境に設定するための詳細なガイドについては、その入門ページをご覧ください。

IronPDFを使って非同期にPDFを生成する

PDFファイルを非同期に生成することは、大量のPDFファイルを生成する必要がある場合や、複数の処理を同時に実行したい場合に特に有益です。 IronPDFを使うと、PDF関連のタスクを非同期で実行することができます：

using IronPdf;
using System.Threading.Tasks;
class program
{
    static async Task Main(string[] args)
    {
        await GeneratePdfAsync();
    }
    static async Task GeneratePdfAsync()
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        string htmlContent = "<h1>Hello World!</h1>";
        PdfDocument pdf = await renderer.RenderHtmlAsPdfAsync(htmlContent);
        await Task.Run(() => pdf.SaveAs("outputAsync.pdf"));
        Console.WriteLine("Working!");
    }
}

using IronPdf;
using System.Threading.Tasks;
class program
{
    static async Task Main(string[] args)
    {
        await GeneratePdfAsync();
    }
    static async Task GeneratePdfAsync()
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        string htmlContent = "<h1>Hello World!</h1>";
        PdfDocument pdf = await renderer.RenderHtmlAsPdfAsync(htmlContent);
        await Task.Run(() => pdf.SaveAs("outputAsync.pdf"));
        Console.WriteLine("Working!");
    }
}

Imports IronPdf
Imports System.Threading.Tasks
Friend Class program
	Shared Async Function Main(ByVal args() As String) As Task
		Await GeneratePdfAsync()
	End Function
	Private Shared Async Function GeneratePdfAsync() As Task
		Dim renderer As New ChromePdfRenderer()
		Dim htmlContent As String = "<h1>Hello World!</h1>"
		Dim pdf As PdfDocument = Await renderer.RenderHtmlAsPdfAsync(htmlContent)
		Await Task.Run(Function() pdf.SaveAs("outputAsync.pdf"))
		Console.WriteLine("Working!")
	End Function
End Class

このコードでは、GeneratePdfAsync() メソッドで非同期にPDFドキュメントを作成しました。 ChromePdfRenderer は、HTMLコンテンツからPDFファイルを作成する際に重要なレンダラーを作成するために使用されます。 PdfDocument クラスを使用して、提供されたHTML 文字列からPDFを作成します。ただし、HTMLファイル、URL、画像などからPDFを作成することもできます。 IronPDFを使用してPDFを生成するさまざまな方法について詳しくは、PDF生成に関するハウツーセクションをご覧ください。

大きなPDFファイルを非同期で扱う

大きなPDFファイルを扱う際に、`ConfigureAwait(false)`を使用した非同期メソッドは、長時間の操作中にメインスレッドを開放することで、パフォーマンスを大幅に向上させることができます。 この例では、大きなPDFドキュメントを取り上げ、テキスト抽出のタスクを実行し、非同期PDF処理がどれほど有益であるかを示します。

using IronPdf;
using System.Threading.Tasks;
using System.IO;
using System;
class Program
{
    static async Task Main(string[] args)
    {
        await LongPdfTask();
    }
    static async Task LongPdfTask()
    {
        try
        {
            // Initialize IronPDF's PdfDocument
            PdfDocument pdf = await Task.Run(() => PdfDocument.FromFile("Sample.pdf")).ConfigureAwait(false);
            // Extract text from PDF asynchronously
            string text = await Task.Run(() => pdf.ExtractAllText()).ConfigureAwait(false);
            // Write the extracted text to a file asynchronously
            await Task.Run(() => File.WriteAllText("extractedText.txt", text)).ConfigureAwait(false);
            Console.WriteLine("Extraction complete!");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error in GeneratePdfAsync: {ex.Message}");
        }
    }
}

using IronPdf;
using System.Threading.Tasks;
using System.IO;
using System;
class Program
{
    static async Task Main(string[] args)
    {
        await LongPdfTask();
    }
    static async Task LongPdfTask()
    {
        try
        {
            // Initialize IronPDF's PdfDocument
            PdfDocument pdf = await Task.Run(() => PdfDocument.FromFile("Sample.pdf")).ConfigureAwait(false);
            // Extract text from PDF asynchronously
            string text = await Task.Run(() => pdf.ExtractAllText()).ConfigureAwait(false);
            // Write the extracted text to a file asynchronously
            await Task.Run(() => File.WriteAllText("extractedText.txt", text)).ConfigureAwait(false);
            Console.WriteLine("Extraction complete!");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error in GeneratePdfAsync: {ex.Message}");
        }
    }
}

Imports IronPdf
Imports System.Threading.Tasks
Imports System.IO
Imports System
Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		Await LongPdfTask()
	End Function
	Private Shared Async Function LongPdfTask() As Task
		Try
			' Initialize IronPDF's PdfDocument
			Dim pdf As PdfDocument = Await Task.Run(Function() PdfDocument.FromFile("Sample.pdf")).ConfigureAwait(False)
			' Extract text from PDF asynchronously
			Dim text As String = Await Task.Run(Function() pdf.ExtractAllText()).ConfigureAwait(False)
			' Write the extracted text to a file asynchronously
			Await Task.Run(Sub() File.WriteAllText("extractedText.txt", text)).ConfigureAwait(False)
			Console.WriteLine("Extraction complete!")
		Catch ex As Exception
			Console.WriteLine($"Error in GeneratePdfAsync: {ex.Message}")
		End Try
	End Function
End Class

上記のコードでは、`ConfigureAwait(false)`は、200ページ以上にわたる大きなPDFファイルからすべてのテキストを抽出するという大規模で時間のかかるタスクを実行する際に使用されています。

• インポートとセットアップ： コードの最初のセクションは、必要なライブラリと名前空間をインポートするために設けられています。 IronPDFライブラリを使用するには、`using IronPdf`が必要です。
• クラスとメインメソッド: `class Program` は、このプロジェクトのメインアプリケーションコードを含むクラスを定義します。 `static async Task Main(string[] args)`はアプリケーションのエントリーポイントです。 ここでは、非同期操作をその中で実行できるようにするため、async としてマークしています。 次に、非同期でawait LongPdfTask()を使用してLongPdfTaskメソッドを呼び出します。

• Try ブロック: 予期しない例外を適切に処理するために、LongPdfTask メソッド内のコードを try-catch ブロックでラップしました。

  • PdfDocument PDF = await Task.Run(() => PdfDocument.FromFile("Sample.pdf")).ConfigureAwait(false): この行は3つの異なるセグメントに分解できます。

    • PdfDocument.FromFile("Sample.pdf"): このセクションは、指定されたPDFファイルをIronPdf.PdfDocumentオブジェクトに同期してロードします。

    • await Task.Run(() => ...): メインスレッドをブロックしないように、PDFの読み込み操作を別のスレッドで実行します。 そのため、非同期作業となります。
• .ConfigureAwait(false): 現在のコンテキストをキャプチャしないことで、パフォーマンスの向上とデッドロックの軽減が期待されます。
• string text = await Task.Run(() => pdf.ExtractAllText()).ConfigureAwait(false): これはIronPDFのテキスト抽出メソッド、ExtractAllText()を実行します。 再び、await Task.Run(() => ...) はこの操作を別のスレッドで非同期に実行するために使用されます。
• await Task.Run(() => File.WriteAllText("extractedText.txt", text)).ConfigureAwait(false): これにより、抽出したテキストをawait Taskメソッドを使用して非同期的に.txtファイルに書き込んでいます。

前

出力

.NETアプリケーションでConfigureAwaitを使用するためのベストプラクティス

ConfigureAwait(true)とConfigureAwait(false)の使い分け

ConfigureAwait(false) は、ライブラリコードやバックグラウンド処理で使用するのが最適で、この場合には同期コンテキストを保持する必要はありません。 一般的には、パフォーマンスが重要なサーバーサイドのコードが対象となります。 ConfigureAwait(false) を使用すると、await の操作が完了した後、継続処理が必ずしも非同期操作を開始したスレッド上では実行されないことを意味します。

PDF処理に関しては、複数のPDF処理タスクを実行する際にコンテキストスイッチングに関連したボトルネックを回避するために、ConfigureAwait(false)を実装することでパフォーマンスを最大化するのに役立ちます。 また、大量のPDFファイルを処理する際に、アプリケーションのスムーズな実行を維持したり、コンソールアプリケーションやバックグラウンドサービスで作業している場合、コンテキスト切り替えが不要になる可能性がある状況で、効率を維持するのに役立ちます。

ConfigureAwait(true) は、継続処理が同じコンテキストで実行されなければならないUI、コードの任意の単体テスト、またはASP.NETアプリケーションで最適に使用されます。ただし、誤って使用するとデッドロックを引き起こす可能性があります。 たとえば、UIを更新している場合や、httpcontextにアクセスしている場合です。 ConfigureAwait(true) はデフォルトの動作であり、単にConfigureAwaitと書くこともできます。

PDF処理タスクで使用する場合、特にPDF処理コードがUIと密接に統合されている状況（WPF、WinFormsなどのUIアプリケーションを使用する場合）で、進行状況を表示し、それらの更新がUIスレッドで発生するように同期コンテキストを取得する必要がある場合に非常に有益です。 また、スレッド親和性の要件により特定のスレッドで実行する必要がある、スレッドセンシティブな操作を扱う場合にも有益です。

非同期IronPDF操作における例外処理

非同期プログラミングにおける例外処理は、留意すべき重要な側面であり、慎重に考慮する必要があります。 非同期コードの周りにtry-catchブロックを使用することは、予期しない例外を潔く処理する素晴らしい方法です。

例えば：

public async Task SafeGeneratePdfAsync()
{
    try
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        PdfDocument pdf = await renderer.RenderHtmlAsPdfAsync("<h1>Error Handling</h1>").ConfigureAwait(false);
        await Task.Run(() => pdf.SaveAs("output.pdf")).ConfigureAwait(false);
    }
    catch (Exception ex)
    {
        Console.WriteLine($"An error occurred: {ex.Message}");
    }
}

public async Task SafeGeneratePdfAsync()
{
    try
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        PdfDocument pdf = await renderer.RenderHtmlAsPdfAsync("<h1>Error Handling</h1>").ConfigureAwait(false);
        await Task.Run(() => pdf.SaveAs("output.pdf")).ConfigureAwait(false);
    }
    catch (Exception ex)
    {
        Console.WriteLine($"An error occurred: {ex.Message}");
    }
}

Public Async Function SafeGeneratePdfAsync() As Task
	Try
		Dim renderer As New ChromePdfRenderer()
		Dim pdf As PdfDocument = Await renderer.RenderHtmlAsPdfAsync("<h1>Error Handling</h1>").ConfigureAwait(False)
		Await Task.Run(Function() pdf.SaveAs("output.pdf")).ConfigureAwait(False)
	Catch ex As Exception
		Console.WriteLine($"An error occurred: {ex.Message}")
	End Try
End Function

継続タスクで`ConfigureAwait(false)`を使用する場合、例外は継続内でtry-catchを使用して処理することができます。または、Task.ContinueWithを使用している場合、Task.Exceptionプロパティで処理することもできます。

このためのコードの書き方の例は、次のようになります：

class program
{
    public static async Task Main(string[] args)
    {
        await ProcessPdfWithContinuationAsync();
    }
    static Task ProcessPdfWithContinuationAsync()
    {
        return Task.Run(() => PdfDocument.FromFile("Sample.pdf"))
            .ContinueWith(pdfTask =>
            {
                if (pdfTask.IsFaulted)
                {
                    // Handle exceptions from loading the PDF
                    Console.WriteLine($"Error loading PDF: {pdfTask.Exception?.GetBaseException().Message}");
                    return;
                }
                var pdf = pdfTask.Result;
                // Extract text asynchronously with exception handling
                Task.Run(() => pdf.ExtractAllText())
                    .ContinueWith(extractTask =>
                    {
                        if (extractTask.IsFaulted)
                        {
                            // Handle exceptions from extracting text
                            Console.WriteLine($"Error extracting text: {extractTask.Exception?.GetBaseException().Message}");
                            return;
                        }
                        // Proceed if text extraction is successful
                        Console.WriteLine("Extracted text:");
                        Console.WriteLine(extractTask.Result);
                    }, TaskContinuationOptions.OnlyOnRanToCompletion);
            }, TaskContinuationOptions.OnlyOnRanToCompletion);
    }

class program
{
    public static async Task Main(string[] args)
    {
        await ProcessPdfWithContinuationAsync();
    }
    static Task ProcessPdfWithContinuationAsync()
    {
        return Task.Run(() => PdfDocument.FromFile("Sample.pdf"))
            .ContinueWith(pdfTask =>
            {
                if (pdfTask.IsFaulted)
                {
                    // Handle exceptions from loading the PDF
                    Console.WriteLine($"Error loading PDF: {pdfTask.Exception?.GetBaseException().Message}");
                    return;
                }
                var pdf = pdfTask.Result;
                // Extract text asynchronously with exception handling
                Task.Run(() => pdf.ExtractAllText())
                    .ContinueWith(extractTask =>
                    {
                        if (extractTask.IsFaulted)
                        {
                            // Handle exceptions from extracting text
                            Console.WriteLine($"Error extracting text: {extractTask.Exception?.GetBaseException().Message}");
                            return;
                        }
                        // Proceed if text extraction is successful
                        Console.WriteLine("Extracted text:");
                        Console.WriteLine(extractTask.Result);
                    }, TaskContinuationOptions.OnlyOnRanToCompletion);
            }, TaskContinuationOptions.OnlyOnRanToCompletion);
    }

Friend Class program
	Public Shared Async Function Main(ByVal args() As String) As Task
		Await ProcessPdfWithContinuationAsync()
	End Function
	Private Shared Function ProcessPdfWithContinuationAsync() As Task
		Return Task.Run(Function() PdfDocument.FromFile("Sample.pdf")).ContinueWith(Sub(pdfTask)
				If pdfTask.IsFaulted Then
					' Handle exceptions from loading the PDF
					Console.WriteLine($"Error loading PDF: {pdfTask.Exception?.GetBaseException().Message}")
					Return
				End If
				Dim pdf = pdfTask.Result
				' Extract text asynchronously with exception handling
				Task.Run(Function() pdf.ExtractAllText()).ContinueWith(Sub(extractTask)
						If extractTask.IsFaulted Then
							' Handle exceptions from extracting text
							Console.WriteLine($"Error extracting text: {extractTask.Exception?.GetBaseException().Message}")
							Return
						End If
						' Proceed if text extraction is successful
						Console.WriteLine("Extracted text:")
						Console.WriteLine(extractTask.Result)
				End Sub, TaskContinuationOptions.OnlyOnRanToCompletion)
		End Sub, TaskContinuationOptions.OnlyOnRanToCompletion)
	End Function

PDF処理のニーズにIronPDFを選ぶ理由

IronPDFの主な機能と利点

IronPDFは強力なC# PDFライブラリで、PDF関連のすべてのタスクに豊富な機能を提供します。 .NET 8、7、6、.NET Core、Standard、Frameworkをフルサポートし、Windows、Linux、Mac、Docker、Azure、AWSなどのさまざまなアプリ環境で実行できるため、どのような環境でもIronPdfを最大限に活用できます。

IronPDFを使用すると、さまざまなファイルやデータタイプからPDFを生成できます。これには、HTMLファイル、HTML文字列、URL、画像、DOCX、RTFが含まれ、通常はほんの数行のコードで実現できます！ PDFドキュメントのフォーマットを処理し、カスタム透かしを適用し、PDFの結合および分割を行い、PDFの暗号化およびセキュリティを扱うことができます。

IronPDFの非同期プログラミングのサポート

IronPDFは多くの処理に非同期メソッドを提供しており、開発者は非同期/待機パターンをシームレスに活用することができます。 このサポートにより、IronPDFは応答性を犠牲にすることなくパフォーマンスが重要なアプリケーションに統合でき、非同期環境でPDF関連のタスクに取り組む開発者にとって貴重なPDFツールとなります。

ライセンス

IronPDFを自分で試して、その広範な機能を探求したい場合は、無料トライアル期間を利用することで容易にできます。 素早く簡単にインストールできるIronPDFは、あなたのPDFプロジェクトですぐに稼働させることができます。IronPDFを使い続け、その強力な機能を活用してPDFのレベルアップを図りたいとお考えですか？ ライセンス はわずか $749 から始まり、30日間の返金保証、1年間の製品サポートとアップデートが付属し、永久ライセンスとして提供されます（面倒な定期的な料金はありません！）。

例PDF生成のためのConfigureAwaitとIronPDFの使い方

PDFを非同期に生成するには、IronPDFを使用してHTMLファイルをレンダリングするコードを実行し、結果を保存します。その際、ConfigureAwait(false)を使用して、継続処理が元の同期コンテキストに不必要に戻らないようにします。

using IronPdf;
using System.Threading.Tasks;
using System.IO;
using System;
class program
{
    public static async Task Main(string[] args)
    {
        await CreateInvoicePdfAsync();
    }
    static async Task<string> CreateInvoicePdfAsync()
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        try
        {
            var pdf = await renderer.RenderHtmlFileAsPdfAsync("example.html").ConfigureAwait(false);
            await Task.Run(() => pdf.SaveAs("invoice.pdf")).ConfigureAwait(false);
            return filePath;
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error generating PDF: {ex.Message}");
            return null;
        }
    }
}

using IronPdf;
using System.Threading.Tasks;
using System.IO;
using System;
class program
{
    public static async Task Main(string[] args)
    {
        await CreateInvoicePdfAsync();
    }
    static async Task<string> CreateInvoicePdfAsync()
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        try
        {
            var pdf = await renderer.RenderHtmlFileAsPdfAsync("example.html").ConfigureAwait(false);
            await Task.Run(() => pdf.SaveAs("invoice.pdf")).ConfigureAwait(false);
            return filePath;
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error generating PDF: {ex.Message}");
            return null;
        }
    }
}

Imports IronPdf
Imports System.Threading.Tasks
Imports System.IO
Imports System
Friend Class program
	Public Shared Async Function Main(ByVal args() As String) As Task
		Await CreateInvoicePdfAsync()
	End Function
	Private Shared Async Function CreateInvoicePdfAsync() As Task(Of String)
		Dim renderer As New ChromePdfRenderer()
		Try
			Dim pdf = Await renderer.RenderHtmlFileAsPdfAsync("example.html").ConfigureAwait(False)
			Await Task.Run(Function() pdf.SaveAs("invoice.pdf")).ConfigureAwait(False)
			Return filePath
		Catch ex As Exception
			Console.WriteLine($"Error generating PDF: {ex.Message}")
			Return Nothing
		End Try
	End Function
End Class

この例では、作成した非同期メソッドstatic async Task CreateInvoicePdfAsync()を使用して、RenderHtmlFileAsPdfAsyncメソッドによって提供されたHTMLファイルからPDF請求書を生成します。 このタスクの継続を元の同期コンテキストで行わないようにするために、ConfigureAwait(false)を使用しました。これにより、非UIアプリケーションのパフォーマンスが向上します。

また、操作を非同期で実行するためにawait Task.Run()) => ...)メソッドを再度実装しました。 最後に、新しく生成したPDFファイルをpdf.SaveAsメソッドを使用して「invoice.pdf」として保存しました。 CreateInvoicePdfAsync() メソッド内のコード全体は、予期しない例外を処理するために、try-catch ブロックでラップされています。

HTMLファイル

出力

ご覧のとおり、HTMLファイルを非同期でPDFに生成することに成功し、クリアで高品質なPDFファイルが作成されました。

結論

非同期プログラミングは、応答性が高く効率的な.NETアプリケーションを構築するために不可欠であり、ConfigureAwaitを正しく使用することで、特にアプリレベルのコードを書く際に最適なパフォーマンスを達成するのに役立ちます。 IronPDFを使用する際、非同期メソッドをConfigureAwait(false)と共に活用することで、PDF処理タスクがメインスレッドをブロックせず、アプリケーションの全体的な応答性を向上させます。 いつ、どのようにConfigureAwaitを使用するかを理解することにより、IronPDFによるPDF処理タスクをより堅牢でパフォーマンスに優しいものにすることができます。

今では、非同期プログラミングでConfigureAwaitとIronPDFを活用するプロとして前進することができます。さあ、何を待っていますか？ IronPDFを試して、PDF関連のプロジェクトをどのように改善できるかを確認してください！ IronPDFが提供する幅広い機能について、強力な汎用ライブラリコードとしてもっと知りたい場合は、その便利なハウツーガイドをぜひチェックしてください。 または、IronPDFを非同期プログラミングメソッドと一緒に使用する方法についてもっと知りたい場合や、IronPDFについて一般的にもっと学びたい場合は、ブログ投稿をご覧ください。 非同期のPDF生成の例をもっと探している場合は、C# Wait For Secondsの記事、またはC# Task.Runに関するもう一つの記事をご覧ください。