什麼是Async/Await？

async和await關鍵字用於定義C#中的非同步方法。 非同步方法執行操作而不阻塞應用程式的主執行緒執行，允許應用程式在執行耗時任務時保持回應。

• async： 此關鍵字應用於預期需要執行非同步操作的方法。 它表示該方法至少包含一個await表達式。
• 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

非同步方法通過釋放主執行緒來處理其他操作，以提高回應性，並在等待任務完成時不造成阻塞。

非同步程式設計的主要優勢

• 非阻塞操作：通過非同步程式設計，耗時操作（如文件I/O或網路請求）不會阻塞主執行緒。 這對於網路應用程式至關重要，因為非阻塞操作確保伺服器可以同時處理多個請求。
• 提高可擴展性：async關鍵字使應用程式能夠使用更少的執行緒處理更多的併發操作，提高可擴展性。
• 更好的使用者體驗：對於桌面或網路應用程式，非同步操作可確保UI在背景中執行任務時對使用者輸入保持回應。

IronPDF概覽

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

• HTML轉PDF：IronPDF可以將HTML內容（包括CSS、圖像、JavaScript）轉換成格式完善的PDF。 這對於將動態網頁或報告渲染為PDF特別有用。
• PDF編輯：使用IronPDF，您可以透過新增文字、圖像和圖形來操作現有的PDF文件，以及編輯現有頁面的內容。
• 文字和圖像提取：該程式庫允許您從PDF中提取文字和圖像，使解析和分析PDF內容變得簡單。
• 表單填寫：IronPDF支持在PDF中填寫表單欄位，這對於生成自訂文件很有用。
• 加水印：您還可以為PDF文件新增水印，用於品牌或版權保護。

為什麼要將IronPDF與Async/Await一起使用？

雖然IronPDF本身不是原生的非同步工具，但由於大多數PDF處理任務都屬於I/O密集型，因此它非常適合用於async/await模式。 例如，將HTML轉換為PDF或載入大型PDF文件可能需要大量時間，但可以異步完成，以免阻塞主執行緒。

以下是一些IronPDF適用於非同步程式設計的範例：

• PDF生成：如果您的應用程式需要根據動態內容生成多個PDF，非同步運行這些過程可使系統在生成PDF時保持回應。
• PDF操作：如果需要修改大型PDF，如新增水印或合併文件，異步完成這些任務可確保您的應用程式不會因這些耗時操作造成卡頓。
• 文件I/O：讀取和寫入PDF是I/O-bound操作。 非同步程式設計非常適合這些任務，因為它可釋放系統資源並避免不必要的阻塞。

基本範例：使用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. 建立HTML到PDF轉換器： 使用ChromePdfRenderer類將HTML內容轉換為PDF。 In this example, we pass simple HTML content as a string ("

   Async PDF Example

   "), but in a real application, this could be dynamic HTML, such as a report template.

2. 使用Task.Run進行非同步PDF生成： Task.Run()將PDF生成分配到背景執行緒。 這一點很重要，因為PDF生成可能相當耗費資源和時間，特別是當涉及大型或複雜的文件時。

3. 保存PDF： PDF生成後，使用pdf.SaveAs()將其保存到文件系統。 這個I/O操作也被包裹在Task.Run()中，以確保在保存文件時不會阻塞主執行緒。

4. 等待操作： await關鍵字確保每個非同步操作在下一個操作開始前均已完成。 在等待PDF生成完成時，主執行緒仍然可以自由處理其他任務（例如，在網路應用中服務其他HTTP請求）。

使用IronPDF處理多個任務

對於需要處理大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"));
    }
}

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()時注意執行緒池。 對於高頻任務，考慮使用專用的背景服務或將任務排隊以避免過載執行緒池。
• 避免非同步void方法：對於執行非同步操作的方法，請始終使用async Task。 將非同步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