SpringBoot实现PDF水印添加的五种高效方案，轻松上手！

Yaml墨韵

已于 2024-04-15 11:08:37 修改

阅读量1.1k

点赞数 32

分类专栏： springboot 文章标签： spring boot pdf 后端

于 2024-04-15 11:08:13 首次发布

本文链接：https://blog.csdn.net/Yaml4/article/details/137770714

版权

springboot 专栏收录该内容

96 篇文章 1 订阅

订阅专栏

简介

方式一：使用 Apache PDFBox 库

方式三：用 Ghostscript 命令行

1. Ghostscript

2. 添加水印

3. 注意事项

方式四：Free Spire.PDF for Java

1. 添加 Free Spire.PDF for Java 依赖

方式五：Aspose.PDF for Java

简介

PDF（Portable Document Format，便携式文档格式）是一种流行的文件格式，它可以在多个操作系统和应用程序中进行查看和打印。在某些情况下，我们需要对 PDF 文件添加水印，以使其更具有辨识度或者保护其版权。

“

本文将介绍如何使用 Spring Boot 来实现 PDF 添加水印的方式。PS：当然，只是笔者使用Spring Boot 测试，Java代码均可实现，并不是非要在 spring Boot 上实现哦！

方式一：使用 Apache PDFBox 库

PDFBox 是一个流行的、免费的、用 Java 编写的库，它可以用来创建、修改和提取 PDF 内容。PDFBox 提供了许多 API，包括添加文本水印的功能。

1. 添加 PDFBox 依赖

首先，在 pom.xml 文件中添加 PDFBox 的依赖：

<dependency>
    <groupId>org.apache.pdfbox</groupId>
    <artifactId>pdfbox</artifactId>
    <version>2.0.24</version>
</dependency>

2. 添加水印

编写服务类

创建一个服务类来封装 PDF 添加水印的逻辑：

import org.apache.pdfbox.pdmodel.PDDocument;  
import org.apache.pdfbox.pdmodel.PDPage;  
import org.apache.pdfbox.pdmodel.PDPageContentStream;  
import org.apache.pdfbox.pdmodel.common.PDRectangle;  
import org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject;  
import org.springframework.stereotype.Service;  
  
import java.io.File;  
import java.io.IOException;  
  
@Service  
public class PdfWatermarkService {  
  
    public void addWatermarkToPdf(String inputPdfPath, String outputPdfPath, String watermarkImagePath, float scale) throws IOException {  
        try (PDDocument document = PDDocument.load(new File(inputPdfPath))) {  
            PDImageXObject pdImage = PDImageXObject.createFromFile(watermarkImagePath, document);  
              
            for (PDPage page : document.getPages()) {  
                PDRectangle mediaBox = page.getMediaBox();  
                float imageWidth = pdImage.getWidth() * scale;  
                float imageHeight = pdImage.getHeight() * scale;  
                float xPosition = (mediaBox.getWidth() - imageWidth) / 2;  
                float yPosition = (mediaBox.getHeight() - imageHeight) / 2;  
  
                try (PDPageContentStream contentStream = new PDPageContentStream(document, page, PDPageContentStream.AppendMode.APPEND, true, true)) {  
                    contentStream.drawImage(pdImage, xPosition, yPosition, imageWidth, imageHeight);  
                }  
            }  
              
            document.save(outputPdfPath);  
        }  
    }  
}

调用服务

在你的控制器或其他业务逻辑中调用上述服务

@RestController  
public class PdfController {  
  
    @Autowired  
    private PdfWatermarkService pdfWatermarkService;  
  
    @PostMapping("/add-watermark")  
    public ResponseEntity<String> addWatermarkToPdf(@RequestParam("inputPdf") String inputPdfPath,  
                                                       @RequestParam("outputPdf") String outputPdfPath,  
                                               @RequestParam("watermarkImage") String watermarkImagePath,  
                                               @RequestParam(defaultValue = "0.5") float scale) {  
        try {  
            pdfWatermarkService.addWatermarkToPdf(inputPdfPath, outputPdfPath, watermarkImagePath, scale);  
            return ResponseEntity.ok("Watermark added successfully.");  
        } catch (IOException e) {  
            e.printStackTrace();  
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Error adding watermark: " + e.getMessage());  
        }  
    }  
}

方式二：使用 iText 库

iText 是一款流行的 Java PDF 库，它可以用来创建、读取、修改和提取 PDF 内容。iText 提供了许多 API，包括添加文本水印的功能。

