什麼是 Async/Await？

async 和 await 關鍵字用於在 C# 中定義異步方法。 異步方法在不阻塞應用程式主線程執行期間執行操作，讓應用程式即使在執行冗長的任務時也能保持反應迅速。

• async：此關鍵字應用於預期執行異步操作的方法。 表示該方法至少包含一個 await 表達式。
• 等待：此關鍵字用於暫停方法的執行，直到等待的任務完成為止。 在等待作業完成時，可確保線程能自由執行其他任務。

public async Task WaitExampleAsync()
{
    await Task.Delay(1000); // Waits for 1 second without blocking the thread
    Console.WriteLine("Finished waiting asynchronously!");
}

public async Task WaitExampleAsync()
{
    await Task.Delay(1000); // Waits for 1 second without blocking the thread
    Console.WriteLine("Finished waiting asynchronously!");
}

Public Async Function WaitExampleAsync() As Task
	Await Task.Delay(1000) ' Waits for 1 second without blocking the thread
	Console.WriteLine("Finished waiting asynchronously!")
End Function

Async 方法可以在等待任務完成時釋放主線程來處理其他作業，從而改善反應速度。

異步程式設計的主要優點

• 非阻塞操作：使用 async 程式設計，耗時的作業（例如檔案 I/O 或網路請求）不會阻塞主線程。 這對網路應用程式來說非常重要，因為非阻塞作業可確保伺服器能同時處理多個請求。
• Improved scalability：async 關鍵字允許應用程式使用較少的線程來處理更多的並發作業，從而改善可擴展性。
• 更好的使用者經驗：對於桌面或網頁應用程式而言，當任務在背景中執行時，同步作業可確保 UI 對使用者的輸入保持回應。

IronPdf 概述

IronPDF 允許 .NET 開發人員將 PDF 功能直接整合到他們的應用程式中，無論是用於網頁或桌面環境。 以下是 IronPDF 提供的一些主要功能：

• HTML 到 PDF 的轉換：IronPDF 可以將 HTML 內容（包括 CSS、圖片和 JavaScript）轉換成格式完整的 PDF。 這對於呈現動態網頁或 PDF 格式的報告尤其有用。
• PDF 編輯：使用 IronPDF，您可以透過新增文字、影像和圖形，以及編輯現有頁面的內容，來操作現有的 PDF 文件。
• 文字與圖像萃取：該函式庫可讓您從 PDF 中萃取文字和圖像，讓您輕鬆解析和分析 PDF 內容。
• Form Filling：IronPDF 支援在 PDF 中填寫 表單欄位，這對於產生客製化文件非常有用。
• 水印：也可以將水印新增至 PDF 文件，以進行品牌或版權保護。

為什麼使用 IronPDF 與 Async/Await？

雖然 IronPDF 本身不是異步的，但由於大多數 PDF 處理任務都具有 I/O 綁定的特性，因此非常適合使用異步/等待模式。 例如，將 HTML 轉換為 PDF 或載入大型 PDF 文件可能會花費大量時間，但這可以以異步方式完成，以避免阻塞主線程。

以下是 IronPDF 如何與 async 程式設計完美結合的幾個範例：

• PDF 生成：如果您的应用程序需要根据动态内容生成多个 PDF，异步运行这些进程可使系统在创建 PDF 时保持响应。
• PDF 處理：如果您需要修改大型 PDF，例如新增水印或合併文件，以異步方式執行這些工作可確保您的應用程式不會在這些耗時的作業在背景處理時擱置。
• 檔案 I/O：從 PDF 讀取和寫入 PDF 是一種 I/O 綁定的作業。 Async 程式設計非常適合這些工作，因為它可以釋放系統資源，避免不必要的阻塞。

基本範例：使用 IronPDF 進行異步 PDF 生成。

以下是使用 IronPDF 寫異步程式碼來產生 PDF 檔案的範例：

using IronPdf;

