C# iText7与iTextSharp导出PDF对比

在现代Web应用程序开发中，PDF文档的生成与导出是一项常见且重要的功能。iText系列库作为功能强大的PDF处理工具，在.NET开发中被广泛应用。本文将深入探讨iText7与iTextSharp这两个版本的对比分析，并提供在C# WebApi中实现PDF导出的详细案例。

一、iText7与iTextSharp概述

1.1 基本概念

iTextSharp是iText库的.NET版本，是一个开源的PDF生成和操作库，主要针对.NET Framework开发。它是iText Java库的移植版本，为.NET开发者提供了丰富的PDF处理功能。

iText7则是iText的新一代产品，是一个完全重写的版本，提供了更现代的API设计和更强大的功能。它同样支持.NET平台，通过iText7 .NET组件包提供服务。

1.2 版本关系

• iTextSharp是iText 5.x的.NET版本

• iText7是全新的架构设计，不完全兼容iText 5.x

• iText7在Java和.NET平台上都有对应的实现，且API设计保持一致

二、iText7与iTextSharp对比分析

2.1 架构与API设计

特性	iTextSharp (iText 5.x)	iText7
命名空间	所有类都在iTextSharp.text命名空间下	采用模块化设计，使用多个命名空间如iText.Kernel、iText.Layout、iText.Html2Pdf等
API风格	传统的类设计，类之间耦合度较高	采用更现代的面向对象设计，更好的职责分离和组合模式
链式调用	部分支持	全面支持，使代码更简洁易读
文档模型	基于Document对象	引入PdfDocument和Document分离的概念，职责更清晰

2.2 性能与效率

• 内存管理：iText7采用了更现代的内存管理机制，对于处理大型文档时表现更佳

• 处理速度：在生成复杂PDF文档时，iText7通常比iTextSharp快20%-30%

• 资源占用：iText7对CPU和内存的使用更加高效

2.3 功能特性

• HTML到PDF转换 ：iText7提供了专门的html2pdf模块，转换质量和功能更加强大

• PDF/UA支持：iText7对PDF/UA（无障碍PDF标准）的支持更加完善

• PDF/A支持：两个版本都支持PDF/A（长期归档格式），但iText7提供了更丰富的验证和转换工具

• 数字签名：iText7增强了数字签名功能，支持更多的签名标准和算法

2.4 许可模式

• iTextSharp：基于AGPL开源许可，商业使用需要购买商业许可

• iText7：同样基于AGPL开源许可，商业使用需要购买商业许可，但提供了更灵活的许可选项

2.5 社区支持与维护

• iTextSharp：官方已不再积极维护，仅提供基本的bug修复

• iText7：官方积极更新和维护，持续添加新功能和性能改进

• 文档资源：iText7提供了更全面的文档和示例代码

三、C# WebApi中使用iTextSharp导出PDF

3.1 安装iTextSharp

在WebApi项目中，通过NuGet安装iTextSharp：

Install-Package iTextSharp

3.2 基本PDF生成示例

以下是一个使用iTextSharp在WebApi中生成PDF文档的基本示例：

using iTextSharp.text;
using iTextSharp.text.pdf;
using System.IO;
using System.Net.Http;
using System.Web.Http;
​
public class PdfController : ApiController
{
    [HttpGet]
    [Route("api/pdf/basic")]
    public HttpResponseMessage GenerateBasicPdf()
    {
        // 创建文档对象
        Document document = new Document();
        
        // 创建内存流作为PDF输出目标
        MemoryStream memoryStream = new MemoryStream();
        
        try
        {
            // 创建PDF写入器
            PdfWriter writer = PdfWriter.GetInstance(document, memoryStream);
            
            // 打开文档
            document.Open();
            
            // 添加内容
            document.Add(new Paragraph("Hello, iTextSharp World!"));
            document.Add(new Paragraph("This is a basic PDF generated by iTextSharp in a WebApi application."));
            
            // 添加标题
            document.Add(new Paragraph("PDF Generation Demo", new Font(Font.FontFamily.HELVETICA, 16, Font.BOLD)));
            
            // 添加表格
            PdfPTable table = new PdfPTable(3);
            table.WidthPercentage = 100;
            
            // 添加表头
            table.AddCell(new PdfPCell(new Phrase("ID")) { BackgroundColor = BaseColor.LIGHT_GRAY });
            table.AddCell(new PdfPCell(new Phrase("Name")) { BackgroundColor = BaseColor.LIGHT_GRAY });
            table.AddCell(new PdfPCell(new Phrase("Value")) { BackgroundColor = BaseColor.LIGHT_GRAY });
            
            // 添加数据行
            table.AddCell("1");
            table.AddCell("Item 1");
            table.AddCell("100");
            
            table.AddCell("2");
            table.AddCell("Item 2");
            table.AddCell("200");
            
            document.Add(table);
        }
        catch (DocumentException de)
        {
            // 处理文档异常
            return Request.CreateErrorResponse(System.Net.HttpStatusCode.InternalServerError, de.Message);
        }
        finally
        {
            // 确保文档关闭
            if (document.IsOpen())
            {
                document.Close();
            }
        }
        
        // 准备HTTP响应
        HttpResponseMessage response = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
        {
            Content = new ByteArrayContent(memoryStream.ToArray())
        };
        
        // 设置内容类型
        response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/pdf");
        
        // 设置下载文件名
        response.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment")
        {
            FileName = "basic_report.pdf"
        };
        
        return response;
    }
}

