Asp.net Core 中使用 iTextsharp 库生成 PDF 的示例教程

本文还有配套的精品资源，点击获取

简介：本教程将指导您如何在Asp.net Core框架中使用iTextsharp库创建PDF文档。内容包括引入iTextsharp库、创建PDF文档、设置写入位置、添加内容以及自定义返回PDF响应的方法。介绍了创建PDF文档的基本步骤，并展示了如何将生成的PDF文件通过HTTP响应直接发送给客户端。此外，提到了iTextsharp可能存在的局限性，并推荐了其他现代库作为替代选项。通过学习本示例，读者将能够掌握在Asp.net Core应用中实现PDF文档生成的技巧。

1. Asp.net Core PDF生成基础

随着数字文档的普及，PDF已成为信息交流的标准格式之一。在.NET Core环境下生成PDF文件是Web应用中常见的需求，尤其是对于需要精确布局和可靠打印输出的场景。本章将带您了解PDF文件格式的基本概念，以及.NET Core中实现PDF生成的原理和过程。通过掌握这些基础知识，您将能够为您的Web应用添加生成和管理PDF的功能。

从下一章开始，我们将深入探讨如何使用iTextsharp库——一个功能强大的.NET库，用于创建和操作PDF文件。我们会逐步介绍如何安装和配置该库，以及如何使用它来创建PDF文档、添加内容、设计布局，并最终实现PDF文件在Web应用中的生成与传输。

2. iTextsharp库介绍及安装

2.1 iTextsharp库概述

2.1.1 iTextsharp库的功能和特点

iTextsharp 是一个广泛使用的开源库，主要用于在 .NET 应用程序中生成和操作 PDF 文件。它允许开发者创建复杂的文档布局，包含文本、图像、表格以及各种样式和格式设置。iTextsharp 的功能不仅限于生成静态 PDF 文件，还能进行复杂的 PDF 文件编辑和内容管理。它支持PDF/A, PDF/UA, PDF/E标准，广泛适用于企业级应用场景，例如电子发票、报告生成、自动化表单等。

2.1.2 iTextsharp库与PDF生成的关系

iTextsharp 与 PDF 文件生成的关系十分紧密。通过使用 iTextsharp，开发者可以轻松地将Web页面或数据源转换为PDF文档，实现内容的格式化输出。它提供了丰富的API来控制PDF的各个层面，例如字体、颜色、页面布局、图形和超链接。此外，iTextsharp 也支持对已存在的PDF文档进行修改，如添加注释、表单、数字签名等操作，从而满足更高级的业务需求。

2.2 安装iTextsharp库

2.2.1 通过NuGet包管理器安装

在.NET Core或.NET 5+项目中安装 iTextsharp 库非常简单。使用Visual Studio的NuGet包管理器是官方推荐的方法。

1. 打开你的项目，然后点击菜单栏的“工具” -> “NuGet包管理器” -> “管理解决方案的NuGet包”。
2. 在打开的界面中切换到“浏览”标签页。
3. 在搜索框中输入“iTextSharp”，然后在搜索结果中找到 iTextSharp 的 NuGet 包。
4. 选择适合你项目的版本，然后点击“安装”。

安装后，iTextsharp 会添加到你的项目依赖中，并在你的解决方案资源管理器的“引用”部分可见。

2.2.2 手动下载与配置iTextsharp库

除了通过NuGet包管理器安装外，iTextsharp 也可以手动下载与配置。

1. 访问iText官方下载页面或其GitHub仓库。
2. 下载最新版本的iTextSharp DLL文件。
3. 将下载的DLL文件添加到你的项目中。在Visual Studio中，右击你的项目名称 -> “添加” -> “引用” -> “浏览”。
4. 浏览到你下载的DLL文件位置，选中它并点击“确定”。
5. 在项目引用中勾选刚刚添加的iTextSharp DLL文件。

完成以上步骤后，iTextsharp 库就被添加到你的项目中了，可以开始使用。

代码块示例：

假设我们需要创建一个简单的PDF文档，以下是一个基础的代码示例，展示如何使用 iTextSharp 库：

using System;
using System.IO;
using iTextSharp.text;
using iTextSharp.text.pdf;

