Spring Boot 實現 PDF 水印，實戰來了！

来源:https://www.cnblogs.com/javastack/archive/2023/11/02/17805672.html
-Advertisement-
Play Games

來源：cnblogs.com/hushaojun/p/16285486.html 簡介 PDF（Portable Document Format，攜帶型文檔格式）是一種流行的文件格式，它可以在多個操作系統和應用程式中進行查看和列印。在某些情況下，我們需要對 PDF 文件添加水印，以使其更具有辨識度或 ...


來源：cnblogs.com/hushaojun/p/16285486.html

簡介

PDF（Portable Document Format，攜帶型文檔格式）是一種流行的文件格式，它可以在多個操作系統和應用程式中進行查看和列印。在某些情況下，我們需要對 PDF 文件添加水印，以使其更具有辨識度或者保護其版權。本文將介紹如何使用 Spring Boot 來實現 PDF 添加水印的方式。

方式一：使用 Apache PDFBox 庫

PDFBox 是一個流行的、免費的、用 Java 編寫的庫，它可以用來創建、修改和提取 PDF 內容。PDFBox 提供了許多 API，包括添加文本水印的功能。

推薦一個開源免費的 Spring Boot 實戰項目：

https://github.com/javastacks/spring-boot-best-practice

添加 PDFBox 依賴

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

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

添加水印

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

PDDocument document = PDDocument.load(new File("original.pdf"));

然後，遍歷 PDF 中的所有頁面，並使用 PDPageContentStream 添加水印：

// 遍歷 PDF 中的所有頁面
for (int i = 0; i < document.getNumberOfPages(); i++) {
    PDPage page = document.getPage(i);
    PDPageContentStream contentStream = new PDPageContentStream(document, page, PDPageContentStream.AppendMode.APPEND, true, true);

    // 設置字體和字型大小
    contentStream.setFont(PDType1Font.HELVETICA_BOLD, 36);

    // 設置透明度
    contentStream.setNonStrokingColor(200, 200, 200);

    // 添加文本水印
    contentStream.beginText();
    contentStream.newLineAtOffset(100, 100); // 設置水印位置
    contentStream.showText("Watermark"); // 設置水印內容
    contentStream.endText();

    contentStream.close();
}

最後，需要保存修改後的 PDF 文件：

document.save(new File("output.pdf"));
document.close();

完整代碼

下麵是使用 PDFBox 來實現 PDF 添加水印的完整代碼：

import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.font.PDType1Font;

import java.io.File;
import java.io.IOException;

public class PdfBoxWatermark {
    public static void main(String[] args) throws IOException {
        // 讀取原始 PDF 文件
        PDDocument document = PDDocument.load(new File("original.pdf"));

        // 遍歷 PDF 中的所有頁面
        for (int i = 0; i < document.getNumberOfPages(); i++) {
            PDPage page = document.getPage(i);
            PDPageContentStream contentStream = new PDPageContentStream(document, page, PDPageContentStream.AppendMode.APPEND, true, true);

            // 設置字體和字型大小
            contentStream.setFont(PDType1Font.HELVETICA_BOLD, 36);

            // 設置透明度
            contentStream.setNonStrokingColor(200, 200, 200);

            // 添加文本水印
            contentStream.beginText();
            contentStream.newLineAtOffset(100, 100); // 設置水印位置
            contentStream.showText("Watermark"); // 設置水印內容
            contentStream.endText();

            contentStream.close();
        }

        // 保存修改後的 PDF 文件
        document.save(new File("output.pdf"));
        document.close();
    }
}

方式二：使用 iText 庫

iText 是一款流行的 Java PDF 庫，它可以用來創建、讀取、修改和提取 PDF 內容。iText 提供了許多 API，包括添加文本水印的功能。

添加 iText 依賴

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

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

添加水印

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

PdfReader reader = new PdfReader("original.pdf");
PdfStamper stamper = new PdfStamper(reader, new FileOutputStream("output.pdf"));

然後，遍歷 PDF 中的所有頁面，並使用 PdfContentByte 添加水印：

// 獲取 PDF 中的頁數
int pageCount = reader.getNumberOfPages();

// 添加水印
for (int i = 1; i <= pageCount; i++) {
    PdfContentByte contentByte = stamper.getUnderContent(i); // 或者 getOverContent()
    contentByte.beginText();
    contentByte.setFontAndSize(BaseFont.createFont(), 36f);
    contentByte.setColorFill(BaseColor.LIGHT_GRAY);
    contentByte.showTextAligned(Element.ALIGN_CENTER, "Watermark", 300, 400, 45);
    contentByte.endText();
}

