如何使用 C# 异步和多线程生成 PDF

为什么要使用异步方法生成 PDF？

异步方法为 PDF 生成工作流提供了关键优势。 这些工具可在资源密集型操作过程中保持应用程序的响应速度，在多核处理器上提高资源利用率，并改善服务器环境的可扩展性。 在处理 复杂的 HTML 至 PDF 转换时，异步操作可防止超时问题并改善用户体验。

:path=/static-assets/pdf/content-code-examples/how-to/async-async.cs

using IronPdf;
using System.Threading.Tasks;

// Instantiate ChromePdfRenderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

string[] htmlStrings = {"<h1>Html 1</h1>", "<h1>Html 2</h1>", "<h1>Html 3</h1>"};

// Create an array to store the tasks for rendering
var renderingTasks = new Task<PdfDocument>[htmlStrings.Length];

for (int i = 0; i < htmlStrings.Length; i++)
{
    int index = i; // Capturing the loop variable
    renderingTasks[i] = Task.Run(async () =>
    {
        // Render HTML to PDF
        return await renderer.RenderHtmlAsPdfAsync(htmlStrings[index]);
    });
}

// Wait for all rendering tasks to complete
// await Task.WhenAll(renderingTasks);

批处理的常见模式有哪些？

批量处理 PDF 需要仔细考虑内存使用和性能。 有效的模式包括使用 Task.WhenAll 并行执行多个 PDF 生成，使用通道实现生产者-消费者模式以处理大批量数据，以及利用IronPDF文档中的并行处理示例。

// Batch processing with progress tracking
public async Task<List<PdfDocument>> ProcessBatchAsync(List<string> htmlContents, IProgress<int> progress)
{
    var renderer = new ChromePdfRenderer();
    var results = new List<PdfDocument>();
    var completed = 0;

    var tasks = htmlContents.Select(async html => {
        var pdf = await renderer.RenderHtmlAsPdfAsync(html);
        Interlocked.Increment(ref completed);
        progress?.Report(completed);
        return pdf;
    });

    results.AddRange(await Task.WhenAll(tasks));
    return results;
}

// Batch processing with progress tracking
public async Task<List<PdfDocument>> ProcessBatchAsync(List<string> htmlContents, IProgress<int> progress)
{
    var renderer = new ChromePdfRenderer();
    var results = new List<PdfDocument>();
    var completed = 0;

    var tasks = htmlContents.Select(async html => {
        var pdf = await renderer.RenderHtmlAsPdfAsync(html);
        Interlocked.Increment(ref completed);
        progress?.Report(completed);
        return pdf;
    });

    results.AddRange(await Task.WhenAll(tasks));
    return results;
}

如何处理异步 PDF 操作中的错误？

异步 PDF 操作中的错误处理需要全面的异常管理策略。 在异步方法中使用 try-catch 块，针对瞬时故障实施重试逻辑，并考虑使用 Polly 来实现高级重试策略。 对于详细的性能故障排除，IronPDF 提供了广泛的日志功能。

public async Task<PdfDocument> RenderWithRetryAsync(string html, int maxRetries = 3)
{
    var renderer = new ChromePdfRenderer();

    for (int i = 0; i < maxRetries; i++)
    {
        try
        {
            return await renderer.RenderHtmlAsPdfAsync(html);
        }
        catch (Exception ex) when (i < maxRetries - 1)
        {
            // Log the exception
            await Task.Delay(TimeSpan.FromSeconds(Math.Pow(2, i))); // Exponential backoff
        }
    }

    throw new InvalidOperationException("Failed to render PDF after maximum retries");
}

public async Task<PdfDocument> RenderWithRetryAsync(string html, int maxRetries = 3)
{
    var renderer = new ChromePdfRenderer();

    for (int i = 0; i < maxRetries; i++)
    {
        try
        {
            return await renderer.RenderHtmlAsPdfAsync(html);
        }
        catch (Exception ex) when (i < maxRetries - 1)
        {
            // Log the exception
            await Task.Delay(TimeSpan.FromSeconds(Math.Pow(2, i))); // Exponential backoff
        }
    }

    throw new InvalidOperationException("Failed to render PDF after maximum retries");
}

何时应选择多线程而非异步？

多线程非常适合需要在系统资源充足的情况下同时处理多个 PDF 的 CPU 绑定操作。 当在多核系统上处理大批量 PDF 时，当每个 PDF 生成都是独立的，当内存使用可以控制时，请选择多线程。 异步更适合 I/O 绑定操作和保持应用程序的响应速度。

线程安全注意事项有哪些？