public class SimplePdfExample
{
    public void CreatePdf(string outputFilePath)
    {
        // 创建PDF文档对象
        Document pdfDoc = new Document(PageSize.A4, 36, 36, 54, 36);
        // 创建PDF文件流
        PdfWriter.GetInstance(pdfDoc, new FileStream(outputFilePath, FileMode.Create));
        // 打开文档
        pdfDoc.Open();
        // 添加一个段落
        pdfDoc.Add(new Paragraph("Hello, iTextSharp!"));
        // 关闭文档
        pdfDoc.Close();
    }
}

在以上代码中，我们首先引入了必要的命名空间，然后创建了一个简单的 SimplePdfExample 类。在这个类中， CreatePdf 方法将创建一个新的PDF文档，并写入一行文本“Hello, iTextSharp!”。需要注意的是，在创建 PDF 文档之前，我们使用了 PdfWriter.GetInstance 方法来关联文档对象和文件流对象，其中 PageSize.A4 指定了页面大小为国际标准的A4大小。

代码逻辑的每个步骤都有具体的注释，方便理解每一步操作的含义。这样的代码块，将帮助开发者理解iTextsharp库的基础使用方法，并可以在此基础上进行扩展，满足更复杂的PDF处理需求。

3. 创建PDF文档的步骤

3.1 创建PDF文件结构

3.1.1 定义PDF文档属性

在创建PDF文件时，文档属性是不可或缺的，因为它们提供了文档的元数据信息，包括文档的标题、作者、主题等。使用iTextSharp库，我们能够轻松地定义这些属性。以下代码展示了如何创建一个新的PDF文档并为其设置基本属性。

// 创建一个新的PdfDocument实例
using (PdfDocument pdfDoc = new PdfDocument(new PdfWriter(dest))) {
    // 设置文档的属性
    pdfDoc.GetDocumentInfo()
        .SetAuthor("Author Name")
        .SetCreator("Creator Name")
        .SetSubject("Subject of the PDF")
        .SetTitle("Title of the PDF");

    // 添加一个页面，此处为A4大小，无边距
    PdfPage page = pdfDoc.AddNewPage(new Rectangle(PageSize.A4));
}

在这段代码中，我们首先创建了一个 PdfDocument 的实例，并指定了输出文件的目标路径 dest 。通过 GetDocumentInfo() 方法，我们能够访问到文档信息对象并设置其属性。创建页面时，我们使用 AddNewPage() 方法并传入了一个 Rectangle 对象，该对象定义了页面的尺寸和边距。上述代码执行后，将生成一个包含基本属性和一个空白页面的PDF文件。

3.1.2 添加文档元素和章节

文档元素和章节是PDF结构的重要组成部分，它们帮助组织内容的层次和逻辑。例如，添加章节通常意味着在PDF中创建标题和相应的段落。在iTextSharp中，我们可以使用 PdfPTable 来创建表格，使用 PdfPCell 来添加单元格内容。以下是一个添加简单章节的示例代码。

// 假设已经有一个PdfDocument实例和一个页面实例
// 创建一个表格用于作为章节标题
PdfPTable table = new PdfPTable(1);
PdfPCell cell = new PdfPCell(new Phrase("Chapter Title"));
cell.Colspan = 1;
cell.HorizontalAlignment = Element.ALIGN_CENTER;
table.AddCell(cell);

// 在表格下方添加一些文本作为内容
Paragraph p = new Paragraph(new Phrase("Some introductory text about the chapter."));
table.AddCell(p);

在这个代码段中，我们首先创建了一个 PdfPTable 实例，并设置了单列。然后，我们创建了一个 PdfPCell 实例，并将其作为单元格添加到表格中。接着，我们设置了单元格的水平居中对齐，并将单元格添加到表格中。最后，我们创建了一个 Paragraph 实例来表示文本段落，并将该段落添加到表格中。这样，我们就通过表格的方式向PDF添加了一个章节及其内容。

3.2 设计PDF页面布局

3.2.1 设置页面尺寸和边距

页面尺寸和边距定义了PDF页面的外观和空间布局，它们对于最终的阅读体验至关重要。iTextSharp允许通过 Rectangle 类来定义页面尺寸以及 PdfPage 类的属性来设置边距。