3.3 高级功能示例 - 添加图片和样式

[HttpGet]
[Route("api/pdf/advanced")]
public HttpResponseMessage GenerateAdvancedPdf()
{
    Document document = new Document();
    MemoryStream memoryStream = new MemoryStream();
    
    try
    {
        PdfWriter writer = PdfWriter.GetInstance(document, memoryStream);
        document.Open();
        
        // 设置页面边距
        document.SetMargins(50, 50, 50, 50);
        
        // 添加标题
        Paragraph title = new Paragraph("Advanced PDF Report", new Font(Font.FontFamily.TIMES_ROMAN, 20, Font.BOLD | Font.UNDERLINE));
        title.Alignment = Element.ALIGN_CENTER;
        document.Add(title);
        
        // 添加空行
        document.Add(new Paragraph(" "));
        
        // 添加图片（假设有一个图片资源）
        try
        {
            // 获取图片路径（这里假设在项目根目录下有images文件夹）
            string imagePath = HttpContext.Current.Server.MapPath("~/images/logo.png");
            if (File.Exists(imagePath))
            {
                Image logo = Image.GetInstance(imagePath);
                logo.ScaleToFit(100, 100);
                logo.Alignment = Element.ALIGN_RIGHT;
                document.Add(logo);
            }
        }
        catch { /* 图片加载失败时继续执行 */ }
        
        // 添加段落
        Paragraph paragraph = new Paragraph();
        paragraph.Add(new Chunk("This is a sample paragraph with "));
        paragraph.Add(new Chunk("bold text", new Font(Font.FontFamily.HELVETICA, 12, Font.BOLD)));
        paragraph.Add(new Chunk(" and "));
        paragraph.Add(new Chunk("italic text", new Font(Font.FontFamily.HELVETICA, 12, Font.ITALIC)));
        paragraph.Add(new Chunk(". This demonstrates text styling capabilities."));
        document.Add(paragraph);
        
        // 添加列表
        List list = new List(List.UNORDERED);
        list.Add(new ListItem("First item in the list"));
        list.Add(new ListItem("Second item in the list"));
        list.Add(new ListItem("Third item in the list"));
        document.Add(list);
        
        // 添加页脚
        Phrase footer = new Phrase("Generated by iTextSharp in WebApi", new Font(Font.FontFamily.HELVETICA, 8));
        ColumnText.ShowTextAligned(writer.DirectContent, Element.ALIGN_CENTER, footer,
            (document.PageSize.GetRight() - document.PageSize.GetLeft()) / 2, document.PageSize.GetBottom() + 10, 0);
    }
    catch (Exception ex)
    {
        return Request.CreateErrorResponse(System.Net.HttpStatusCode.InternalServerError, ex.Message);
    }
    finally
    {
        if (document.IsOpen())
        {
            document.Close();
        }
    }
    
    // 返回PDF文件
    HttpResponseMessage response = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
    {
        Content = new ByteArrayContent(memoryStream.ToArray())
    };
    response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/pdf");
    response.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment")
    {
        FileName = "advanced_report.pdf"
    };
    
    return response;
}

四、C# WebApi中使用iText7导出PDF

4.1 安装iText7

在WebApi项目中，通过NuGet安装iText7的相关包：

Install-Package itext7
Install-Package itext7.bouncy-castle-adapter

如果需要HTML转PDF功能，还需要安装：

Install-Package itext7.html2pdf

4.2 基本PDF生成示例

以下是使用iText7在WebApi中生成PDF文档的基本示例：