1. 添加 iText 依赖

请注意，iText 7 及之后的版本采用了不同的许可模型，其中一些功能可能需要商业许可。如果你的应用是商业的，请确保遵守 iText 的许可协议。

在 pom.xml 文件中添加 iText 的依赖：

<dependency>
    <groupId>com.itextpdf</groupId>
    <artifactId>itextpdf</artifactId>
    <version>5.5.13</version>
</dependency>

2. 添加水印

在添加水印之前，需要读取原始 PDF 文件：

编写服务类

创建一个服务类来封装 PDF 添加水印的逻辑：

import com.itextpdf.kernel.geom.Rectangle;  
import com.itextpdf.kernel.pdf.*;  
import com.itextpdf.layout.Document;  
import com.itextpdf.layout.element.Image;  
import com.itextpdf.layout.property.HorizontalAlignment;  
import com.itextpdf.layout.property.VerticalAlignment;  
import org.springframework.stereotype.Service;  
  
import java.io.File;  
import java.io.FileInputStream;  
import java.io.FileOutputStream;  
import java.io.IOException;  
  
@Service  
public class PdfWatermarkService {  
  
    public void addWatermarkToPdf(String inputPdfPath, String outputPdfPath, String watermarkImagePath) throws IOException {  
        PdfReader reader = new PdfReader(new FileInputStream(inputPdfPath));  
        PdfWriter writer = new PdfWriter(new FileOutputStream(outputPdfPath));  
        PdfDocument pdfDoc = new PdfDocument(reader, writer);  
  
        // 加载水印图片  
        ImageData imageData = ImageDataFactory.create(watermarkImagePath);  
        Image watermarkImage = new Image(imageData);  
        watermarkImage.scaleToFit(pdfDoc.getFirstPage().getPageSize().getWidth() / 3, pdfDoc.getFirstPage().getPageSize().getHeight() / 3);  
        watermarkImage.setFixedPosition(1, pdfDoc.getFirstPage().getPageSize().getWidth() / 2, pdfDoc.getFirstPage().getPageSize().getHeight() / 2);  
  
        // 遍历每一页并添加水印  
        for (int i = 1; i <= pdfDoc.getNumberOfPages(); i++) {  
            PdfPage page = pdfDoc.getPage(i);  
            new Canvas(pdfDoc.getFirstPage().newContentStreamBefore(), pdfDoc, page.getPageSize())  
                    .add(watermarkImage.setFixedPosition(i, page.getPageSize().getWidth() / 2, page.getPageSize().getHeight() / 2))  
                    .close();  
        }  
  
        pdfDoc.close();  
    }  
}

在上面的代码中，我们创建了一个 PdfWatermarkService 类，它有一个 addWatermarkToPdf 方法，该方法接受输入 PDF 文件的路径、输出 PDF 文件的路径和水印图片的路径作为参数。方法内部，我们使用了 PdfReader 和 PdfWriter 来读取和写入 PDF 文件，并使用 Canvas 和 Image 类来添加水印。

调用服务

在你的控制器或其他业务逻辑中调用上述服务：

import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.http.ResponseEntity;  
import org.springframework.web.bind.annotation.PostMapping;  
import org.springframework.web.bind.annotation.RequestParam;  
import org.springframework.web.bind.annotation.RestController;  
  
import java.io.IOException;  
  
@RestController  
public class PdfController {  
  
    @Autowired  
    private PdfWatermarkService pdfWatermarkService;  
  
    @PostMapping("/add-watermark")  
    public ResponseEntity<String> addWatermarkToPdf(@RequestParam("inputPdf") String inputPdfPath,  
                                                     @RequestParam("outputPdf") String outputPdfPath,  
                                                   @RequestParam("watermarkImage") String watermarkImagePath) {  
        try {  
            pdfWatermarkService.addWatermarkToPdf(inputPdfPath, outputPdfPath, watermarkImagePath);  
            return ResponseEntity.ok("Watermark added successfully.");  
        } catch (IOException e) {  
            e.printStackTrace();  
            return ResponseEntity.status(500).body("Error adding watermark: " + e.getMessage());  
        }  
    }  
}

方式三：用 Ghostscript 命令行

Ghostscript 是一款流行的、免费的、开源的 PDF 处理程序，它可以用来创建、读取、修改和提取 PDF 内容。Ghostscript 中提供了命令行参数来添加水印。

1. Ghostscript