IronPDF 的 ChromePdfRenderer 设计为线程安全，但仍需注意某些事项。 使用自定义设置时，为每个线程创建单独的渲染器实例；避免在线程之间共享 PdfDocument 实例而不进行同步；并监控并发处理大型文档时的内存消耗。 安装概述提供了有关配置 IronPDF 以优化线程安全的其他详细信息。

// Thread-safe PDF generation with custom settings per thread
public void ProcessPdfsInParallel(List<string> htmlContents)
{
    Parallel.ForEach(htmlContents, new ParallelOptions { MaxDegreeOfParallelism = Environment.ProcessorCount }, 
        html =>
        {
            // Create a new renderer instance for each thread
            var renderer = new ChromePdfRenderer
            {
                RenderingOptions = new ChromePdfRenderOptions
                {
                    MarginTop = 10,
                    MarginBottom = 10,
                    PaperSize = IronPdf.Rendering.PdfPaperSize.A4
                }
            };

            var pdf = renderer.RenderHtmlAsPdf(html);
            pdf.SaveAs($"output_{Thread.CurrentThread.ManagedThreadId}_{DateTime.Now.Ticks}.pdf");
        });
}

// Thread-safe PDF generation with custom settings per thread
public void ProcessPdfsInParallel(List<string> htmlContents)
{
    Parallel.ForEach(htmlContents, new ParallelOptions { MaxDegreeOfParallelism = Environment.ProcessorCount }, 
        html =>
        {
            // Create a new renderer instance for each thread
            var renderer = new ChromePdfRenderer
            {
                RenderingOptions = new ChromePdfRenderOptions
                {
                    MarginTop = 10,
                    MarginBottom = 10,
                    PaperSize = IronPdf.Rendering.PdfPaperSize.A4
                }
            };

            var pdf = renderer.RenderHtmlAsPdf(html);
            pdf.SaveAs($"output_{Thread.CurrentThread.ManagedThreadId}_{DateTime.Now.Ticks}.pdf");
        });
}

我应该使用多少并发线程？

并发线程的最佳数量取决于 CPU 内核、可用内存和 PDF 复杂性。 一般准则包括：对 CPU 密集型操作使用 Environment.ProcessorCount，对内存密集型 PDF 限制为 2-4 个线程，以及监控系统资源以找到最佳配置。 async示例演示了各种线程策略。

为什么异步比同步性能更好？

异步操作之所以出色，是因为它们可以实现高效的线程池资源管理，防止主线程阻塞，并在 I/O 操作过程中提高 CPU 的利用率。 性能的提高来自于同时启动多个渲染操作，而不是等待每个操作按顺序完成。

如何衡量应用程序的性能？

衡量 PDF 生成性能需要适当的基准测试和监控。 使用 System.Diagnostics.Stopwatch 进行精确的时间测量，实现自定义性能计数器以进行生产监控，并利用应用程序洞察或类似的 APM 工具。 考虑使用快速入门指南示例作为性能测试的基准。

public async Task<PerformanceMetrics> MeasurePerformanceAsync(string html, int iterations)
{
    var metrics = new PerformanceMetrics();
    var renderer = new ChromePdfRenderer();
    var stopwatch = new Stopwatch();

    // Warm-up run
    await renderer.RenderHtmlAsPdfAsync(html);

    for (int i = 0; i < iterations; i++)
    {
        stopwatch.Restart();
        await renderer.RenderHtmlAsPdfAsync(html);
        stopwatch.Stop();

        metrics.AddMeasurement(stopwatch.ElapsedMilliseconds);
    }

    return metrics;
}

public async Task<PerformanceMetrics> MeasurePerformanceAsync(string html, int iterations)
{
    var metrics = new PerformanceMetrics();
    var renderer = new ChromePdfRenderer();
    var stopwatch = new Stopwatch();

    // Warm-up run
    await renderer.RenderHtmlAsPdfAsync(html);

    for (int i = 0; i < iterations; i++)
    {
        stopwatch.Restart();
        await renderer.RenderHtmlAsPdfAsync(html);
        stopwatch.Stop();

        metrics.AddMeasurement(stopwatch.ElapsedMilliseconds);
    }

    return metrics;
}

影响 PDF 生成速度的因素有哪些？

影响 PDF 生成性能的因素有很多。 HTML 的复杂性，包括 JavaScript 的执行和 CSS 的渲染，会直接影响处理时间。外部资源加载（如图像和字体）也会造成延迟。 CPU、内存和磁盘 I/O 等系统资源起着至关重要的作用。 IronPDF 配置（包括渲染选项和引擎设置）也会影响速度。 了解这些因素有助于优化 PDF 生成工作流程，实现最高效率。

对于涉及大量 JavaScript 或延迟渲染的复杂场景，请考虑使用 WaitFor 机制，以确保在生成 PDF 之前完成页面渲染。 这种方法既能保证准确的输出，又能保持可预测的性能特征。