using iText.Kernel.Pdf;
using iText.Layout;
using iText.Layout.Element;
using iText.Layout.Properties;
using System.IO;
using System.Net.Http;
using System.Web.Http;
​
public class PdfController : ApiController
{
    [HttpGet]
    [Route("api/pdf7/basic")]
    public HttpResponseMessage GenerateBasicPdfWithIText7()
    {
        // 创建内存流
        MemoryStream memoryStream = new MemoryStream();
        
        try
        {
            // 创建PDF文档对象
            PdfDocument pdfDoc = new PdfDocument(new PdfWriter(memoryStream));
            
            // 创建文档对象（布局管理器）
            Document document = new Document(pdfDoc);
            
            // 添加内容
            document.Add(new Paragraph("Hello, iText7 World!")
                .SetFontSize(12));
            
            document.Add(new Paragraph("This is a basic PDF generated by iText7 in a WebApi application.")
                .SetFontSize(12)
                .SetMarginTop(10));
            
            // 添加标题
            document.Add(new Paragraph("PDF Generation Demo with iText7")
                .SetFontSize(16)
                .SetBold()
                .SetTextAlignment(TextAlignment.CENTER)
                .SetMarginTop(20));
            
            // 添加表格
            Table table = new Table(3)
                .UseAllAvailableWidth();
            
            // 添加表头
            table.AddHeaderCell(new Cell().Add(new Paragraph("ID").SetBold())
                .SetBackgroundColor(ColorConstants.LIGHT_GRAY));
            table.AddHeaderCell(new Cell().Add(new Paragraph("Name").SetBold())
                .SetBackgroundColor(ColorConstants.LIGHT_GRAY));
            table.AddHeaderCell(new Cell().Add(new Paragraph("Value").SetBold())
                .SetBackgroundColor(ColorConstants.LIGHT_GRAY));
            
            // 添加数据行
            table.AddCell("1");
            table.AddCell("Item 1");
            table.AddCell("100");
            
            table.AddCell("2");
            table.AddCell("Item 2");
            table.AddCell("200");
            
            document.Add(table);
            
            // 关闭文档
            document.Close();
        }
        catch (Exception ex)
        {
            return Request.CreateErrorResponse(System.Net.HttpStatusCode.InternalServerError, ex.Message);
        }
        
        // 准备HTTP响应
        HttpResponseMessage response = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
        {
            Content = new ByteArrayContent(memoryStream.ToArray())
        };
        
        // 设置内容类型
        response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/pdf");
        
        // 设置下载文件名
        response.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment")
        {
            FileName = "basic_report_itext7.pdf"
        };
        
        return response;
    }
}

4.3 HTML转PDF示例

iText7的一个强大功能是能够直接将HTML转换为PDF，以下是一个示例：