首先需要在本地安装 Ghostscript 程序。可通过以下链接下载安装包：

Windows[1]
macOS[2]
Linux[3]

2. 添加水印

可以在终端中使用 Ghostscript 的命令行工具执行以下命令来实现：

gs -dBATCH -dNOPAUSE -sDEVICE=pdfwrite -sOutputFile=output.pdf -c "newpath /Helvetica-Bold findfont 36 scalefont setfont 0.5 setgray 200 200 moveto (Watermark) show showpage" original.pdf

上述命令中，-sDEVICE=pdfwrite 表示输出为 PDF 文件；-sOutputFile=output.pdf 表示输出文件名为 output.pdf；最后一个参数 original.pdf 则表示原始 PDF 文件的路径；中间的字符串则表示添加的水印内容。

3. 注意事项

使用 Ghostscript 命令行添加水印时，会直接修改原始 PDF 文件，因此建议先备份原始文件。

方式四：Free Spire.PDF for Java

下面介绍一下使用 Free Spire.PDF for Java 实现 PDF 添加水印的方式。

Free Spire.PDF for Java 是一款免费的 Java PDF 库，它提供了一个简单易用的 API，用于创建、读取、修改和提取 PDF 内容。Free Spire.PDF for Java 也支持添加文本水印以及图片水印。

1. 添加 Free Spire.PDF for Java 依赖

首先，在 pom.xml 文件中添加 Free Spire.PDF for Java 的依赖：

<dependency>
    <groupId>e-iceblue</groupId>
    <artifactId>free-spire-pdf-for-java</artifactId>
    <version>1.9.6</version>
</dependency>

确保你使用的是最新版本，并遵循 e-iceblue 的许可协议。

2. 添加水印

2.1 添加文本水印

在添加水印之前，需要读取原始 PDF 文件：

编写服务类

import com.eiceblue.spire.pdf.*;  
import com.eiceblue.spire.pdf.graphics.*;  
  
import java.awt.*;  
import java.io.File;  
import java.io.IOException;  
  
@Service  
public class PdfWatermarkService {  
  
    public void addTextWatermarkToPdf(String inputPdfPath, String outputPdfPath, String watermarkText) throws IOException {  
        // 加载 PDF 文档  
        PdfDocument pdf = new PdfDocument();  
        pdf.loadFromFile(inputPdfPath);  
  
        // 字体样式  
        PdfTrueTypeFont font = new PdfTrueTypeFont(new File("path_to_font.ttf"), PdfFontStyles.Bold, 24);  
  
        // 遍历所有页面并添加文本水印  
        for (int i = 0; i < pdf.getPages().getCount(); i++) {  
            PdfPageBase page = pdf.getPages().get(i);  
  
            // 创建一个 Canvas 对象，用于绘制文本  
            PdfCanvas canvas = page.getCanvas();  
  
            // 设置文本格式  
            PdfSolidBrush brush = new PdfSolidBrush(new PdfRGBColor(255, 255, 255)); // 白色文本  
            PdfStringFormat format = new PdfStringFormat();  
            format.setAlignment(PdfTextAlignment.Center);  
            format.setVerticalAlignment(PdfVerticalTextAlignment.Center);  
  
            // 计算文本的位置  
            float x = (page.getSize().getWidth() - font.getMeasureString(watermarkText, format).getWidth()) / 2;  
            float y = (page.getSize().getHeight() - font.getMeasureString(watermarkText, format).getHeight()) / 2;  
  
            // 在页面上绘制文本  
            canvas.drawString(watermarkText, font, brush, x, y, format);  
        }  
  
        // 保存带水印的 PDF  
        pdf.saveToFile(outputPdfPath);  
  
        // 释放资源  
        pdf.dispose();  
    }  
}

调用服务

2.2 添加图片水印

添加图片水印的过程与添加文本水印类似，但你需要使用 PdfImageObject 来绘制图片。

编写服务类

import com.eiceblue.spire.pdf.*;  
import com.eiceblue.spire.pdf.graphics.PdfImageObject;  
  
import java.awt.image.BufferedImage;  
import java.io.File;  
import java.io.IOException;  
import javax.imageio.ImageIO;  
  
@Service  
public class PdfWatermarkService {  
  
