什麼是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!");
}

非同步方法通過釋放主線程來處理其他操作，提高了響應性，當任務正在完成時。

非同步編程的關鍵好處

• 非阻塞操作: 使用非同步編程，耗時操作（如檔案 I/O 或網路請求）不會阻塞主線程。 這對網路應用至關重要，在這裡非阻塞操作確保伺服器能夠同時處理多個請求。
• 改進的可擴展性: async 關鍵字可讓應用程式以較少的線程處理更多並行操作，提高了可擴展性。
• 更佳使用者體驗: 對於桌面或網頁應用，非同步操作確保UI在背景任務運行時保持對使用者指令的響應。

IronPDF概述

IronPDF 讓.NET開發者得以將PDF功能直接整合到其應用程式中，不論是網頁還是桌面平台。 以下是IronPDF提供的一些關鍵功能：

• HTML到PDF轉換: IronPDF能將HTML內容（含樣式、圖像及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，如添加浮水印或合併文檔，進行修改，非同步執行這些任務可確保應用在處理耗時操作期間不會掛起。
• 檔案 I/O: 從PDF讀寫是一種I/O綁定操作。 非同步編程非常適合這些任務，因其釋放了系統資源並避免不必要的阻塞。

基本示例：使用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"));
    }
}

其運作原理

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生成完成時，主線程仍可處理其他任務（例如，在一個Web應用中處理其他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"));
    }
}

在此例中，我們載入一個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");
}

• 錯誤處理: 如同其他非同步操作一樣，確保對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}");
}