最後，需要保存修改後的 PDF 文件並關閉文件流：

stamper.close();
reader.close();

完整代碼

下麵是使用 iText 來實現 PDF 添加水印的完整代碼：

import com.itextpdf.text.*;
import com.itextpdf.text.pdf.*;

import java.io.FileOutputStream;
import java.io.IOException;

public class ItextWatermark {
    public static void main(String[] args) throws IOException, DocumentException {
        // 讀取原始 PDF 文件
        PdfReader reader = new PdfReader("original.pdf");
        PdfStamper stamper = new PdfStamper(reader, new FileOutputStream("output.pdf"));

        // 獲取 PDF 中的頁數
        int pageCount = reader.getNumberOfPages();

        // 添加水印
        for (int i = 1; i <= pageCount; i++) {
            PdfContentByte contentByte = stamper.getUnderContent(i); // 或者 getOverContent()
            contentByte.beginText();
            contentByte.setFontAndSize(BaseFont.createFont(), 36f);
            contentByte.setColorFill(BaseColor.LIGHT_GRAY);
            contentByte.showTextAligned(Element.ALIGN_CENTER, "Watermark", 300, 400, 45);
            contentByte.endText();
        }

        // 保存修改後的 PDF 文件並關閉文件流
        stamper.close();
        reader.close();
    }
}

方式三：用 Ghostscript 命令行

Ghostscript 是一款流行的、免費的、開源的 PDF 處理程式，它可以用來創建、讀取、修改和提取 PDF 內容。Ghostscript 中提供了命令行參數來添加水印。

Ghostscript

首先需要在本地安裝 Ghostscript 程式。可通過以下鏈接下載安裝包：

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

添加水印

可以在終端中使用 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 文件的路徑；中間的字元串則表示添加的水印內容。

註意事項

使用 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 也支持添加文本水印以及圖片水印。

添加 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>

添加文本水印

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

PdfDocument pdf = new PdfDocument();
pdf.loadFromFile("original.pdf");

然後，遍歷 PDF 中的所有頁面，並使用 PdfPageBase 添加水印：

// 遍歷 PDF 中的所有頁面
for (int i = 0; i < pdf.getPages().getCount(); i++) {
    PdfPageBase page = pdf.getPages().get(i);

    // 添加文本水印
    PdfWatermark watermark = new PdfWatermark("Watermark");
    watermark.setFont(new PdfFont(PdfFontFamily.Helvetica, 36));
    watermark.setOpacity(0.5f);
    page.getWatermarks().add(watermark);
}

最後，需要保存修改後的 PDF 文件：

pdf.saveToFile("output.pdf");
pdf.close();

添加圖片水印

添加圖片水印與添加文本水印類似，只需要將 PdfWatermark 的參數修改為圖片路徑即可。

// 添加圖片水印
PdfWatermark watermark = new PdfWatermark("watermark.png");
watermark.setOpacity(0.5f);
page.getWatermarks().add(watermark);

完整代碼

下麵是使用 Free Spire.PDF for Java 來實現 PDF 添加水印的完整代碼：

import com.spire.pdf.*;

public class FreeSpirePdfWatermark {
    public static void main(String[] args) {
        // 讀取原始 PDF 文件
        PdfDocument pdf = new PdfDocument();
        pdf.loadFromFile("original.pdf");

        // 遍歷 PDF 中的所有頁面
        for (int i = 0; i < pdf.getPages().getCount(); i++) {
            PdfPageBase page = pdf.getPages().get(i);

            // 添加文本水印
            PdfWatermark watermark = new PdfWatermark("Watermark");
            watermark.setFont(new PdfFont(PdfFontFamily.Helvetica, 36));
            watermark.setOpacity(0.5f);
            page.getWatermarks().add(watermark);

            // 添加圖片水印
            // PdfWatermark watermark = new PdfWatermark("watermark.png");
            // watermark.setOpacity(0.5f);
            // page.getWatermarks().add(watermark);
        }

        // 保存修改後的 PDF 文件
        pdf.saveToFile("output.pdf");
        pdf.close();
    }
}

方式五：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 水印。

添加文本水印

@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());
}

註意，以上代碼中的文件名、寬度、高度等參數需要根據實際情況進行調整。

完整代碼