    public void addImageWatermarkToPdf(String inputPdfPath, String outputPdfPath, String watermarkImagePath) throws IOException {  
        // 加载 PDF 文档  
        PdfDocument pdf = new PdfDocument();  
        pdf.loadFromFile(inputPdfPath);  
  
        // 加载水印图片  
        BufferedImage watermarkImage = ImageIO.read(new File(watermarkImagePath));  
        PdfImage pdfImage = PdfImageObject.fromImage(pdf, watermarkImage);  
  
        // 遍历所有页面并添加图片水印  
        for (int i = 0; i < pdf.getPages().getCount(); i++) {  
            PdfPageBase page = pdf.getPages().get(i);  
  
            // 设置水印的位置  
            float x = (page.getSize().getWidth() - pdfImage.getWidth()) / 2;  
            float y = (page.getSize().getHeight() - pdfImage.getHeight()) / 2;  
  
            // 在页面上绘制图片水印  
            page.getCanvas().drawImage(pdfImage, x, y);  
        }  
  
        // 保存带水印的 PDF  
        pdf.saveToFile(outputPdfPath);  
  
        // 释放资源  
        pdf.dispose();  
    }  
}

调用服务

import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.http.ResponseEntity;  
import org.springframework.web.bind.annotation.PostMapping;  
import org.springframework.web.bind.annotation.RequestParam;  
import org.springframework.web.bind.annotation.RestController;  
  
import java.io.IOException;  
  
@RestController  
public class PdfController {  
  
    @Autowired  
    private PdfWatermarkService pdfWatermarkService;  
  
    @PostMapping("/add-image-watermark")  
    public ResponseEntity<String> addImageWatermarkToPdf(@RequestParam("inputPdf") String inputPdfPath,  
                                                           @RequestParam("outputPdf") String outputPdfPath,  
                                                           @RequestParam("watermarkImage") String watermarkImagePath,  
                                                           @RequestParam(defaultValue = "0.5f") float opacity) {  
        try {  
            pdfWatermarkService.addImageWatermarkToPdf(inputPdfPath, outputPdfPath, watermarkImagePath, opacity);  
            return ResponseEntity.ok("Image watermark added successfully.");  
        } catch (IOException e) {  
            e.printStackTrace();  
            return ResponseEntity.status(500).body("Error adding image watermark: " + e.getMessage());  
        }  
    }  
}

在这个控制器中，我们定义了一个 /add-image-watermark 端点，它接受输入 PDF、输出 PDF、水印图片的路径和水印透明度作为请求参数。然后，它调用 PdfWatermarkService 中的 addImageWatermarkToPdf 方法来添加水印。

方式五：Aspose.PDF for Java

Aspose.PDF for Java 是一个强大的 PDF 处理库，提供了添加水印的功能。结合 Spring Boot 使用 Aspose.PDF for Java 库添加 PDF 水印的方式如下：

首先，在 pom.xml 文件中添加 Aspose.PDF for Java 的依赖：

<dependency>
    <groupId>com.aspose</groupId>
    <artifactId>aspose-pdf</artifactId>
    <version>21.4</version>
</dependency>

在 Spring Boot 应用程序中调用 Aspose.PDF for Java 的 API 设置 PDF 水印。

1. 添加文本水印

@PostMapping("/addTextWatermark")
public ResponseEntity<byte[]> addTextWatermark(@RequestParam("file") MultipartFile file) throws IOException {
    // 加载 PDF 文件
    Document pdfDocument = new Document(file.getInputStream());
    TextStamp textStamp = new TextStamp("Watermark");
    textStamp.setWordWrap(true);
    textStamp.setVerticalAlignment(VerticalAlignment.Center);
    textStamp.setHorizontalAlignment(HorizontalAlignment.Center);
    pdfDocument.getPages().get_Item(1).addStamp(textStamp);

    // 保存 PDF 文件
    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
    pdfDocument.save(outputStream);
    return ResponseEntity.ok()
            .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"watermarked.pdf\"")
            .contentType(MediaType.APPLICATION_PDF)
            .body(outputStream.toByteArray());
}

2. 添加图片水印

@PostMapping("/addImageWatermark")
public ResponseEntity<byte[]> addImageWatermark(@RequestParam("file") MultipartFile file) throws IOException {
    // 加载 PDF 文件
    Document pdfDocument = new Document(file.getInputStream());
    ImageStamp imageStamp = new ImageStamp("watermark.png");
    imageStamp.setWidth(100);
    imageStamp.setHeight(100);
    imageStamp.setVerticalAlignment(VerticalAlignment.Center);
    imageStamp.setHorizontalAlignment(HorizontalAlignment.Center);
    pdfDocument.getPages().get_Item(1).addStamp(imageStamp);

    // 保存 PDF 文件
    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
    pdfDocument.save(outputStream);
    return ResponseEntity.ok()
            .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"watermarked.pdf\"")
            .contentType(MediaType.APPLICATION_PDF)
            .body(outputStream.toByteArray());
}

