PDF - JAVA 后端给 PDF 添加水印 - 《👨‍🔧 实战笔记》

demo 程序尝试
封装成工具类
前端实现参考、生成效果参考

有在线添加水印的工具，比如下面这个

JAVA 端可以使用 itextpdf 来实现

demo 程序尝试

首先添加全家桶依赖

// ~ pdf  ==========================
    implementation 'com.itextpdf:itext7-core:7.1.16'

编写

package cn.mrcode.tools.pdf_watermark;
import com.itextpdf.io.font.PdfEncodings;
import com.itextpdf.io.font.constants.StandardFonts;
import com.itextpdf.io.image.ImageData;
import com.itextpdf.io.image.ImageDataFactory;
import com.itextpdf.kernel.font.PdfFont;
import com.itextpdf.kernel.font.PdfFontFactory;
import com.itextpdf.kernel.geom.Rectangle;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfPage;
import com.itextpdf.kernel.pdf.PdfReader;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
import com.itextpdf.kernel.pdf.extgstate.PdfExtGState;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Paragraph;
import com.itextpdf.layout.property.TextAlignment;
import com.itextpdf.layout.property.VerticalAlignment;
import java.io.File;
/**
 * @author mrcode
 * @date 2021/10/21 20:57
 */
public class Demo {
    public static final String DEST = "C:\\temp\\xx2.pdf";
    public static final String IMG = "C:\\temp\\b1.png";
    public static final String SRC = "d:\\temp\xx.pdf";
    public static void main(String[] args) throws Exception {
        new Demo().manipulatePdf(DEST);
    }
    protected void manipulatePdf(String dest) throws Exception {
        PdfDocument pdfDoc = new PdfDocument(new PdfReader(SRC), new PdfWriter(dest));
        Document doc = new Document(pdfDoc);
//        PdfFont font = PdfFontFactory.createFont(StandardFonts.HELVETICA);
        // 这个实体是宋体中文字体，只有 4, m
        // 字体文件源码中只支持 afm、pfm、ttf、otf、woff、woff2，等你提供不支持的格式就会报错，点进去看源码就知道了
        // ttc 看到源码中也支持，但是提供 ttc 就报错，暂时没深入看源码如何报错
        final PdfFont font = PdfFontFactory.createFont("C:\\temp\\songti.ttf",
                // 水平书写
                PdfEncodings.IDENTITY_H,
                // 是否将字体嵌入到目标文档中
                // 该参数被  PdfFontFactory.EmbeddingStrategy.PREFER_EMBEDDED 代替，true 对应  PREFER_EMBEDDED，如果可能，嵌入字体                                      
                true);
        // 多行文本使用 \n 换行
        Paragraph paragraph = new Paragraph("My watermark (中国强text) \n 中国")
                .setFont(font)
                .setOpacity(0.1F) // 字体透明度 0-1 完全透明~不透明
                .setFontSize(30); // 字体大小
        ImageData img = ImageDataFactory.create(IMG);
        float w = img.getWidth();
        float h = img.getHeight();
        // 用于添加图片水印，设置图片水印透明度
        PdfExtGState gs1 = new PdfExtGState().setFillOpacity(0.5f);
        // Implement transformation matrix usage in order to scale image
        for (int i = 1; i <= pdfDoc.getNumberOfPages(); i++) {
            PdfPage pdfPage = pdfDoc.getPage(i);
            // 获取页面大小，考虑页面旋转
            Rectangle pageSize = pdfPage.getPageSizeWithRotation();
            // 当页面有旋转时，内容自动旋转
            pdfPage.setIgnorePageRotationForContent(true);
            // 计算添加的位置坐标
            float x = (pageSize.getLeft() + pageSize.getRight()) / 2;
            float y = (pageSize.getTop() + pageSize.getBottom()) / 2;
            // 添加图片水印使用
            PdfCanvas over = new PdfCanvas(pdfDoc.getPage(i));
            over.saveState();
            over.setExtGState(gs1);
            if (i % 2 == 1) {
                // 添加文本水印
                // 参数分别为：文本、x 坐标、y 坐标、添加到第几页、文本水平对齐方式、文本垂直对齐方式、旋转弧度
                doc.showTextAligned(paragraph, x, y, i, TextAlignment.CENTER, VerticalAlignment.TOP, 0);
            } else {
                // 添加图片水印
                over.addImageWithTransformationMatrix(img, w, 0, 0, h, x - (w / 2), y - (h / 2), false);
            }
            over.restoreState();
        }
        doc.close();
    }
}