using iText.Html2pdf;
using System.IO;
using System.Net.Http;
using System.Text;
using System.Web.Http;
​
[HttpPost]
[Route("api/pdf7/htmltopdf")]
public HttpResponseMessage ConvertHtmlToPdf([FromBody] string htmlContent)
{
    // 创建内存流
    MemoryStream memoryStream = new MemoryStream();
    
    try
    {
        // 如果没有提供HTML内容，使用默认内容
        if (string.IsNullOrEmpty(htmlContent))
        {
            htmlContent = @"<html>
            <head>
                <style>
                    body { font-family: Arial, sans-serif; }
                    h1 { color: #333366; }
                    table { border-collapse: collapse; width: 100%; }
                    th, td { border: 1px solid #ddd; padding: 8px; text-align: left; }
                    th { background-color: #f2f2f2; }
                </style>
            </head>
            <body>
                <h1>HTML to PDF Conversion</h1>
                <p>This PDF was generated from HTML content using iText7 html2pdf.</p>
                <table>
                    <tr>
                        <th>Product</th>
                        <th>Price</th>
                        <th>Quantity</th>
                    </tr>
                    <tr>
                        <td>Product 1</td>
                        <td>$10.00</td>
                        <td>5</td>
                    </tr>
                    <tr>
                        <td>Product 2</td>
                        <td>$20.00</td>
                        <td>3</td>
                    </tr>
                </table>
            </body>
            </html>";
        }
        
        // 使用HtmlConverter将HTML转换为PDF
        HtmlConverter.ConvertToPdf(new MemoryStream(Encoding.UTF8.GetBytes(htmlContent)), memoryStream);
        
        // 重置内存流位置
        memoryStream.Position = 0;
    }
    catch (Exception ex)
    {
        return Request.CreateErrorResponse(System.Net.HttpStatusCode.InternalServerError, ex.Message);
    }
    
    // 准备HTTP响应
    HttpResponseMessage response = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
    {
        Content = new ByteArrayContent(memoryStream.ToArray())
    };
    
    // 设置内容类型和文件名
    response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/pdf");
    response.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment")
    {
        FileName = "html_converted.pdf"
    };
    
    return response;
}

五、最佳实践与性能优化

5.1 内存管理

• 使用MemoryStream：避免写入磁盘，直接在内存中生成PDF

• 及时释放资源：使用using语句确保所有对象正确释放

• 大文件处理：对于大型PDF，考虑使用流式处理而非一次性加载

5.2 性能优化技巧

// iText7性能优化示例
public HttpResponseMessage GenerateOptimizedPdf()
{
    MemoryStream memoryStream = new MemoryStream();
    
    try
    {
        // 配置写入器参数以优化性能
        PdfWriter writer = new PdfWriter(memoryStream, new WriterProperties()
            .SetCompressionLevel(CompressionConstants.BEST_COMPRESSION)
            .SetFullCompressionMode(true));
        
        PdfDocument pdfDoc = new PdfDocument(writer);
        Document document = new Document(pdfDoc);
        
        // 禁用自动关闭以允许手动控制资源
        document.SetCloseAutoFlush(false);
        
        // 批量添加内容
        for (int i = 0; i < 100; i++)
        {
            document.Add(new Paragraph($"Item {i + 1}"));
            
            // 每20项刷新一次，避免内存占用过大
            if (i % 20 == 0)
            {
                document.Flush();
            }
        }
        
        document.Close();
    }
    catch (Exception ex)
    {
        return Request.CreateErrorResponse(System.Net.HttpStatusCode.InternalServerError, ex.Message);
    }
    
    // 返回PDF文件...
    HttpResponseMessage response = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
    {
        Content = new ByteArrayContent(memoryStream.ToArray())
    };
    response.Content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/pdf");
    response.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment")
    {
        FileName = "optimized_report.pdf"
    };
    
    return response;
}

5.3 异常处理与日志记录

在WebApi中生成PDF时，完善的异常处理和日志记录至关重要：

[HttpGet]
[Route("api/pdf/errorhandling")]
public HttpResponseMessage GeneratePdfWithErrorHandling()
{
    MemoryStream memoryStream = new MemoryStream();
    
    try
    {
        // PDF生成代码...
        // ...
        
        return new HttpResponseMessage(System.Net.HttpStatusCode.OK)
        {
            Content = new ByteArrayContent(memoryStream.ToArray())
        };
    }
    catch (DocumentException de)
    {
        // 记录文档特定异常
        Logger.LogError("PDF Document error: " + de.Message);
        return Request.CreateErrorResponse(System.Net.HttpStatusCode.InternalServerError, "PDF document generation error");
    }
    catch (IOException ioe)
    {
        // 记录IO异常
        Logger.LogError("IO error during PDF generation: " + ioe.Message);
        return Request.CreateErrorResponse(System.Net.HttpStatusCode.InternalServerError, "IO error during PDF generation");
    }
    catch (Exception ex)
    {
        // 记录其他异常
        Logger.LogError("Unexpected error during PDF generation: " + ex.Message);
        return Request.CreateErrorResponse(System.Net.HttpStatusCode.InternalServerError, "An unexpected error occurred");
    }
}

六、选择建议

根据以上分析，在C# WebApi项目中选择iText7或iTextSharp时，可以考虑以下因素：

1. 项目阶段：

   • 新项目推荐使用iText7，享受更好的API设计和性能

   • 维护现有项目且使用iTextSharp，可以继续使用，但升级时建议迁移到iText7

2. 功能需求：

   • 如需HTML转PDF功能，iText7的实现更加强大

   • 对于无障碍PDF需求，iText7提供了更完善的支持

3. 性能考量：

   • 处理大型文档或需要高性能时，iText7是更好的选择

4. 许可与成本：

   • 两个库在商业使用上都需要购买许可，应根据预算和商业需求决定

七、总结

本文详细对比了iText7与iTextSharp在C# WebApi应用中的使用情况，包括架构设计、功能特性、性能表现和代码示例。iText7作为新一代产品，提供了更现代的API设计、更好的性能和更丰富的功能，特别是在HTML转PDF和PDF/UA支持方面具有明显优势。

在实际应用中，开发者应根据项目需求、团队经验和许可成本等因素选择合适的库。对于新项目，建议使用iText7以获得更好的开发体验和未来支持。而对于已有项目，则可以根据具体情况决定是否需要迁移到iText7。

无论选择哪种库，合理的内存管理、异常处理和性能优化都是确保WebApi应用中PDF生成功能稳定高效运行的关键。通过本文提供的示例和最佳实践，开发者可以快速上手并实现高质量的PDF导出功能。