// 创建页面尺寸为A4，并设置边距为25单位（左右）和40单位（上下）
var pageSize = new Rectangle(PageSize.A4.Width, PageSize.A4.Height);
pageSize.LEFT = 25;
pageSize.RIGHT = 25;
pageSize.TOP = 40;
pageSize.BOTTOM = 40;

// 添加一个新的页面并应用设置的页面尺寸和边距
PdfPage page = pdfDoc.AddNewPage(pageSize);

在上述代码段中，我们首先创建了一个 Rectangle 对象，并为其指定了A4页面的标准尺寸。然后，我们分别设置了页面的左右和上下边距。之后，我们通过调用 AddNewPage 方法，使用我们的自定义 Rectangle 对象作为参数，向PDF文档中添加了一个新的页面，该页面带有指定的尺寸和边距。

3.2.2 添加表格和图像

在文档中添加表格和图像是一种常见的需求，它可以帮助展示结构化数据和视觉信息。iTextSharp库提供了强大的接口来实现这些功能。下面的示例演示了如何在PDF中添加一个表格和图像。

// 假设已经有一个PdfDocument实例和一个页面实例
// 添加一个三列两行的表格
PdfPTable table = new PdfPTable(3);
for (int i = 0; i < 2; i++) {
    for (int j = 0; j < 3; j++) {
        table.AddCell(new Phrase("Table Cell [" + i + "][" + j + "]"));
    }
}

// 向页面添加表格
document.Add(table);

// 添加一个图像到页面
ImageData imageData = ImageDataFactory.Create("path/to/image.jpg");
Image image = new Image(imageData);
image.ScaleToFit(100, 100); // 将图像缩放到最大宽度100单位，高度自动缩放
document.Add(image);

在这段代码中，我们首先创建了一个三列两行的 PdfPTable 实例，并用数据填充了表格的单元格。通过 Add 方法将表格添加到文档中。然后，我们使用 ImageDataFactory 创建了一个图像的数据实例，并通过 Image 类实例化一个图像对象，设置了图像大小后将其添加到文档中。

表格布局示例表格

图像嵌入示例

在代码中， ImageDataFactory.Create("path/to/image.jpg") 用于加载一个图像文件， ScaleToFit(100, 100) 方法用于调整图像大小以适应给定的宽度和高度，保证图像在PDF中显示的适宜性和美观性。

Mermaid流程图示例

graph TD;
    A[开始创建PDF] --> B[设置文档属性];
    B --> C[添加页面和布局];
    C --> D[添加表格和图像];
    D --> E[完成PDF构建];

通过上述代码和示例，我们可以看到创建PDF文档时对页面尺寸、边距以及添加表格和图像的具体操作和布局设置。这些步骤共同构成了PDF文档的视觉框架和内容结构。

4. PDF内容写入与管理

编写PDF文档时，内容的写入和管理是核心任务。内容不仅包括文本，还可以包括图像、图表以及格式化元素。在本章节中，我们将深入了解如何使用iTextSharp在.NET Core环境中高效地将内容写入PDF文件，并对内容进行有效管理。

4.1 写入文本和格式化内容

写入文本是创建PDF文档的基础。文本内容需要有适当的样式和格式才能在PDF中呈现得更加美观和专业。

4.1.1 字体选择和样式应用

在iTextSharp中，选择合适的字体对于确保文档的可读性和视觉效果至关重要。可以使用内置字体或者加载外部字体文件。以下是选择字体并应用样式的示例代码：

using iTextSharp.text;
using iTextSharp.text.pdf;

// 创建一个文档对象
Document document = new Document();

// 打开一个PDF文件输出流
PdfWriter.GetInstance(document, new FileStream("output.pdf", FileMode.Create));

// 打开文档准备写入内容
document.Open();

// 设置字体和样式
Font font = FontFactory.GetFont(Font.FontFamily.HELVETICA, 12, Font.BOLD);
Paragraph p = new Paragraph("这是一个加粗的标题", font);

// 将段落写入文档
document.Add(p);

document.Close();

在上述代码中， FontFactory.GetFont 用于获取字体对象，这里指定了字体家族（HELVETICA），大小（12）以及样式（加粗）。然后，该字体被应用到一个 Paragraph 对象上，该对象随后被添加到文档中。