水印生成效果：
文字水印

图片水印

宋体简体中文 ttf 字体文件（下载后将.txt 后缀去掉）：songti.ttf.txt

封装成工具类

功能：

支持垂直水平居中、页面平铺添加水印
支持添加单行/多行文本水印：字体、字号、颜色、透明度、旋转度、平铺时：水平和垂直间隔
支持添加图片水印 ```java package cn.mrcode.tools.pdf_watermark;

import com.itextpdf.io.font.PdfEncodings; import com.itextpdf.io.font.constants.StandardFonts; import com.itextpdf.io.image.ImageData; import com.itextpdf.io.image.ImageDataFactory; import com.itextpdf.kernel.colors.DeviceRgb; import com.itextpdf.kernel.font.PdfFont; import com.itextpdf.kernel.font.PdfFontFactory; import com.itextpdf.kernel.geom.Rectangle; import com.itextpdf.kernel.pdf.PdfDocument; import com.itextpdf.kernel.pdf.PdfPage; import com.itextpdf.kernel.pdf.PdfReader; import com.itextpdf.kernel.pdf.PdfWriter; import com.itextpdf.kernel.pdf.canvas.PdfCanvas; import com.itextpdf.kernel.pdf.extgstate.PdfExtGState; import com.itextpdf.layout.Document; import com.itextpdf.layout.element.Paragraph; import com.itextpdf.layout.property.TextAlignment; import com.itextpdf.layout.property.VerticalAlignment;

import java.io.IOException;

/**

PDF 水印添加 *
@author mrcode

@date 2021/10/22 21:27 / public class PdFWatermarkUtil { /*

添加文字水印；默认为居中添加 *
@param watermark
@param srcPath 原始 PDF 文件绝对路径

@param destPath 添加完水印后的 PDF 存放路径 */ public static void addWatermark(TextWatermark watermark, String srcPath, String destPath) throws IOException { PdfDocument pdfDoc = new PdfDocument(new PdfReader(srcPath), new PdfWriter(destPath)); Document doc = new Document(pdfDoc); PdfFont font = getPdfFont(watermark.getFontPath());

// 设置文字水印样式 final String text = watermark.getText(); final int fontSize = watermark.getFontSize(); Paragraph paragraph = new Paragraph(text)

     .setFont(font)

// .setFontColor(new DeviceRgb(0, 0, 0))

     .setOpacity(watermark.getOpacity()) // 字体透明度 0-1 完全透明~不透明
     .setFontSize(fontSize); // 字体大小

final String color = watermark.getColor(); // 设置 RGB 颜色 if (color != null) {

 final String[] rgbs = color.split(",");
 final DeviceRgb deviceRgb = new DeviceRgb(
         Integer.parseInt(rgbs[0].trim()),
         Integer.parseInt(rgbs[1].trim()),
         Integer.parseInt(rgbs[2].trim()));
 paragraph.setFontColor(deviceRgb);

}

// 获取水印文字宽度 final float textWidth = font.getWidth(text, fontSize); // 文字高度则是字体大小 final float textHeight = fontSize; final int tileMode = watermark.getTileMode(); final int pageModeOfHorizontalInterval = watermark.getPageModeOfHorizontalInterval() == null ? 50 : watermark.getPageModeOfHorizontalInterval(); final int pageModeOfVerticalInterval = watermark.getPageModeOfVerticalInterval() == null ? (int) textHeight : watermark.getPageModeOfVerticalInterval();

for (int i = 1; i <= pdfDoc.getNumberOfPages(); i++) {

 PdfPage pdfPage = pdfDoc.getPage(i);
 // 获取页面大小，考虑页面旋转
 Rectangle pageSize = pdfPage.getPageSizeWithRotation();
 // 当页面有旋转时，内容自动旋转
 pdfPage.setIgnorePageRotationForContent(true);
 // 水印水平垂直居中
 if (tileMode == 1) {
     // 计算添加的位置坐标：这里使用居中位置，水平垂直居中
     float x = (pageSize.getLeft() + pageSize.getRight()) / 2;
     float y = (pageSize.getTop() + pageSize.getBottom()) / 2;
     // 参数分别为：文本、x 坐标、y 坐标、添加到底几页、文本水平对齐方式、文本垂直对齐方式、旋转弧度
     doc.showTextAligned(paragraph,
             x, // 文本所在 x y 坐标，文字将围绕这个点进行对齐或则旋转
             y,
             i, // 添加到 PDF 第几页
             TextAlignment.CENTER,   // 文本水平对齐方式
             VerticalAlignment.TOP, // 文本垂直对齐方式
             // 将 角度 转换为 弧度
             (float) Math.toRadians(watermark.getRadAngle()));
 } else {
     // 水印按照设置平铺页面
     // 注意这里的坐标点是 文字中心点，所以宽度需要增加文字自己的宽度，否则会重合在一起
     for (float posX = 0f; posX < pageSize.getWidth(); posX = posX + textWidth + pageModeOfHorizontalInterval) {
         for (float posY = pageModeOfVerticalInterval; posY < pageSize.getHeight(); posY = posY + pageModeOfVerticalInterval) {
             // 参数分别为：文本、x 坐标、y 坐标、添加到底几页、文本水平对齐方式、文本垂直对齐方式、旋转弧度
             doc.showTextAligned(paragraph,
                     posX, // 文本所在 x y 坐标，文字将围绕这个点进行对齐或则旋转
                     posY,
                     i, // 添加到 PDF 第几页
                     TextAlignment.CENTER,   // 文本水平对齐方式
                     VerticalAlignment.TOP, // 文本垂直对齐方式
                     // 将 角度 转换为 弧度
                     (float) Math.toRadians(watermark.getRadAngle()));
         }
     }
 }

} doc.close(); }

/**

获取字体，支持 afm、pfm、ttf、otf、woff、woff2 字体，ttc 目前直接报错 *
@param fontPath 字体文件绝对路径，如果为空则返回默认的英文字体

@return */ private static PdfFont getPdfFont(String fontPath) throws IOException { if (fontPath == null) {

 return PdfFontFactory.createFont(StandardFonts.HELVETICA);

} return PdfFontFactory.createFont(

     fontPath,
     // 水平书写
     PdfEncodings.IDENTITY_H,
     // 是否将字体嵌入到目标文档中: 如果可能，嵌入字体
     PdfFontFactory.EmbeddingStrategy.PREFER_EMBEDDED);

}

/**

添加图片水印；默认为居中添加 *
@param watermark
@param srcPath 原始 PDF 文件绝对路径

@param destPath 添加完水印后的 PDF 存放路径 */ public static void addWatermark(ImageWatermark watermark, String srcPath, String destPath) throws IOException { PdfDocument pdfDoc = new PdfDocument(new PdfReader(srcPath), new PdfWriter(destPath)); Document doc = new Document(pdfDoc);

// 创建图片 ImageData img = ImageDataFactory.create(watermark.getPath()); float w = img.getWidth(); float h = img.getHeight();

// 设置透明度 PdfExtGState gs1 = new PdfExtGState().setFillOpacity(watermark.getOpacity());

// 循环添加到每一页的 PDF 中 for (int i = 1; i <= pdfDoc.getNumberOfPages(); i++) {

 PdfPage pdfPage = pdfDoc.getPage(i);
 // 获取页面大小，考虑页面旋转
 Rectangle pageSize = pdfPage.getPageSizeWithRotation();
 // 当页面有旋转时，内容自动旋转
 pdfPage.setIgnorePageRotationForContent(true);
 // 计算添加的位置坐标：这里使用居中位置，水平垂直居中
 float x = (pageSize.getLeft() + pageSize.getRight()) / 2;
 float y = (pageSize.getTop() + pageSize.getBottom()) / 2;
 // 添加图片水印使用
 PdfCanvas over = new PdfCanvas(pdfDoc.getPage(i));
 over.saveState();
 over.setExtGState(gs1);
 // 添加图片水印：位置水平垂直居中
 over.addImageWithTransformationMatrix(img, w, 0, 0, h, x - (w / 2), y - (h / 2), false);
 over.restoreState();

} doc.close(); } }

文本和图片参数类
```java
package cn.mrcode.tools.pdf_watermark;
import com.itextpdf.io.font.constants.StandardFonts;
import javax.validation.constraints.Max;
import javax.validation.constraints.Size;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.ToString;
/**
 * 文字水印
 *
 * @author mrcode
 */
