什么是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或网络请求）不会阻塞主线程。 这对Web应用程序来说尤为重要，其中非阻塞操作可确保服务器能够同时处理多个请求。
• 改进的可扩展性：async关键字允许应用程序用更少的线程处理更多的并发操作，从而提高可扩展性。
• 更好的用户体验：对于桌面或Web应用程序，异步操作可确保在后台运行任务时，用户界面对用户输入保持响应。

IronPDF 概览

IronPDF允许.NET开发人员将PDF功能直接集成到他们的应用程序中，无论是Web环境还是桌面环境。 以下是IronPDF提供的一些关键特性：

• HTML到PDF转换：IronPDF可以将HTML内容（包括CSS、图像和JavaScript）转换为完全格式化的PDF。 这对于将动态网页或报告渲染为PDF特别有用。
• PDF编辑：使用IronPDF，您可以通过添加文本、图像和图形来操作现有PDF文档，以及编辑现有页面的内容。
• 文本和图片提取：该库允许您从PDF中提取文本和图像，使得分析PDF内容变得简单。
• 表单填写：IronPDF支持PDF中表单字段的填写，这对于生成定制化文档很有用。
• 水印添加：还可以在PDF文档上添加水印，用以品牌或版权保护。

为什么使用IronPDF配合Async/Await？

尽管IronPDF不是原生异步的，但它非常适合用于async/await模式，因为大多数PDF处理任务都是I/O密集型的。 例如，转换HTML为PDF或加载大型PDF文档可能需要相当多的时间，但可以通过异步方式来避免阻塞主线程。

以下是IronPDF与异步编程良好结合的几个示例：

• PDF生成：如果您的应用程序需要基于动态内容生成多个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"));
    }
}

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生成： RenderHtmlAsPdf方法默认情况下不是异步的，所以我们使用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"));
    }
}

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