基于pdfbox实现的pdf添加文字水印工具

简述

最近有个需求需要给pdf加文字水印，于是开始搜索大法，但是发现网络上的代码基本都是将字体文件直接放在jar包里面。个人强迫症发作（手动狗头），想要像poi一样直接加载系统字体，于是研究了一下午pdfbox的源代码，发现FontFileFinder类可以实现这个功能。废话不多说，直接上代码。
引入依赖

1. <dependency>
2.     <groupId>org.apache.pdfbox</groupId>
3.     <artifactId>pdfbox</artifactId>
4. </dependency>
5. <dependency>
6.     <groupId>org.projectlombok</groupId>
7.     <artifactId>lombok</artifactId>
8.     <scope>provided</scope>
9. </dependency>
11. <dependency>
12.     <groupId>jakarta.servlet</groupId>
13.     <artifactId>jakarta.servlet-api</artifactId>
14. </dependency>

复制代码

新增水印配置类

1. @Data
2. @NoArgsConstructor
3. public class PdfWatermarkProperties {
5.     public PdfWatermarkProperties(String content) {
6.         this.content = content;
7.     }
9.     /**
10.      * 文字水印内容
11.      */
12.     private String content = "";
14.     /**
15.      * ttf类型字体文件. 为null则使用默认字体
16.      */
17.     private File fontFile;
19.     private float fontSize = 13;
21.     /**
22.      * cmyk颜色.参数值范围为 0-255
23.      */
24.     private int[] color = {0, 0, 0, 210};
26.     /**
27.      * 透明度
28.      */
29.     private float transparency = 0.3f;
31.     /**
32.      * 倾斜度. 默认30°
33.      */
34.     private double rotate = 0.3;
36.     /**
37.      * 初始添加水印的点位
38.      */
39.     private int x = -10;
40.     private int y = 10;
42.     /**
43.      * 内容区域的宽高.即单个水印范围的大小
44.      */
45.     private int width = 200;
46.     private int height = 200;
48. }

复制代码

工具类