@Data
@ToString
@ApiModel
public class TextWatermark {
    /**
     * 文字水印,多行可使用 \n 换行
     */
    private String text;
    /**
     * 透明度 0-1（完全透明-不透明）
     */
    private float opacity = 0.5F;
    /**
     * 颜色：只支持 RGB; 为空则默认为黑色；比如 0,0,0;
     * <pre>
     *     建议使用 rgba 提供用户选择，后面的 a 的数值用于透明度的设置，展示的颜色和水印效果类似
     * </pre>
     */
    private String color;
    /**
     * 旋转角度
     */
    private float radAngle = 0F;
    /**
     * 字体文件路径；如果为空，则使用标准的英文字体 StandardFonts.HELVETICA
     * <pre>
     *     支持： afm、pfm、ttf、otf、woff、woff2
     * </pre>
     *
     * @see StandardFonts#HELVETICA
     */
    private String fontPath;
    /**
     * 字号大小，
     */
    private int fontSize = 30;
    /**
     * 文本平铺方式： 1：文本水平垂直居中 2：页面平铺
     */
    private int tileMode = 1;
    /**
     * 页面平铺：文字水平间隔；默认为 50
     */
    private Integer pageModeOfHorizontalInterval;
    /**
     * 页面平铺：文字垂直间隔; 建议至少为字体大小（默认为字体大小），如果有旋转，则合理的高度是 (文字个数 * 文字高度)
     */
    private Integer pageModeOfVerticalInterval;
}

