如何用 C# 从 PdfPig 迁移到 IronPDF
从PdfPig迁移到IronPDF可将您的 PDF 功能从纯粹的阅读库扩展为一个全面的 PDF 解决方案,可处理创建、操作、文本提取和安全功能。 本指南提供了一个完整的、循序渐进的迁移路径,在保留现有提取工作流的同时,增加了 PDF 生成、HTML 转换、文档操作以及PdfPig无法提供的安全功能。
为何从PdfPig迁移到 IronPDF.
了解 PdfPig。
PdfPig 是一个专门为 C# 设计的开源 PDF 阅读和提取库。 作为声誉卓著的 Apache PDFBox 项目的一个分支,该库允许开发人员非常精确地访问 PDF 内容。 虽然PdfPig在提取能力方面表现出色,但与市场上更全面的库相比,它的范围很大程度上受到了限制。
PdfPig 为开发人员提供了从 PDF 文件中提取文本、图像、表单数据和元数据的可靠工具。 因此,它适合主要侧重于文档分析和数据挖掘的应用程序。 然而,PdfPig 的功能从根本上来说仅限于解析现有文档。
仅限阅读的限制
PdfPig 专注于 PDF 阅读。 当您的应用程序需要扩展到提取之外时,PdfPig 将无能为力:
1.无法生成 PDF:无法从 HTML、URL 或通过编程方式创建 PDF。
2.不支持 HTML 转 PDF:PdfPig是一个 PDF 读取/解析库,而不是一个 PDF 生成库。 您需要使用不同的库将 HTML 转换为 PDF。
3.不支持文档操作:无法合并、拆分或修改 PDF 文件。
4.无安全功能:无法添加密码、加密或数字签名。
5.无水印/印章:无法向现有文档添加视觉叠加层。
6.无法填写表单:无法通过编程方式填写 PDF 表单。
PdfPig与IronPDF对比
| 特征 | PdfPig | IronPDF |
|---|---|---|
| 许可 | 开源(Apache 2.0) | 商业翻译 |
| PDF阅读/提取 | 出色的 | 出色的 |
| PDF 生成 | 有限的 | 综合性 |
| HTML 到 PDF | 不支持 | 支持 |
| 文本提取 | 出色的 | 出色的 |
| PDF 操作 | 不支持 | 合并、拆分、旋转 |
| 水印。 | 不支持 | 支持 |
| 安全/加密 | 不支持 | 支持 |
| 支持和文档 | 社区支持 | 专项支持 |
| 页面索引 | 1 基于 | 基于 0 |
IronPDF 支持创建、阅读、编辑和签署 PDF 的全套功能。 这种多功能性使开发人员能够自始至终管理 PDF 文件。 对于计划在 2025 年和 2026 年之前采用 .NET 10 和 C# 14 的团队,IronPDF 提供了一个完整的 PDF 生命周期解决方案,其功能超出了PdfPig的阅读功能。
开始之前
前提条件
- .NET 环境: .NET Framework 4.6.2+ 或 .NET Core 3.1+ / .NET 5/6/7/8/9+
- NuGet 访问权限:能够安装 NuGet 包
- IronPDF 许可证:请从ironpdf.com获取您的许可证密钥。
NuGet 软件包变更
# Remove PdfPig
dotnet remove package PdfPig
# Install IronPDF
dotnet add package IronPdf
# Remove PdfPig
dotnet remove package PdfPig
# Install IronPDF
dotnet add package IronPdf
许可配置
// Add at application startup (Program.cs or Startup.cs)
IronPdf.License.LicenseKey = "YOUR-LICENSE-KEY";
// Add at application startup (Program.cs or Startup.cs)
IronPdf.License.LicenseKey = "YOUR-LICENSE-KEY";
' Add at application startup (Program.vb or Startup.vb)
IronPdf.License.LicenseKey = "YOUR-LICENSE-KEY"
识别PdfPig的用法
# FindPdfPigusage
grep -r "UglyToad\.PdfPig\|PdfDocument\.Open\|GetPages\(\)" --include="*.cs" .
# Find page index references (may need 1→0 conversion)
grep -r "GetPage(\|NumberOfPages" --include="*.cs" .
# FindPdfPigusage
grep -r "UglyToad\.PdfPig\|PdfDocument\.Open\|GetPages\(\)" --include="*.cs" .
# Find page index references (may need 1→0 conversion)
grep -r "GetPage(\|NumberOfPages" --include="*.cs" .
完整的 API 参考
命名空间变更
// Before: PdfPig
using UglyToad.PdfPig;
using UglyToad.PdfPig.Content;
using UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor;
// After: IronPDF
using IronPdf;
using IronPdf.Rendering;
// Before: PdfPig
using UglyToad.PdfPig;
using UglyToad.PdfPig.Content;
using UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor;
// After: IronPDF
using IronPdf;
using IronPdf.Rendering;
' Before: PdfPig
Imports UglyToad.PdfPig
Imports UglyToad.PdfPig.Content
Imports UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor
' After: IronPDF
Imports IronPdf
Imports IronPdf.Rendering
文档加载映射
| PdfPig | IronPDF |
|---|---|
PdfDocument.Open(path) |
PdfDocument.FromFile(path) |
PdfDocument.Open(bytes) |
PdfDocument.FromBinaryData(bytes) |
PdfDocument.Open(stream) |
PdfDocument.FromStream(stream) |
using (var doc = ...) |
var pdf = ... |
页面访问和属性映射
| PdfPig | IronPDF |
|---|---|
document.NumberOfPages |
pdf.PageCount |
document.GetPages() |
pdf.Pages |
document.GetPage(1) |
pdf.Pages[0] |
文本提取映射
| PdfPig | IronPDF |
|---|---|
page.Text |
pdf.Pages[i].Text |
page.GetWords() |
pdf.ExtractTextFromPage(i) |
| (manual loop) | pdf.ExtractAllText() |
元数据访问映射
| PdfPig | IronPDF |
|---|---|
document.Information.Title |
pdf.MetaData.Title |
document.Information.Author |
pdf.MetaData.Author |
document.Information.Subject |
pdf.MetaData.Subject |
document.Information.Creator |
pdf.MetaData.Creator |
document.Information.Producer |
pdf.MetaData.Producer |
PdfPig不具备的新功能
| IronPDF 特点 | 说明 |
|---|---|
renderer.RenderHtmlAsPdf(html) |
HTML 到 PDF 的转换 |
renderer.RenderUrlAsPdf(url) |
URL 到 PDF 的转换 |
PdfDocument.Merge(pdfs) |
合并多个 PDF |
pdf.ApplyWatermark(html) |
添加水印 |
pdf.SecuritySettings.UserPassword |
密码保护 |
pdf.Sign(certificate) |
数字签名 |
代码迁移示例
示例 1:从 PDF 中提取文本
之前 (PdfPig):
// NuGet: Install-Package PdfPig
using UglyToad.PdfPig;
using System;
using System.Text;
class Program
{
static void Main()
{
using (var document = PdfDocument.Open("input.pdf"))
{
var text = new StringBuilder();
foreach (var page in document.GetPages())
{
text.AppendLine(page.Text);
}
Console.WriteLine(text.ToString());
}
}
}
// NuGet: Install-Package PdfPig
using UglyToad.PdfPig;
using System;
using System.Text;
class Program
{
static void Main()
{
using (var document = PdfDocument.Open("input.pdf"))
{
var text = new StringBuilder();
foreach (var page in document.GetPages())
{
text.AppendLine(page.Text);
}
Console.WriteLine(text.ToString());
}
}
}
Imports UglyToad.PdfPig
Imports System
Imports System.Text
Class Program
Shared Sub Main()
Using document = PdfDocument.Open("input.pdf")
Dim text = New StringBuilder()
For Each page In document.GetPages()
text.AppendLine(page.Text)
Next
Console.WriteLine(text.ToString())
End Using
End Sub
End Class
After (IronPDF):
// NuGet: Install-Package IronPdf
using IronPdf;
using System;
class Program
{
static void Main()
{
var pdf = PdfDocument.FromFile("input.pdf");
string text = pdf.ExtractAllText();
Console.WriteLine(text);
}
}
// NuGet: Install-Package IronPdf
using IronPdf;
using System;
class Program
{
static void Main()
{
var pdf = PdfDocument.FromFile("input.pdf");
string text = pdf.ExtractAllText();
Console.WriteLine(text);
}
}
Imports IronPdf
Imports System
Class Program
Shared Sub Main()
Dim pdf = PdfDocument.FromFile("input.pdf")
Dim text As String = pdf.ExtractAllText()
Console.WriteLine(text)
End Sub
End Class
PdfPig 和IronPDF都具有出色的文本提取功能。 关键区别在于代码模式。PdfPig需要一个 using 语句,以及 PdfDocument.Open() 语句,通过 GetPages() 手动遍历页面,并使用 StringBuilder 来从每个 page.Text 属性中收集文本。
IronPDF 将此简化为一次调用:PdfDocument.FromFile() 加载文档,ExtractAllText() 一次性返回所有文本内容。 无需 using 语句,无需手动迭代,无需 StringBuilder。 有关其他选项,请参阅 文本提取文档。
示例 2:HTML 到 PDF 的转换
之前 (PdfPig):
PdfPig不支持HTML转PDF。PdfPig是一个 PDF 阅读/解析库,而不是一个 PDF 生成库。 您需要使用不同的库来进行 HTML 到 PDF 的转换。
After (IronPDF):
// NuGet: Install-Package IronPdf
using IronPdf;
class Program
{
static void Main()
{
var renderer = new ChromePdfRenderer();
var pdf = renderer.RenderHtmlAsPdf("<h1>Hello World</h1><p>This is a PDF from HTML</p>");
pdf.SaveAs("output.pdf");
}
}
// NuGet: Install-Package IronPdf
using IronPdf;
class Program
{
static void Main()
{
var renderer = new ChromePdfRenderer();
var pdf = renderer.RenderHtmlAsPdf("<h1>Hello World</h1><p>This is a PDF from HTML</p>");
pdf.SaveAs("output.pdf");
}
}
Imports IronPdf
Class Program
Shared Sub Main()
Dim renderer = New ChromePdfRenderer()
Dim pdf = renderer.RenderHtmlAsPdf("<h1>Hello World</h1><p>This is a PDF from HTML</p>")
pdf.SaveAs("output.pdf")
End Sub
End Class
这个例子凸显了最重要的能力差距。PdfPig 明确指出它 "不支持 HTML 到 PDF 的转换",并且 "是一个 PDF 阅读/解析库,而不是一个 PDF 生成库"。如果你需要用PdfPig从 HTML 创建 PDF,你需要使用完全不同的库。
IronPDF 通过 ChromePdfRenderer 提供原生 HTML 到 PDF 的转换。 RenderHtmlAsPdf() 方法接受 HTML 字符串,并使用 Chromium 引擎将其转换为 PDF 文档,以便准确地渲染 HTML、CSS 和 JavaScript。 生成的 PdfDocument 可以保存为 SaveAs(),也可以在保存前进行进一步处理。 请参阅 HTML 转 PDF 文档,了解全面的示例。
示例 3:读取 PDF 元数据
之前 (PdfPig):
// NuGet: Install-Package PdfPig
using UglyToad.PdfPig;
using System;
class Program
{
static void Main()
{
using (var document = PdfDocument.Open("input.pdf"))
{
var info = document.Information;
Console.WriteLine($"Title: {info.Title}");
Console.WriteLine($"Author: {info.Author}");
Console.WriteLine($"Subject: {info.Subject}");
Console.WriteLine($"Creator: {info.Creator}");
Console.WriteLine($"Producer: {info.Producer}");
Console.WriteLine($"Number of Pages: {document.NumberOfPages}");
}
}
}
// NuGet: Install-Package PdfPig
using UglyToad.PdfPig;
using System;
class Program
{
static void Main()
{
using (var document = PdfDocument.Open("input.pdf"))
{
var info = document.Information;
Console.WriteLine($"Title: {info.Title}");
Console.WriteLine($"Author: {info.Author}");
Console.WriteLine($"Subject: {info.Subject}");
Console.WriteLine($"Creator: {info.Creator}");
Console.WriteLine($"Producer: {info.Producer}");
Console.WriteLine($"Number of Pages: {document.NumberOfPages}");
}
}
}
Imports UglyToad.PdfPig
Imports System
Class Program
Shared Sub Main()
Using document = PdfDocument.Open("input.pdf")
Dim info = document.Information
Console.WriteLine($"Title: {info.Title}")
Console.WriteLine($"Author: {info.Author}")
Console.WriteLine($"Subject: {info.Subject}")
Console.WriteLine($"Creator: {info.Creator}")
Console.WriteLine($"Producer: {info.Producer}")
Console.WriteLine($"Number of Pages: {document.NumberOfPages}")
End Using
End Sub
End Class
After (IronPDF):
// NuGet: Install-Package IronPdf
using IronPdf;
using System;
class Program
{
static void Main()
{
var pdf = PdfDocument.FromFile("input.pdf");
var info = pdf.MetaData;
Console.WriteLine($"Title: {info.Title}");
Console.WriteLine($"Author: {info.Author}");
Console.WriteLine($"Subject: {info.Subject}");
Console.WriteLine($"Creator: {info.Creator}");
Console.WriteLine($"Producer: {info.Producer}");
Console.WriteLine($"Number of Pages: {pdf.PageCount}");
}
}
// NuGet: Install-Package IronPdf
using IronPdf;
using System;
class Program
{
static void Main()
{
var pdf = PdfDocument.FromFile("input.pdf");
var info = pdf.MetaData;
Console.WriteLine($"Title: {info.Title}");
Console.WriteLine($"Author: {info.Author}");
Console.WriteLine($"Subject: {info.Subject}");
Console.WriteLine($"Creator: {info.Creator}");
Console.WriteLine($"Producer: {info.Producer}");
Console.WriteLine($"Number of Pages: {pdf.PageCount}");
}
}
Imports IronPdf
Imports System
Class Program
Shared Sub Main()
Dim pdf = PdfDocument.FromFile("input.pdf")
Dim info = pdf.MetaData
Console.WriteLine($"Title: {info.Title}")
Console.WriteLine($"Author: {info.Author}")
Console.WriteLine($"Subject: {info.Subject}")
Console.WriteLine($"Creator: {info.Creator}")
Console.WriteLine($"Producer: {info.Producer}")
Console.WriteLine($"Number of Pages: {pdf.PageCount}")
End Sub
End Class
这两个库都以几乎相同的模式提供元数据访问。PdfPig通过 document.Information 访问元数据,通过 document.NumberOfPages 访问页数。IronPDF使用 pdf.MetaData 作为元数据,使用 pdf.PageCount 作为页数。
迁移很简单:将 PdfDocument.Open() 替换为 PdfDocument.FromFile(),将 document.Information 替换为 pdf.MetaData,将 document.NumberOfPages 替换为 pdf.PageCount。 删除 using 语句包装器,因为IronPDF不需要它。
关键迁移说明
页面索引更改
PdfPig 使用基于 1 的索引;IronPDF使用基于 0:
// PdfPig:1 基于indexing
var firstPage = document.GetPage(1); // First page
// IronPDF:基于 0indexing
var firstPage = pdf.Pages[0]; // First page
// Migration helper
int pdfPigIndex = 1;
int ironPdfIndex = pdfPigIndex - 1;
// PdfPig:1 基于indexing
var firstPage = document.GetPage(1); // First page
// IronPDF:基于 0indexing
var firstPage = pdf.Pages[0]; // First page
// Migration helper
int pdfPigIndex = 1;
int ironPdfIndex = pdfPigIndex - 1;
' PdfPig:1 基于indexing
Dim firstPage = document.GetPage(1) ' First page
' IronPDF:基于 0indexing
Dim firstPage = pdf.Pages(0) ' First page
' Migration helper
Dim pdfPigIndex As Integer = 1
Dim ironPdfIndex As Integer = pdfPigIndex - 1
不要求使用说明
// PdfPig: Requires using for disposal
using (var document = PdfDocument.Open("input.pdf"))
{
// ...
}
// IronPDF: No using required (but can use for cleanup)
var pdf = PdfDocument.FromFile("input.pdf");
// ...
// pdf.Dispose(); // Optional
// PdfPig: Requires using for disposal
using (var document = PdfDocument.Open("input.pdf"))
{
// ...
}
// IronPDF: No using required (but can use for cleanup)
var pdf = PdfDocument.FromFile("input.pdf");
// ...
// pdf.Dispose(); // Optional
Imports PdfPig
Imports IronPDF
Using document = PdfDocument.Open("input.pdf")
' ...
End Using
Dim pdf = PdfDocument.FromFile("input.pdf")
' ...
' pdf.Dispose() ' Optional
文档加载更改
// PdfPig: PdfDocument.Open()
using (var document = PdfDocument.Open("input.pdf"))
// IronPDF: PdfDocument.FromFile()
var pdf = PdfDocument.FromFile("input.pdf");
// PdfPig: PdfDocument.Open()
using (var document = PdfDocument.Open("input.pdf"))
// IronPDF: PdfDocument.FromFile()
var pdf = PdfDocument.FromFile("input.pdf");
Imports PdfPig
Imports IronPDF
Using document = PdfDocument.Open("input.pdf")
End Using
Dim pdf = PdfDocument.FromFile("input.pdf")
元数据属性名称更改
// PdfPig: document.Information
var info = document.Information;
// IronPDF: pdf.MetaData
var info = pdf.MetaData;
// PdfPig: document.Information
var info = document.Information;
// IronPDF: pdf.MetaData
var info = pdf.MetaData;
' PdfPig: document.Information
Dim info = document.Information
' IronPDF: pdf.MetaData
Dim info = pdf.MetaData
页数属性更改
// PdfPig: document.NumberOfPages
Console.WriteLine($"Pages: {document.NumberOfPages}");
// IronPDF: pdf.PageCount
Console.WriteLine($"Pages: {pdf.PageCount}");
// PdfPig: document.NumberOfPages
Console.WriteLine($"Pages: {document.NumberOfPages}");
// IronPDF: pdf.PageCount
Console.WriteLine($"Pages: {pdf.PageCount}");
' PdfPig: document.NumberOfPages
Console.WriteLine($"Pages: {document.NumberOfPages}")
' IronPDF: pdf.PageCount
Console.WriteLine($"Pages: {pdf.PageCount}")
迁移后的新功能
迁移到IronPDF后,您将获得PdfPig无法提供的功能:
PDF 合并
var pdf1 = PdfDocument.FromFile("document1.pdf");
var pdf2 = PdfDocument.FromFile("document2.pdf");
var merged = PdfDocument.Merge(pdf1, pdf2);
merged.SaveAs("merged.pdf");
var pdf1 = PdfDocument.FromFile("document1.pdf");
var pdf2 = PdfDocument.FromFile("document2.pdf");
var merged = PdfDocument.Merge(pdf1, pdf2);
merged.SaveAs("merged.pdf");
Dim pdf1 = PdfDocument.FromFile("document1.pdf")
Dim pdf2 = PdfDocument.FromFile("document2.pdf")
Dim merged = PdfDocument.Merge(pdf1, pdf2)
merged.SaveAs("merged.pdf")
水印
pdf.ApplyWatermark("<h2 style='color:red;'>CONFIDENTIAL</h2>");
pdf.ApplyWatermark("<h2 style='color:red;'>CONFIDENTIAL</h2>");
pdf.ApplyWatermark("<h2 style='color:red;'>CONFIDENTIAL</h2>")
密码保护
pdf.SecuritySettings.UserPassword = "userpassword";
pdf.SecuritySettings.OwnerPassword = "ownerpassword";
pdf.SecuritySettings.UserPassword = "userpassword";
pdf.SecuritySettings.OwnerPassword = "ownerpassword";
pdf.SecuritySettings.UserPassword = "userpassword"
pdf.SecuritySettings.OwnerPassword = "ownerpassword"
数字签名
var signature = new PdfSignature("certificate.pfx", "password")
{
SigningContact = "support@company.com",
SigningReason = "Document Approval"
};
pdf.Sign(signature);
var signature = new PdfSignature("certificate.pfx", "password")
{
SigningContact = "support@company.com",
SigningReason = "Document Approval"
};
pdf.Sign(signature);
Dim signature As New PdfSignature("certificate.pfx", "password") With {
.SigningContact = "support@company.com",
.SigningReason = "Document Approval"
}
pdf.Sign(signature)
功能对比摘要
| 特征 | PdfPig | IronPDF |
|---|---|---|
| 文本提取 | ✓ | ✓ |
| 元数据访问 | ✓ | ✓ |
| 图像提取 | ✓ | ✓ |
| PDF 创建 | 有限的 | ✓ |
| HTML 至 PDF | ✗ | ✓ |
| URL 至 PDF | ✗ | ✓ |
| 合并 PDF | ✗ | ✓ |
| 拆分 PDF | ✗ | ✓ |
| 水印 | ✗ | ✓ |
| 表格填写 | ✗ | ✓ |
| 密码保护 | ✗ | ✓ |
| 数字签名 | ✗ | ✓ |
| 词位数据 | ✓ | ✗ |
迁移清单
迁移前
- 清点代码库中所有PdfPig的使用情况
- 确定是否需要词级位置数据(考虑混合方法)
- 注意所有页面索引引用(需要将基于 1 的索引转换为基于 0 的索引)
- 规划IronPDF许可证密钥存储(建议使用环境变量)
- 先使用IronPDF试用许可证进行测试
软件包变更
- 移除
PdfPigNuGet 包:dotnet remove package PdfPig安装IronPdfNuGet 包:dotnet add package IronPdf
代码更改
- 更新命名空间导入(
using UglyToad.PdfPig;→using IronPdf;) - 将
PdfDocument.Open()替换为PdfDocument.FromFile() - 将
document.Information替换为pdf.MetaData - 将
document.NumberOfPages替换为pdf.PageCount - 将页面索引从基于 1 的索引转换为基于 0 的索引
- 删除
using语句(可选,IronPDF 不需要它们) - 在应用程序启动时添加IronPDF许可证密钥
后迁移
- 测试文本提取输出符合预期
- 测试所有 PDF 生成场景
- 根据需要添加新功能(合并、水印、安全)。
- 如果部署到 Linux,请安装 Linux 依赖项