4.1.2 处理文本换行和段落

在写入文本时，合理地管理换行和段落是保持文档格式良好的关键。iTextSharp提供了丰富的API来控制段落和换行。下面的代码展示了如何处理文本换行和段落：

// 继续使用上面的文档对象document

// 创建一个换行符
Chunk newline = new Chunk(new Phrase("\n"));

// 创建一个段落，并添加文本和换行符
Paragraph paragraph = new Paragraph("这是第一行文本。\n这是第二行文本。", font);
paragraph.Add(newline);
paragraph.Add("这是第三行文本，与第二行文本在同一段落。");

// 添加段落到文档中
document.Add(paragraph);

// 关闭文档
document.Close();

在这段代码中， Chunk 对象表示一个文本片段，可以包含文本以及其他格式设置。在这里，我们创建了一个表示换行符的 Chunk ，然后将其添加到 Paragraph 对象中。

4.2 图像和图表的整合

在PDF文档中，除了文本内容，图像和图表也是重要组成部分。它们能够增强文档的表现力和信息量。

4.2.1 嵌入和调整图像大小

为了将图像嵌入PDF文档中，我们需要使用 iTextSharp.text.Image 类。下面的代码段展示了如何加载并嵌入一个图像：

// 继续使用上面的文档对象document

// 加载外部图像文件
Image img = Image.GetInstance("path/to/image.jpg");

// 调整图像大小
img.ScaleToFit(100, 100);

// 将图像添加到文档中
document.Add(img);

// 关闭文档
document.Close();

在这段代码中， Image.GetInstance 用于加载图像文件。然后使用 ScaleToFit 方法调整图像的尺寸，使之适应PDF页面的布局。最后，图像被添加到文档中。

4.2.2 利用图表库创建复杂图表

iTextSharp本身不直接支持创建复杂图表。不过，可以通过与其他图表库（例如NPOI）的集成来实现这一功能。下面的代码展示了如何利用NPOI库来生成一个Excel表格，并将其作为图表嵌入PDF中：

// 引入NPOI库的相关命名空间
using NPOI.HSSF.UserModel;
using NPOI.SS.UserModel;
using NPOI.XSSF.UserModel;

// 创建Excel文档，添加数据和样式
HSSFWorkbook workbook = new HSSFWorkbook();
ISheet sheet = workbook.CreateSheet("Sheet1");
IRow row = sheet.CreateRow(0);
ICell cell = row.CreateCell(0);
cell.SetCellValue("Excel数据嵌入PDF");

// 将Excel文档保存到文件
FileStream excelFile = new FileStream("chart.xlsx", FileMode.Create);
workbook.Write(excelFile);

// 关闭Excel文件流
excelFile.Close();

// 加载Excel文件到iTextSharp图像对象
Image chartImg = Image.GetInstance("chart.xlsx");

// 将图像添加到文档中
document.Add(chartImg);

// 关闭文档
document.Close();

在这段代码中，我们使用了NPOI库创建了一个Excel文档，并添加了基础数据。之后，我们将该Excel文档保存为文件，然后用 Image.GetInstance 方法加载为图像并添加到PDF文档中。需要注意的是，此方法主要通过图像嵌入的形式将数据和样式展示在PDF中，而不是动态创建图表。

在这一章节中，我们介绍了如何在.NET Core环境下使用iTextSharp库来写入和管理PDF内容。包括了字体的选择和样式应用，文本换行和段落处理，图像的嵌入和调整，以及使用外部库创建复杂图表的方法。这些技能都是创建功能丰富的PDF文档所必须的。在下一章节中，我们将继续深入了解如何使用自定义PdfResponse来优化PDF文件的传输。

5. 自定义PdfResponse以返回PDF文件

5.1 实现自定义PdfResponse

5.1.1 PdfResponse的职责和实现原理

在Web应用中，为了向用户返回PDF文件，我们需要创建一个专门的响应类型，即PdfResponse。这一响应类型的责任是将生成的PDF文档以二进制流的方式发送给客户端。具体实现原理是通过继承现有的HttpResponse类，或者是在中间件中处理响应流，从而在响应头中设置正确的 Content-Type 为 application/pdf ，并且输出PDF文件的二进制数据。