完整的 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。

  1. 下載並安裝 Postman。
  2. 打開 Postman，選擇 POST 請求方法。
  3. 在 URL 地址欄中輸入 http://localhost:8080/api/pdf/addTextWatermark。
  4. 在 Headers 標簽頁中設置 Content-Type 為 multipart/form-data。
  5. 在 Body 標簽頁中選擇 form-data 類型，然後設置 key 為 file，value 選擇本地的 PDF 文件。
  6. 點擊 Send 按鈕發送請求，等待應答結果。

處理結果將會在響應的 Body 中返回，也可以選擇瀏覽器下載或保存到本地磁碟。

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

結論

本文介紹了幾種使用 Spring Boot 實現 PDF 添加水印的方式，分別是使用 Apache PDFBox 庫、iText 庫以及 Ghostscript 命令行等。選擇哪種方式，可以根據項目需求和個人偏好來決定。無論採用哪種方式，都需要註意保護原始 PDF 文件，不要在不必要的情況下直接修改原始文件。歡迎點贊收藏，在你老闆安排你乾這時，希望你能夠及時找到相關的Java工具庫，實現這項功能。

近期熱文推薦：

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆！Java 協程要來了。。。

3.Spring Boot 2.x 教程，太全了！

4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！

5.《Java開發手冊（嵩山版）》最新發佈，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Python 正則表達式（RegEx）指南
    正則表達式（RegEx）是一系列字元，形成了一個搜索模式。RegEx 可用於檢查字元串是否包含指定的搜索模式。 RegEx 模塊 Python 中有一個內置的包叫做 re，它可以用於處理正則表達式。導入 re 模塊： import re Python 中的 RegEx，一旦導入了 re 模塊，您就可 ...
  • 常用集合線程安全分析
    ArrayList在多線程情況下，不安全 具體代碼 package com.shaonian.juc.list_thread_secure; import java.util.ArrayList; import java.util.List; import java.util.UUID; /** * ...
  • JUC併發編程學習筆記（四）8鎖現象
    8鎖現象 八鎖->就是關於鎖的八個問題 鎖是什麼，如何判斷鎖的是誰 對象、class模板 深刻理解鎖 鎖的東西無外乎就兩樣：1、同步方法的調用者，2、Class模板。 同一個鎖中，只有當前線程資源釋放後才會被下一個線程所接手。 同步方法的調用者是兩個不同的實例時，互不相關。 靜態同步方法(stati ...
  • JUC併發編程學習筆記（三）生產者和消費者問題
    生產者和消費者問題 synchronized版-> wait/notify juc版->Lock 面試：單例模式、排序演算法、生產者和消費者、死鎖 生產者和消費者問題 Synchronized版 package org.example.pc; public class A { public stati ...
  • JUC併發編程學習筆記（二）Lock鎖(重點)
    Lock鎖(重點) 傳統的synchronized 傳統的解決多線程併發導致的一些問題我們會使用synchronized關鍵字來解決，synchronized的本質就是隊列、鎖。 Lock的實現類有：可重覆鎖（最常用）、讀鎖、寫鎖 在創建可重覆鎖時，可傳入boolean類型值來決定該鎖是公平鎖（先來 ...
  • Educational Codeforces Round 134 (Div.2) D 題解
    進程和線程 進程 一個程式，如QQ.exe，是程式的集合 一個進程往往可以包含多個線程，至少包含一個 java預設有兩個線程，GC垃圾回收線程和Main線程 線程：一個進程中的各個功能 java無法真正的開啟線程，因為java是運行在虛擬機上的，所以只能通過C++,通過native本地方法調用C++ ...
  • 編譯原理
    Java 程式員或者是 Java 工程師在逐漸成長為高級開發的時候，他 看問題的方式寫工作的方式都有自己的一套方式。每個人的工作效率不一樣，但是都要達到同一個目的。對於開發 任務而言，測試通過是最低的要求。Java 的集成開發環境十分優秀，從西方美國的 Eclipse 到歐洲的 Idea，程式員開發 ...
  • 大數據
    寫程式軟體處理用戶量和數據量。用戶量一大，併發量線程安全問題就會出現。軟體一開始是 使用 C/S 的應用架構模式。客戶端和伺服器端通過互聯網相互訪問。Windows 的客戶端軟體通過 C++編寫出來，不同的操作系統支持的客戶端軟體編寫語言不一樣。B/S 架構模式現在很受大眾的歡迎，一臺電腦的應用可 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類