注意，以上代码中的文件名、宽度、高度等参数需要根据实际情况进行调整。

3. 完整代码

完整的 Spring Boot 控制器类代码如下：

import com.aspose.pdf.*;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import java.io.ByteArrayOutputStream;
import java.io.IOException;

@RestController
@RequestMapping("/api/pdf")
public class PdfController {
    @PostMapping("/addTextWatermark")
    public ResponseEntity<byte[]> addTextWatermark(@RequestParam("file") MultipartFile file) throws IOException {
        // 加载 PDF 文件
        Document pdfDocument = new Document(file.getInputStream());
        TextStamp textStamp = new TextStamp("Watermark");
        textStamp.setWordWrap(true);
        textStamp.setVerticalAlignment(VerticalAlignment.Center);
        textStamp.setHorizontalAlignment(HorizontalAlignment.Center);
        pdfDocument.getPages().get_Item(1).addStamp(textStamp);

        // 保存 PDF 文件
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        pdfDocument.save(outputStream);
        return ResponseEntity.ok()
                .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"watermarked.pdf\"")
                .contentType(MediaType.APPLICATION_PDF)
                .body(outputStream.toByteArray());
    }

    @PostMapping("/addImageWatermark")
    public ResponseEntity<byte[]> addImageWatermark(@RequestParam("file") MultipartFile file) throws IOException {
        // 加载 PDF 文件
        Document pdfDocument = new Document(file.getInputStream());
        ImageStamp imageStamp = new ImageStamp("watermark.png");
        imageStamp.setWidth(100);
        imageStamp.setHeight(100);
        imageStamp.setVerticalAlignment(VerticalAlignment.Center);
        imageStamp.setHorizontalAlignment(HorizontalAlignment.Center);
        pdfDocument.getPages().get_Item(1).addStamp(imageStamp);

        // 保存 PDF 文件
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        pdfDocument.save(outputStream);
        return ResponseEntity.ok()
                .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"watermarked.pdf\"")
                .contentType(MediaType.APPLICATION_PDF)
                .body(outputStream.toByteArray());
    }
}

这里使用了两个 RESTful API：/addTextWatermark 和 /addImageWatermark，分别用于添加文本水印和图片水印。在请求中通过 file 参数传递 PDF 文件。

下面介绍如何使用 Postman 来测试 Spring Boot 应用程序的 API。

下载并安装 Postman。
打开 Postman，选择 POST 请求方法。
在 URL 地址栏中输入 http://localhost:8080/api/pdf/addTextWatermark。
在 Headers 标签页中设置 Content-Type 为 multipart/form-data。
在 Body 标签页中选择 form-data 类型，然后设置 key 为 file，value 选择本地的 PDF 文件。
点击 Send 按钮发送请求，等待应答结果。

处理结果将会在响应的 Body 中返回，也可以选择浏览器下载或保存到本地磁盘。

以上就是使用 Aspose.PDF for Java 库结合 Spring Boot 添加 PDF 水印的方式。

结论

本文介绍了几种使用 Spring Boot 实现 PDF 添加水印的方式，分别是使用 Apache PDFBox 库、iText 库以及 Ghostscript 命令行等。选择哪种方式，可以根据项目需求和个人偏好来决定。

无论采用哪种方式，都需要注意保护原始 PDF 文件，不要在不必要的情况下直接修改原始文件。欢迎点赞收藏，在你老板安排你干这时，希望你能够及时找到相关的Java工具库，实现这项功能。

Yaml墨韵

关注

32
点赞
踩
8

收藏

觉得还不错? 一键收藏
打赏
0
评论
SpringBoot实现PDF水印添加的五种高效方案，轻松上手！

PDF（Portable Document Format，便携式文档格式）是一种流行的文件格式，它可以在多个操作系统和应用程序中进行查看和打印。在某些情况下，我们需要对 PDF 文件添加水印，以使其更具有辨识度或者保护其版权。本文将介绍如何使用 Spring Boot 来实现 PDF 添加水印的方式。PS：当然，只是笔者使用Spring Boot 测试，Java代码均可实现，并不是非要在 spring Boot 上实现哦！
复制链接

扫一扫