package cn.mrcode.tools.pdf_watermark;
import lombok.Data;
import lombok.ToString;
/**
 * 文字水印
 *
 * @author mrcode
 */
@Data
@ToString
public class ImageWatermark {
    /**
     * 图片所在绝对路径
     */
    private String path;
    /**
     * 透明度 0-1（完全透明-不透明）
     */
    private float opacity = 0.5F;
}

测试用例

package cn.mrcode.tools.pdf_watermark;
import org.junit.jupiter.api.Test;
import java.io.IOException;
/**
 * @author mrcode
 */
class PdFWatermarkUtilTest {
    public static final String DEST = "C:\\temp\\xx2.pdf";
    public static final String IMG = "C:\\temp\\b1.png";
    public static final String SRC = "d:\\temp\\xx1.pdf";
    public static final String FONT = "C:\\temp\\songti.ttf";
    @Test
    void addTextWatermark() throws IOException {
        final TextWatermark watermark = new TextWatermark();
        watermark.setText("中国强、则世界强");
        watermark.setFontPath(FONT);
        watermark.setRadAngle(45);
        watermark.setFontSize(40);
        watermark.setOpacity(0.1F);
        PdFWatermarkUtil.addWatermark(watermark, SRC, DEST);
    }
    @Test
    void addImageWatermark() throws IOException {
        final ImageWatermark watermark = new ImageWatermark();
        watermark.setOpacity(0.5F);
        watermark.setPath(IMG);
        PdFWatermarkUtil.addWatermark(watermark, SRC, DEST);
    }
}

前端实现参考、生成效果参考

前端参数收集，则可以参考如下所示

文字垂直间隔可以结合 文字大小与文字个数进行建议（文字垂直间隔; 建议至少为字体大小，如果有旋转，则合理的高度简单计算是 (文字个数 * 文字高度)）

水印效果参考（下图效果以上图参数作为入参）：

水平居中时