PDFBox - 插入图像

在上一章中，我们了解了如何从现有 PDF 文档中提取文本。在本章中，我们将讨论如何将图像插入到 PDF 文档中。

将图像插入 PDF 文档

您可以分别使用PDImageXObject和PDPageContentStream类的createFromFile()和drawImage()方法将图像插入到PDF 文档中。

以下是从现有 PDF 文档中提取文本的步骤。

第 1 步：加载现有 PDF 文档

使用PDDocument类的静态方法load()加载现有 PDF 文档。此方法接受文件对象作为参数，因为这是一个静态方法，您可以使用类名调用它，如下所示。

File file = new File("path of the document")
PDDocument doc = PDDocument.load(file);

第 2 步：检索页面

选择 PDF 文档中的一个页面并使用getPage()方法检索其页面对象，如下所示。

PDPage page = doc.getPage(0);

第3步：创建PDImageXObject对象

PDFBox 库中的PDImageXObject类代表图像。它提供了执行与图像相关的操作所需的所有方法，例如插入图像、设置其高度、设置其宽度等。

我们可以使用createFromFile()方法创建此类的对象。对于该方法，我们需要以字符串的形式传递要添加的图像的路径以及需要添加图像的文档对象。

PDImageXObject pdImage = PDImageXObject.createFromFile("C:/logo.png", doc);

第 4 步：准备内容流

您可以使用名为PDPageContentStream的类的对象插入各种类型的数据元素。您需要将文档对象和页面对象传递给此类的构造函数，因此，通过传递在前面的步骤中创建的这两个对象来实例化此类，如下所示。

PDPageContentStream contentStream = new PDPageContentStream(doc, page);

第5步：在PDF文档中绘制图像

您可以使用drawImage()方法在PDF文档中插入图像。对于此方法，您需要添加在上述步骤中创建的图像对象以及所需的图像尺寸（宽度和高度），如下所示。

contentstream.drawImage(pdImage, 70, 250);

第 6 步：关闭 PDPageContentStream

使用close()方法关闭PDPageContentStream对象，如下所示。

contentstream.close();

第7步：保存文档

添加所需内容后，使用PDDocument类的save()方法保存 PDF 文档，如以下代码块所示。

doc.save("Path");

第 8 步：关闭文档

最后，使用PDDocument类的close()方法关闭文档，如下所示。

doc.close();

例子

假设我们有一个名为example.pdf的 PDF 文档，位于路径C:/PdfBox_Examples/中，其中有空白页面，如下所示。

样本文件

此示例演示如何将图像添加到上述 PDF 文档的空白页。在这里，我们将加载名为sample.pdf的PDF文档并向其中添加图像。将此代码保存在名为 InsertingImage.java 的文件中。

import java.io.File;
  
import org.apache.pdfbox.pdmodel.PDDocument; 
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject;

public class InsertingImage {

   public static void main(String args[]) throws Exception {
      //Loading an existing document
      File file = new File("C:/PdfBox_Examples/sample.pdf");
      PDDocument doc = PDDocument.load(file);
        
      //Retrieving the page
      PDPage page = doc.getPage(0);
       
      //Creating PDImageXObject object
      PDImageXObject pdImage = PDImageXObject.createFromFile("C:/PdfBox_Examples/logo.png",doc);
       
      //creating the PDPageContentStream object
      PDPageContentStream contents = new PDPageContentStream(doc, page);

      //Drawing the image in the PDF document
      contents.drawImage(pdImage, 70, 250);

      System.out.println("Image inserted");
      
      //Closing the PDPageContentStream object
      contents.close();		
		
      //Saving the document
      doc.save("C:/PdfBox_Examples/sample.pdf");
            
      //Closing the document
      doc.close();
     
   }
}

使用以下命令从命令提示符编译并执行保存的 Java 文件。

javac InsertingImage.java 
java InsertingImage

执行后，上述程序会将图像插入到给定 PDF 文档的指定页面中，并显示以下消息。

Image inserted

如果您验证文档sample.pdf，您可以观察到图像已插入其中，如下所示。

插入图像