public class Program
{
    public static async Task Main(string[] args)
    {
        // Initialize renderer
        ChromePdfRenderer renderer = new ChromePdfRenderer();

        // Use Task.Run to run the PDF generation asynchronously
        PdfDocument pdf = await Task.Run(() => renderer.RenderHtmlAsPdf("<h1>Async PDF Example</h1>"));

        // Save the generated PDF to a file
        await Task.Run(() => pdf.SaveAs("output.pdf"));
    }
}

using IronPdf;

public class Program
{
    public static async Task Main(string[] args)
    {
        // Initialize renderer
        ChromePdfRenderer renderer = new ChromePdfRenderer();

        // Use Task.Run to run the PDF generation asynchronously
        PdfDocument pdf = await Task.Run(() => renderer.RenderHtmlAsPdf("<h1>Async PDF Example</h1>"));

        // Save the generated PDF to a file
        await Task.Run(() => pdf.SaveAs("output.pdf"));
    }
}

Imports IronPdf

Public Class Program
	Public Shared Async Function Main(ByVal args() As String) As Task
		' Initialize renderer
		Dim renderer As New ChromePdfRenderer()

		' Use Task.Run to run the PDF generation asynchronously
		Dim pdf As PdfDocument = Await Task.Run(Function() renderer.RenderHtmlAsPdf("<h1>Async PDF Example</h1>"))

		' Save the generated PDF to a file
		Await Task.Run(Function() pdf.SaveAs("output.pdf"))
	End Function
End Class

如何運作

1.Creating the HTML to PDF Converter： ChromePdfRenderer 類用於將 HTML 內容轉換為 PDF。 In this example, we pass simple HTML content as a string ("

Async PDF Example

2.Using Task.Run for Async PDF Generation： RenderHtmlAsPdf 方法預設不是 async，因此我們使用 Task.Run() 將 PDF 生成卸載到背景線程。 這一點非常重要，因為 PDF 生成可能會耗費大量資源和時間，尤其是在處理大型或複雜的文件時。

3.儲存 PDF： PDF 生成後，使用 pdf.SaveAs() 將其儲存到檔案系統。 此 I/O 操作也包裝在 Task.Run() 中，以確保在儲存檔案時不會阻塞主線程。

4.等待作業： await 關鍵字可確保每個異步操作在下一個操作開始之前完成。 在等待 PDF 生成完成時，主線程會保持自由以處理其他任務（例如，在 Web 應用程式中服務其他 HTTP 請求）。

使用 IronPDF 處理多重任務。

對於處理大型 PDF 的應用程式，您可能需要執行多種作業，例如分割、合併或新增內容至大型檔案。 使用 async 可確保在處理一個作業時，應用程式仍能回應使用者的輸入或要求。

舉例來說，您可以在管道中結合多個 async 作業：

using IronPdf;

public class Program
{
    public static async Task Main(string[] args)
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        PdfDocument page = renderer.RenderHtmlAsPdf("<h1>Added Page</h1>");

        // Use Task.Run to run the PDF generation asynchronously
        PdfDocument pdf = await Task.Run(() => PdfDocument.FromFile("output.pdf"));

        // Perform some operations asynchronously
        await Task.Run(() => pdf.ApplyWatermark("Confidential"));

        PdfDocument merged = await Task.Run(() => PdfDocument.Merge(pdf, page));
        await Task.Run(() => merged.SaveAs("processed_output.pdf"));
    }
}

using IronPdf;

public class Program
{
    public static async Task Main(string[] args)
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        PdfDocument page = renderer.RenderHtmlAsPdf("<h1>Added Page</h1>");

        // Use Task.Run to run the PDF generation asynchronously
        PdfDocument pdf = await Task.Run(() => PdfDocument.FromFile("output.pdf"));

        // Perform some operations asynchronously
        await Task.Run(() => pdf.ApplyWatermark("Confidential"));

        PdfDocument merged = await Task.Run(() => PdfDocument.Merge(pdf, page));
        await Task.Run(() => merged.SaveAs("processed_output.pdf"));
    }
}

Imports IronPdf