下面是一个简单的实现示例：

public class PdfResponse : IActionResult
{
    private readonly Stream pdfStream;

    public PdfResponse(Stream pdfStream)
    {
        this.pdfStream = pdfStream ?? throw new ArgumentNullException(nameof(pdfStream));
    }

    public async Task ExecuteResultAsync(ActionContext context)
    {
        if (context == null)
            throw new ArgumentNullException(nameof(context));

        var response = context.HttpContext.Response;

        // 设置响应头信息
        response.ContentType = "application/pdf";
        response.StatusCode = 200;

        // 将PDF二进制流写入响应体
        await pdfStream.CopyToAsync(response.Body);
    }
}

在这个自定义的 PdfResponse 类中，构造函数接收一个PDF文件的二进制流，然后在 ExecuteResultAsync 方法中，将这个流的内容写入到HTTP响应体中，并设置了必要的响应头信息。

5.1.2 在Controller中使用PdfResponse

在控制器中使用这个自定义的响应类型非常简单。首先，你需要生成PDF文件的内容并将其存储在一个流中，然后返回一个新的 PdfResponse 实例。例如：

public async Task<IActionResult> DownloadReport()
{
    // 创建PDF文档并写入流
    using (var memoryStream = new MemoryStream())
    {
        var document = new Document();
        PdfWriter.GetInstance(document, memoryStream);
        document.Open();
        // 添加PDF内容
        document.Add(new Paragraph("Hello, World!"));
        // 添加更多内容...

        document.Close();

        // 重置流的位置到开始
        memoryStream.Position = 0;

        // 返回自定义的PdfResponse
        return new PdfResponse(memoryStream);
    }
}

上面的 DownloadReport 方法创建了一个PDF文档，并通过 PdfWriter 将内容写入到内存流中。然后，重置流的位置，并使用此流创建并返回一个 PdfResponse 实例。

5.2 优化PDF文件的传输

5.2.1 设置PDF传输头信息

为了确保PDF文件能够被正确地传输和下载，我们还需要设置一些关键的HTTP响应头信息。除了前面已经提到的 Content-Type ，其他常见的头信息包括 Content-Disposition 、 Content-Length 等。例如：

response.Headers.Add("Content-Disposition", "attachment; filename=report.pdf");
response.Headers.Add("Content-Length", pdfStream.Length.ToString());

其中 Content-Disposition 指定了响应的内容应该被浏览器处理为一个附件（即提示用户保存文件），并且给出了文件名。 Content-Length 告知浏览器响应内容的大小，这对于下载进度的显示很有用。

5.2.2 处理文件下载和在线预览

在实际应用中，用户可能既需要下载PDF文件，也可能希望在线直接查看PDF内容。为了同时支持这两种需求，我们在设置响应头时，可以为 Content-Disposition 设置不同的参数：

// 为下载设置
response.Headers.Add("Content-Disposition", "attachment; filename=report.pdf");

// 或者为在线预览设置
// response.Headers.Add("Content-Disposition", "inline; filename=report.pdf");

通过更改 Content-Disposition 头中的参数，用户在下载PDF文件时可以选择保存文件，或者选择在浏览器中直接打开查看PDF内容。

在本章中，我们学习了如何实现一个自定义的 PdfResponse 类以返回PDF文件，包括如何在控制器中使用它。然后，我们探讨了如何优化PDF文件的传输，包括设置必要的HTTP响应头信息以支持文件下载和在线预览功能。这些知识对于构建功能完善的Web应用至关重要，可以提升用户体验并满足不同的业务需求。

本文还有配套的精品资源，点击获取

简介：本教程将指导您如何在Asp.net Core框架中使用iTextsharp库创建PDF文档。内容包括引入iTextsharp库、创建PDF文档、设置写入位置、添加内容以及自定义返回PDF响应的方法。介绍了创建PDF文档的基本步骤，并展示了如何将生成的PDF文件通过HTTP响应直接发送给客户端。此外，提到了iTextsharp可能存在的局限性，并推荐了其他现代库作为替代选项。通过学习本示例，读者将能够掌握在Asp.net Core应用中实现PDF文档生成的技巧。

本文还有配套的精品资源，点击获取