PDFBox 处理附件

2025年3月17日 | 阅读 3 分钟

PDF 文档可以通过文件系统或远程位置的 URL 引用外部文件。也可以将二进制文件嵌入到 PDF 文档中。

Apache PDFBox 提供了以下可用于引用文件的类。

Class	描述
PDSimpleFileSpecification	它是一个指向文件的简单字符串引用。 PDSimpleFileSpecification 类不允许设置任何参数。
PDComplexFileSpecification	它是一个功能更丰富的类，允许对文件引用进行高级设置。

在 PDFBox 中，也可以将文件直接嵌入到 PDF 文档中。这可以通过使用 EmbeddedFile 属性而不是设置 PDComplexFileSpecification 类的文件属性来执行。

将文件嵌入到 PDF 文档中

PDF 文档可以包含文件附件。可以从 文档 -> 文件附件 菜单访问文件附件。 PDFBox 允许我们在 PDF 文档中添加附件，并从 PDF 文档中提取这些附件。在 PDFBox 中，附件是附加到文档目录的命名树的一部分。

以下是将附件添加到 PDF 文件的逐步过程。

加载现有文档

我们可以使用静态 load () 方法加载现有的 PDF 文档。此方法接受一个 文件对象作为参数。我们也可以使用 PDFBox 的类名 PDDocument 调用它。

File file = new File("PATH"); 
PDDocument doc = PDDocument.load(file); 

实例化 PDDocumentNameDictionary

在此，附件作为文档目录中“名称”字典的一部分存储。

PDDocumentNameDictionary names = new DdocumentNameDictionary (doc.getDocumentCatalog());

检索现有附件并添加新附件

PDEmbeddedFilesNameTreeNode efTree = names.getEmbeddedFiles();
 Map existedNames = efTree.getNames();

创建文件规范，该规范保存嵌入的文件

PDComplexFileSpecification fs = new PDComplexFileSpecification();
        fs.setFile( "Test.txt" );
        InputStream is = ...;
        PDEmbeddedFile ef = new PDEmbeddedFile(doc, is );

示例-

import org.apache.pdfbox.pdmodel.*;
import org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification;
import org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile;
import org.apache.pdfbox.pdmodel.font.PDType1Font;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.util.*;

public class AddingAttachments {
	public static void main(String[] args)throws IOException {
				
		try (final PDDocument doc = new PDDocument()){

            PDPage page = new PDPage();
doc.addPage(page);

          PDPageContentStream contentStream = new PDPageContentStream(doc, page);

contentStream.beginText();
contentStream.setFont(PDType1Font.HELVETICA, 12);
contentStream.newLineAtOffset(100, 700);
contentStream.showText("Go to Document -> File Attachments to View Embedded Files");
contentStream.endText();
contentStream.close();

// embedded files are stored in a named tree
            PDEmbeddedFilesNameTreeNode efTree = new PDEmbeddedFilesNameTreeNode();

// first create the file specification, which holds the embedded file
            PDComplexFileSpecification fs = new PDComplexFileSpecification();
fs.setFile("example-document.txt");

// create a dummy file stream, this would probably normally be a FileInputStream
byte[] data = "This is the contents of the embedded file".getBytes("ISO-8859-1");
            ByteArrayInputStream fakeFile = new ByteArrayInputStream(data);

// now lets some of the optional parameters
            PDEmbeddedFile ef = new PDEmbeddedFile(doc, fakeFile);
ef.setSubtype("text/plain");
ef.setSize(data.length);
ef.setCreationDate(Calendar.getInstance());
fs.setEmbeddedFile(ef);

// create a new tree node and add the embedded file 
            PDEmbeddedFilesNameTreeNode treeNode = new PDEmbeddedFilesNameTreeNode();
treeNode.setNames(Collections.singletonMap("My first attachment",  fs));

// add the new node as kid to the root node
            List<PDEmbeddedFilesNameTreeNode>kids = new ArrayList<PDEmbeddedFilesNameTreeNode>();
kids.add(treeNode);
efTree.setKids(kids);

// add the tree to the document catalog
            PDDocumentNameDictionary names = new PDDocumentNameDictionary(doc.getDocumentCatalog());
names.setEmbeddedFiles(efTree);
doc.getDocumentCatalog().setNames(names);

doc.save(new File("/eclipse-workspace/embedded-file.pdf"));
            System.out.println("Embaded PDF file is created");
        } catch (IOException e){
       System.err.println("Exception while trying to create pdf document - " + e);
      }
   }
}

输出

下一个主题PDFBox 将图像插入到 PDF 文档中

PDFBox 处理附件

将文件嵌入到 PDF 文档中

加载现有文档

实例化 PDDocumentNameDictionary

检索现有附件并添加新附件

创建文件规范，该规范保存嵌入的文件

示例-

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

PDFBox 教程

PDFBox 处理附件

将文件嵌入到 PDF 文档中

加载现有文档

实例化 PDDocumentNameDictionary

检索现有附件并添加新附件

创建文件规范，该规范保存嵌入的文件

示例-

相关帖子

加载现有文档

提取电话号码

使用元数据

添加多行

PDFBox 删除页面

PDFBox 环境设置

PDFBox 教程

PDFBox 添加文本

PDFBox 插入图片

拆分 PDF 文档

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器