Public Class Program
	Public Shared Async Function Main(ByVal args() As String) As Task
		Dim renderer As New ChromePdfRenderer()
		Dim page As PdfDocument = renderer.RenderHtmlAsPdf("<h1>Added Page</h1>")

		' Use Task.Run to run the PDF generation asynchronously
		Dim pdf As PdfDocument = Await Task.Run(Function() PdfDocument.FromFile("output.pdf"))

		' Perform some operations asynchronously
		Await Task.Run(Function() pdf.ApplyWatermark("Confidential"))

		Dim merged As PdfDocument = Await Task.Run(Function() PdfDocument.Merge(pdf, page))
		Await Task.Run(Function() merged.SaveAs("processed_output.pdf"))
	End Function
End Class

在這個範例中，我們載入一個 PDF 檔案並建立新檔案、加入水印、將兩個 PDF 合併並儲存，這一切都不會阻塞主線程。

使用 IronPDF 進行異步操作的最佳實務。

• 線程池注意事項：由於 IronPDF 依賴背景線程進行處理，因此在使用 Task.Run() 時請注意線程池。 對於高頻任務，請考慮使用專屬的背景服務或將任務排成隊列，以避免線程池不堪負荷。
• 避免使用 async void 方法：對於執行異步操作的方法，請始終使用 async Task。 為事件處理程式保留 async void 方法。
• 取消代幣：對於 PDF 產生或文字萃取等長時間執行的作業，支援取消代幣是個好主意，讓使用者可以在需要時取消作業。 這可確保在不再需要這項作業時，能釋放資源。

public async Task GeneratePdfWithCancellationAsync(CancellationToken cancellationToken)
{
    ChromePdfRenderer renderer = new ChromePdfRenderer();
    var pdf = await Task.Run(() => renderer.RenderHtmlAsPdf("<h1>Async PDF with Cancellation</h1>"), cancellationToken);

    if (cancellationToken.IsCancellationRequested)
    {
        Console.WriteLine("Operation was canceled.");
        return;
    }
    pdf.SaveAs("output.pdf");
}

public async Task GeneratePdfWithCancellationAsync(CancellationToken cancellationToken)
{
    ChromePdfRenderer renderer = new ChromePdfRenderer();
    var pdf = await Task.Run(() => renderer.RenderHtmlAsPdf("<h1>Async PDF with Cancellation</h1>"), cancellationToken);

    if (cancellationToken.IsCancellationRequested)
    {
        Console.WriteLine("Operation was canceled.");
        return;
    }
    pdf.SaveAs("output.pdf");
}

Public Async Function GeneratePdfWithCancellationAsync(ByVal cancellationToken As CancellationToken) As Task
	Dim renderer As New ChromePdfRenderer()
	Dim pdf = Await Task.Run(Function() renderer.RenderHtmlAsPdf("<h1>Async PDF with Cancellation</h1>"), cancellationToken)

	If cancellationToken.IsCancellationRequested Then
		Console.WriteLine("Operation was canceled.")
		Return
	End If
	pdf.SaveAs("output.pdf")
End Function

• 錯誤處理：與任何同步作業一樣，確保針對 PDF 處理過程中可能發生的異常（例如檔案存取問題或無效輸入資料）進行正確的錯誤處理。

try
{
    var pdf = await Task.Run(() => renderer.RenderHtmlAsPdf("<h1>Async PDF</h1>"));
    pdf.SaveAs("output.pdf");
}
catch (Exception ex)
{
    Console.WriteLine($"Error: {ex.Message}");
}

try
{
    var pdf = await Task.Run(() => renderer.RenderHtmlAsPdf("<h1>Async PDF</h1>"));
    pdf.SaveAs("output.pdf");
}
catch (Exception ex)
{
    Console.WriteLine($"Error: {ex.Message}");
}

Try
	Dim pdf = Await Task.Run(Function() renderer.RenderHtmlAsPdf("<h1>Async PDF</h1>"))
	pdf.SaveAs("output.pdf")
Catch ex As Exception
	Console.WriteLine($"Error: {ex.Message}")
End Try