1. import org.apache.fontbox.ttf.TTFParser;
2. import org.apache.fontbox.ttf.TrueTypeCollection;
3. import org.apache.fontbox.ttf.TrueTypeFont;
4. import org.apache.fontbox.util.autodetect.FontFileFinder;
5. import org.apache.pdfbox.pdmodel.PDDocument;
6. import org.apache.pdfbox.pdmodel.PDPage;
7. import org.apache.pdfbox.pdmodel.PDPageContentStream;
8. import org.apache.pdfbox.pdmodel.font.PDFont;
9. import org.apache.pdfbox.pdmodel.font.PDType0Font;
10. import org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState;
11. import org.apache.pdfbox.util.Matrix;
13. import javax.servlet.http.HttpServletResponse;
14. import java.io.*;
15. import java.net.URI;
16. import java.net.URLEncoder;
18. public class PdfUtil {
20.     private static final String DEFAULT_TTF_FILENAME = "simsun.ttf";
21.     private static final String DEFAULT_TTC_FILENAME = "simsun.ttc";
22.     private static final String DEFAULT_FONT_NAME = "SimSun";
23.     private static final TrueTypeFont DEFAULT_FONT;
25.     static {
26.         DEFAULT_FONT = loadSystemFont();
27.     }
30.     /**
31.      * 加载系统字体,提供默认字体
32.      *
33.      * @return
34.      */
35.     private synchronized static TrueTypeFont loadSystemFont() {
36.         //load 操作系统的默认字体. 宋体
37.         FontFileFinder fontFileFinder = new FontFileFinder();
38.         for (URI uri : fontFileFinder.find()) {
39.             try {
40.                 final String filePath = uri.getPath();
41.                 if (filePath.endsWith(DEFAULT_TTF_FILENAME)) {
42.                     return new TTFParser(false).parse(filePath);
43.                 } else if (filePath.endsWith(DEFAULT_TTC_FILENAME)) {
44.                     TrueTypeCollection trueTypeCollection = new TrueTypeCollection(new FileInputStream(filePath));
45.                     final TrueTypeFont font = trueTypeCollection.getFontByName(DEFAULT_FONT_NAME);
46.                     //复制完之后关闭ttc
47.                     trueTypeCollection.close();
48.                     return font;
49.                 }
50.             } catch (Exception e) {
51.                 throw new RuntimeException("加载操作系统字体失败", e);
52.             }
53.         }
55.         return null;
56.     }
59.     /**
60.      * 添加文本水印
61.      * * 使用内嵌字体模式，pdf文件大小会增加1MB左右
62.      *
63.      * @param sourceFile 需要加水印的文件
64.      * @param descFile   目标存储路径
65.      * @param props      水印配置
66.      * @throws IOException
67.      */
68.     public static void addTextWatermark(File sourceFile, String descFile, PdfWatermarkProperties props) throws IOException {
69.         // 加载PDF文件
70.         PDDocument document = PDDocument.load(sourceFile);
71.         addTextToDocument(document, props);
72.         document.save(descFile);
73.         document.close();
74.     }
76.     /**
77.      * 添加文本水印
78.      *
79.      * @param inputStream  需要加水印的文件流
80.      * @param outputStream 加水印之后的流。执行完之后会关闭outputStream, 建议使用{@link BufferedOutputStream}
81.      * @param props        水印配置
82.      * @throws IOException
83.      */
84.     public static void addTextWatermark(InputStream inputStream, OutputStream outputStream, PdfWatermarkProperties props) throws IOException {
85.         // 加载PDF文件
86.         PDDocument document = PDDocument.load(inputStream);
87.         addTextToDocument(document, props);
88.         document.save(outputStream);
89.     }
92.     /**
93.      * 处理PDDocument,添加文本水印
94.      *
95.      * @param document
96.      * @param props
97.      * @throws IOException
98.      */
99.     public static void addTextToDocument(PDDocument document, PdfWatermarkProperties props) throws IOException {
100.         document.setAllSecurityToBeRemoved(true);
102.         // 遍历PDF文件，在每一页加上水印
103.         for (PDPage page : document.getPages()) {
104.             PDPageContentStream stream = new PDPageContentStream(document, page, PDPageContentStream.AppendMode.APPEND, true, true);
106.             // 加载水印字体
107.             if (DEFAULT_FONT == null) {
108.                 throw new RuntimeException(String.format("未提供默认字体.请安装字体文件%s或%s", DEFAULT_TTF_FILENAME, DEFAULT_TTC_FILENAME));
109.             }
111.             PDFont font;
112.             if (props.getFontFile() != null) {
113.                 font = PDType0Font.load(document, props.getFontFile());
114.             } else {
115.                 //当TrueTypeFont为字体集合时, embedSubSet 需要设置为true, 嵌入其子集
116.                 font = PDType0Font.load(document, DEFAULT_FONT, true);
117.             }
119.             PDExtendedGraphicsState r = new PDExtendedGraphicsState();
121.             // 设置透明度
122.             r.setNonStrokingAlphaConstant(props.getTransparency());
123.             r.setAlphaSourceFlag(true);
124.             stream.setGraphicsStateParameters(r);
126.             // 设置水印字体颜色
127.             final int[] color = props.getColor();
128.             stream.setNonStrokingColor(color[0], color[1], color[2], color[3]);
129.             stream.beginText();
130.             stream.setFont(font, props.getFontSize());
132.             // 获取PDF页面大小
133.             float pageHeight = page.getMediaBox().getHeight();
134.             float pageWidth = page.getMediaBox().getWidth();
136.             // 根据纸张大小添加水印，30度倾斜
137.             for (int h = props.getY(); h < pageHeight; h = h + props.getHeight()) {
138.                 for (int w = props.getX(); w < pageWidth; w = w + props.getWidth()) {
139.                     stream.setTextMatrix(Matrix.getRotateInstance(props.getRotate(), w, h));
140.                     stream.showText(props.getContent());
141.                 }
142.             }
144.             // 结束渲染，关闭流
145.             stream.endText();
146.             stream.restoreGraphicsState();
147.             stream.close();
148.         }
149.     }
152.     /**
153.      * 设置pdf文件输出的响应头
154.      *
155.      * @param response web response
156.      * @param fileName 文件名(不含扩展名)
157.      */
158.     public static void setPdfResponseHeader(HttpServletResponse response, String fileName) throws UnsupportedEncodingException {
159.         response.setContentType("application/pdf");
160.         response.setCharacterEncoding("utf-8");
161.         response.setHeader("Content-disposition", "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8") + ".pdf");
162.     }
164. }

复制代码

测试

1. @GetMapping("/t")
2. public void getFile(HttpServletResponse response) throws IOException {
3.     PdfUtil.setPdfResponseHeader(response, "watermark");
4.     final ServletOutputStream out = response.getOutputStream();
5.     PdfUtil.addTextWatermark(new FileInputStream("D:/测试文件.pdf"), out, new PdfWatermarkProperties("测试pdf水印"));
6. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！