Java-使用 iText 给 PDF 添加水印【有版权问题】

2023年09月11日 18:29 · 阅读(1377) ·

开发环境

名称 版本
操作系统 Windows 10 X64
JDK JDK1.8（jdk-8u151-windows-x64）
IntelliJ IDEA IntelliJ IDEA 2022.3
Maven Maven 3.9.4

参考

Java PDF加水印

咖啡汪日志——JAVA导出pdf文件加水印 文字+图片、文字

C#-使用 iText 给 PDF 添加水印

重要说明

因为 iText 有版权问题导致不能继续使用，所以使用 OpenPDF 来替换 iText 相关功能。

Java-使用 OpenPDF 给 PDF 添加水印

只添加水印

pom.xml

  1. <!-- PDF文件依赖包 -->
  2. <dependency>
  3.     <groupId>com.itextpdf</groupId>
  4.     <artifactId>itextpdf</artifactId>
  5.     <version>5.5.13.1</version>
  6. </dependency>
  7. <!-- PDF文件字体 防止中文乱码 -->
  8. <dependency>
  9.     <groupId>com.itextpdf</groupId>
  10.     <artifactId>itext-asian</artifactId>
  11.     <version>5.2.0</version>
  12. </dependency>

PDF 参数类-PDFParamsDTO

  1. package com.luoma.finance.dto;
  3. import lombok.Data;
  5. import java.io.InputStream;
  7. /**
  8.  * PDF 参数类
  9.  * -luoma - 2023年9月4日22:15:25
  10.  */
  11. @Data
  12. public class PDFParamsDTO {
  13.     /**
  14.      * 是否生成到本地
  15.      */
  16.     private Boolean generateToLocal;
  18.     /**
  19.      * PDF 模板路径，generateToLocal 为 true，必填
  20.      */
  21.     private String templatePath;
  23.     /**
  24.      * PDF 存放的路径，generateToLocal 为 true，必填
  25.      */
  26.     private String fileDirectory;
  28.     /**
  29.      * PDF 模版字节，generateToLocal 为 false，必填
  30.      */
  31.     private InputStream inputStream;
  33.     /**
  34.      * 水印文字
  35.      */
  36.     private String watermark;
  38.     /**
  39.      * 默认字体大小
  40.      */
  41.     private int DefaultFontSize = 13;
  43.     /**
  44.      * 需要添加水印的 X 坐标
  45.      */
  46.     private float x;
  48.     /**
  49.      * 需要添加水印的 Y 坐标
  50.      */
  51.     private float y;
  53.     /**
  54.      * 应用于文本的旋转角度，以弧度为单位
  55.      * 为 0 则不旋转
  56.      */
  57.     private float angle;
  59.     /**
  60.      * 水印文字-RBG 值-R 值
  61.      */
  62.     private int r = 255;
  64.     /**
  65.      * 水印文字-RBG 值-G 值
  66.      */
  67.     private int g = 0;
  69.     /**
  70.      * 水印文字-RBG 值-B 值
  71.      */
  72.     private int b = 0;
  73. }

PDF 工具类-PDFMakerUtil

  1. package com.luoma.finance.util;
  3. import com.itextpdf.text.BaseColor;
  4. import com.itextpdf.text.Element;
  5. import com.itextpdf.text.pdf.BaseFont;
  6. import com.itextpdf.text.pdf.PdfContentByte;
  7. import com.itextpdf.text.pdf.PdfReader;
  8. import com.itextpdf.text.pdf.PdfStamper;
  9. import com.luoma.finance.dto.PDFParamsDTO;
  10. import lombok.Data;
  11. import lombok.extern.slf4j.Slf4j;
  13. import javax.swing.*;
  14. import java.awt.*;
  15. import java.io.ByteArrayOutputStream;
  16. import java.io.InputStream;
  17. import java.nio.file.Files;
  18. import java.nio.file.Paths;
  19. import java.util.Date;
  21. /**
  22.  * PDF 生成类
  23.  * - luoma - 2023年9月4日22:18:37
  24.  * - 参考：<a href="https://blog.csdn.net/Ying_ph/article/details/131800711">Java PDF加水印</a>
  25.  * - 参考：<a href="https://blog.csdn.net/weixin_42994251/article/details/129433070">咖啡汪日志——JAVA导出pdf文件加水印 文字+图片、文字</a>
  26.  */
  27. @Data
  28. @Slf4j
  29. public class PDFMakerUtil {
  30.     /**
  31.      * 给 PDF 文件添加水印
  32.      *
  33.      * @param pdfParams PDF 参数类
  34.      * @return 添加水印后的 PDF 文件字节数组(添加到本地的情况为空)
  35.      */
  36.     public static byte[] addWatermark(PDFParamsDTO pdfParams) {
  37.         String logInfo = "addWatermark >> PDF 添加水印 >> ";
  38.         byte[] byteArray = null;
  39.         try {
  40.             log.info(logInfo + "添加文字:{}", pdfParams.getWatermark());
  43.             //坐标
  44.             float x = pdfParams.getX();
  45.             float y = pdfParams.getY();
  46.             float angle = pdfParams.getAngle();
  48.             //文字颜色
  49.             int r = pdfParams.getR();
  50.             int g = pdfParams.getG();
  51.             int b = pdfParams.getB();
  52.             BaseColor fontColor = new BaseColor(r, g, b);
  54.             //文字大小
  55.             int fontSize = pdfParams.getDefaultFontSize();
  57.             //文字内容
  58.             // 使用"||"将内容进行分割
  59.             String waterMarkName = pdfParams.getWatermark();
  60.             String[] waterMarkContents = waterMarkName.split("\\|\\|");
  61.             //获取水印文字的最大高度和宽度
  62.             int textH = 0, textW = 0;
  63.             for (String waterMarkContent : waterMarkContents) {
  64.                 JLabel label = new JLabel();
  65.                 label.setText(waterMarkContent);
  66.                 FontMetrics metrics = label.getFontMetrics(label.getFont());
  67.                 if (textH < metrics.getHeight()) {
  68.                     textH = metrics.getHeight();
  69.                 }
  70.                 if (textW < metrics.stringWidth(label.getText())) {
  71.                     textW = metrics.stringWidth(label.getText());
  72.                 }
  73.             }
  75.             //设置输入，输出
  76.             PdfReader reader;
  77.             PdfStamper stamper;
  78.             ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
  79.             if (pdfParams.getGenerateToLocal()) {
  80.                 //输入目录
  81.                 String inputFile = pdfParams.getTemplatePath();
  82.                 //输出目录
  83.                 String outputFile = pdfParams.getFileDirectory();
  84.                 //设置输入，输出
  85.                 reader = new PdfReader(inputFile);
  86.                 stamper = new PdfStamper(reader, Files.newOutputStream(Paths.get(outputFile)));
  87.             } else {
  88.                 //设置输入，输出
  89.                 InputStream inputStream = pdfParams.getInputStream();
  90.                 reader = new PdfReader(inputStream);
  91.                 stamper = new PdfStamper(reader, outputStream);
  92.             }
  94.             //设置字体
  95.             BaseFont baseFont = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.EMBEDDED);
  97.             // 获取总页数 +1, 下面从1开始遍历
  98.             int total = reader.getNumberOfPages() + 1;
  99.             PdfContentByte under;
  100.             for (int i = 1; i < total; i++) {
  101.                 // 在内容上方加水印
  102.                 under = stamper.getOverContent(i);
  103.                 // 在内容下方加水印
  104.                 //under = stamper.getUnderContent(i);
  105.                 under.saveState();
  106.                 under.beginText();
  107.                 //水印字体和大小
  108.                 under.setFontAndSize(baseFont, fontSize);
  109.                 //文字加粗
  110.                 //设置文本描边宽度
  111.                 //under.setLineWidth(0.3);
  112.                 //设置文本为描边模式， 会导致 setColorFill 颜色失效
  113.                 //under.setTextRenderingMode(PdfContentByte.TEXT_RENDER_MODE_FILL_STROKE);
  115.                 //字体颜色
  116.                 under.setColorFill(fontColor);
  118.                 // 将分段的字段进行输出编写
  119.                 for (int z = 0; z < waterMarkContents.length; z++) {
  120.                     //under.showTextAligned(Element.ALIGN_LEFT, waterMarkContents[z], x - textW, y -(textH+10) * (z + 1), angle);
  121.                     under.showTextAligned(Element.ALIGN_LEFT, waterMarkContents[z], x, y - (textH * z), angle);
  122.                 }
  124.                 // 添加水印文字
  125.                 under.endText();
  126.             }
  128.             stamper.close();
  129.             reader.close();
  131.             //outputStream 转换为 byte
  132.             ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
  133.             outputStream.writeTo(byteArrayOutputStream);
  134.             byteArray = byteArrayOutputStream.toByteArray();
  135.             log.info(logInfo + "设置完成。");
  136.         } catch (Exception e) {
  137.             log.error(logInfo + "异常,e:", e);
  138.         }
  140.         return byteArray;
  141.     }
  142. }

测试

测试代码

  1. public static void main(String[] args) {
  2.     PDFParamsDTO pdfParams = new PDFParamsDTO();
  3.     pdfParams.setWatermark(String.format("适用范围：%s||有效期：%s||再次复印无效", "xxx", "2022年5月9日11:14:36"));
  5.     //------------------------------------------------region 生成到本地
  6.     pdfParams.setGenerateToLocal(true);
  8.     //竖版-正常
  9.     pdfParams.setTemplatePath("D:\\data\\105.pdf");
  10.     pdfParams.setFileDirectory("D:\\data\\105-1.pdf");
  11.     pdfParams.setX(45f);
  12.     pdfParams.setY(330.5f);
  13.     pdfParams.setAngle(0);
  14.     PDFMakerUtil.addWatermark(pdfParams);
  17.     //------------------------------------------------endregion
  19.     //------------------------------------------------region 生成到 byte[]
  20.     try {
  21.         //输入输出流
  22.         pdfParams.setGenerateToLocal(false);
  23.         File file = new File("D:\\\\data\\\\105.pdf");
  24.         InputStream inputStream = Files.newInputStream(file.toPath());
  25.         pdfParams.setInputStream(inputStream);
  26.         pdfParams.setFileDirectory("D:\\data\\105-1.pdf");
  27.         pdfParams.setX(280f);
  28.         pdfParams.setY(115f);
  29.         pdfParams.setAngle(0);
  30.         byte[] arrByte = PDFMakerUtil.addWatermark(pdfParams);
  32.         // 步骤1：创建FileOutputStream对象
  33.         // 参数1：文件路径
  34.         // 参数2：是否追加写入（true为追加，false为覆盖）
  35.         FileOutputStream fos = new FileOutputStream(pdfParams.getFileDirectory(), false);
  36.         // 步骤2：将byte数据写入文件
  37.         // 参数：要写入的byte数组
  38.         fos.write(arrByte);
  39.         // 步骤3：关闭文件
  40.         fos.close();
  41.     } catch (Exception e) {
  42.         log.error("生成失败,e:", e);
  43.     }
  44.     //------------------------------------------------endregion
  45. }

测试结果

添加水印，旋转，透明度，密码

pom.xml

  1. <!-- PDF文件依赖包 -->
  2. <dependency>
  3.     <groupId>com.itextpdf</groupId>
  4.     <artifactId>itextpdf</artifactId>
  5.     <version>5.5.13.1</version>
  6. </dependency>
  7. <!-- PDF文件字体 防止中文乱码 -->
  8. <dependency>
  9.     <groupId>com.itextpdf</groupId>
  10.     <artifactId>itext-asian</artifactId>
  11.     <version>5.2.0</version>
  12. </dependency>
  13. <!--PDF 加密-->
  14. <dependency>
  15.     <groupId>org.bouncycastle</groupId>
  16.     <artifactId>bcprov-ext-jdk15on</artifactId>
  17.     <version>1.47</version>
  18. </dependency>

PDF参数类-PDFParamsDTO

  1. package com.atguigu.boot3.actuator.dto;
  3. import lombok.Data;
  4. import java.io.InputStream;
  6. @Data
  7. public class PDFParamsDTO {
  8.     /**
  9.      * 是否生成到本地
  10.      */
  11.     private Boolean generateToLocal;
  13.     /**
  14.      * PDF 模板路径，generateToLocal 为 true，必填
  15.      */
  16.     private String templatePath;
  18.     /**
  19.      * PDF 存放的路径，generateToLocal 为 true，必填
  20.      */
  21.     private String fileDirectory;
  23.     /**
  24.      * PDF 模版字节，generateToLocal 为 false，必填
  25.      */
  26.     private InputStream inputStream;
  28.     /**
  29.      * 水印文字
  30.      */
  31.     private String watermark;
  33.     /**
  34.      * 默认字体大小
  35.      */
  36.     private int DefaultFontSize = 13;
  38.     /**
  39.      * 水印文字透明度
  40.      */
  41.     private float fillOpacity;
  43.     /**
  44.      * 需要添加水印的 X 坐标
  45.      */
  46.     private float x;
  48.     /**
  49.      * 需要添加水印的 Y 坐标
  50.      */
  51.     private float y;
  53.     /**
  54.      * 应用于文本的旋转角度，以弧度为单位
  55.      * 为 0 则不旋转
  56.      */
  57.     private float angle;
  59.     /**
  60.      * 水印文字-RBG 值-R 值
  61.      */
  62.     private int r = 255;
  64.     /**
  65.      * 水印文字-RBG 值-G 值
  66.      */
  67.     private int g = 0;
  69.     /**
  70.      * 水印文字-RBG 值-B 值
  71.      */
  72.     private int b = 0;
  74.     /**
  75.      * 打开文档时输入的密码
  76.      */
  77.     private String userPassword;
  79.     /**
  80.      * 用户编辑 PDF 时需要的密码
  81.      */
  82.     private String ownerPassword;
  83. }

PDF 工具类-PDFMakerUtil

  1. package com.atguigu.boot3.actuator.util;
  3. import com.itextpdf.text.BaseColor;
  4. import com.itextpdf.text.Element;
  5. import com.itextpdf.text.Rectangle;
  6. import com.itextpdf.text.pdf.*;
  7. import com.atguigu.boot3.actuator.dto.PDFParamsDTO;
  8. import io.micrometer.common.util.StringUtils;
  9. import lombok.Data;
  10. import lombok.extern.slf4j.Slf4j;
  11. import javax.swing.*;
  12. import java.awt.*;
  13. import java.io.ByteArrayOutputStream;
  14. import java.io.File;
  15. import java.io.FileOutputStream;
  16. import java.io.InputStream;
  17. import java.nio.file.Files;
  18. import java.nio.file.Paths;
  20. /**
  21.  * PDF 生成类
  22.  * - luoma - 2023年9月4日22:18:37
  23.  * - 参考：<a href="https://blog.csdn.net/Ying_ph/article/details/131800711">Java PDF加水印</a>
  24.  * - 参考：<a href="https://blog.csdn.net/weixin_42994251/article/details/129433070">咖啡汪日志——JAVA导出pdf文件加水印 文字+图片、文字</a>
  25.  */
  26. @Data
  27. @Slf4j
  28. public class PDFMakerUtil {
  29.     /**
  30.      * 给 PDF 文件添加水印，旋转，透明度，密码
  31.      *
  32.      * @param pdfParams PDF 参数类
  33.      * @return 添加水印后的 PDF 文件字节数组(添加到本地的情况为空)
  34.      */
  35.     public static byte[] addWatermarkAuto(PDFParamsDTO pdfParams) {
  36.         String logInfo = "addWatermarkAuto >> PDF 添加水印 >> ";
  37.         byte[] byteArray = null;
  38.         try {
  39.             log.info(logInfo + "添加文字:{}", pdfParams.getWatermark());
  40.             //坐标
  41.             float x = pdfParams.getX();
  42.             float y = pdfParams.getY();
  43.             float angle = pdfParams.getAngle();
  44.             //文字颜色
  45.             int r = pdfParams.getR();
  46.             int g = pdfParams.getG();
  47.             int b = pdfParams.getB();
  48.             BaseColor fontColor = new BaseColor(r, g, b);
  49.             //文字大小
  50.             int fontSize = pdfParams.getDefaultFontSize();
  51.             //文字内容
  52.             // 使用"||"将内容进行分割
  53.             String waterMarkName = pdfParams.getWatermark();
  54.             String[] waterMarkContents = waterMarkName.split("\\|\\|");
  55.             //获取水印文字的最大高度和宽度
  56.             int textH = 0, textW = 0;
  57.             for (String waterMarkContent : waterMarkContents) {
  58.                 JLabel label = new JLabel();
  59.                 label.setText(waterMarkContent);
  60.                 FontMetrics metrics = label.getFontMetrics(label.getFont());
  61.                 if (textH < metrics.getHeight()) {
  62.                     textH = metrics.getHeight();
  63.                 }
  64.                 if (textW < metrics.stringWidth(label.getText())) {
  65.                     textW = metrics.stringWidth(label.getText());
  66.                 }
  67.             }
  68.             //设置输入，输出
  69.             PdfReader reader;
  70.             PdfStamper stamper;
  71.             ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
  72.             if (pdfParams.getGenerateToLocal()) {
  73.                 //输入目录
  74.                 String inputFile = pdfParams.getTemplatePath();
  75.                 //输出目录
  76.                 String outputFile = pdfParams.getFileDirectory();
  77.                 //设置输入，输出
  78.                 reader = new PdfReader(inputFile);
  79.                 stamper = new PdfStamper(reader, Files.newOutputStream(Paths.get(outputFile)));
  80.             } else {
  81.                 //设置输入，输出
  82.                 InputStream inputStream = pdfParams.getInputStream();
  83.                 reader = new PdfReader(inputStream);
  84.                 stamper = new PdfStamper(reader, outputStream);
  85.             }
  87.             // 设置密码文件打开密码文件编辑密码
  88.             byte[] arrUserPassword = null;
  89.             byte[] arrOwnerPassword = null;
  90.             if(StringUtils.isNotBlank(pdfParams.getUserPassword())) {
  91.                 arrUserPassword = pdfParams.getUserPassword().getBytes();
  92.             }
  93.             if(StringUtils.isNotBlank(pdfParams.getOwnerPassword())) {
  94.                 arrOwnerPassword = pdfParams.getOwnerPassword().getBytes();
  95.             }
  96.             if(StringUtils.isNotBlank(pdfParams.getUserPassword()) || StringUtils.isNotBlank(pdfParams.getOwnerPassword())) {
  97.                 stamper.setEncryption(arrUserPassword, arrOwnerPassword, PdfWriter.ALLOW_PRINTING, false);
  98.             }
  100.             //设置字体
  101.             BaseFont baseFont = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.EMBEDDED);
  102.             // 获取总页数 +1, 下面从1开始遍历
  103.             int total = reader.getNumberOfPages() + 1;
  104.             PdfContentByte under;
  105.             for (int i = 1; i < total; i++) {
  106.                 // 在内容上方加水印
  107.                 under = stamper.getOverContent(i);
  108.                 // 在内容下方加水印
  109.                 //under = stamper.getUnderContent(i);
  110.                 under.saveState();
  111.                 under.beginText();
  112.                 under.setFontAndSize(baseFont, fontSize);
  113.                 //文字加粗
  114.                 //设置文本描边宽度
  115.                 //under.setLineWidth(0.3);
  116.                 //设置文本为描边模式， 会导致 setColorFill 颜色失效
  117.                 //under.setTextRenderingMode(PdfContentByte.TEXT_RENDER_MODE_FILL_STROKE);
  118.                 //字体颜色
  119.                 under.setColorFill(fontColor);
  121.                 // 设置透明度
  122.                 PdfGState gs = new PdfGState();
  123.                 gs.setFillOpacity(pdfParams.getFillOpacity());
  124.                 under.setGState(gs);
  126.                 //水印字体和大小
  127.                 Rectangle pageRect = reader.getPageSizeWithRotation(i);
  128.                 int width1 = (int) pageRect.getWidth();
  129.                 int height1 = (int) pageRect.getHeight();
  130.                 //fontSize = (width1 + height1) / pdfParams.getDefaultFontSize();
  131.                 x = (float) (width1 ) / 2;
  132.                 y = (float) height1 / 2;
  134.                 // 将分段的字段进行输出编写
  135.                 for (int z = 0; z < waterMarkContents.length; z++) {
  136.                     //文字
  137.                     String itemWaterMark = waterMarkContents[z];
  138.                     // 间隔距离（参数可调节）
  139.                     int interval = fontSize  * z;
  140.                     under.showTextAligned(Element.ALIGN_CENTER, itemWaterMark, x, y - (interval + textH * z), angle);
  141.                 }
  142.                 // 添加水印文字
  143.                 under.endText();
  144.             }
  146.             stamper.close();
  147.             reader.close();
  148.             //outputStream 转换为 byte
  149.             ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
  150.             outputStream.writeTo(byteArrayOutputStream);
  151.             byteArray = byteArrayOutputStream.toByteArray();
  152.             log.info(logInfo + "设置完成。");
  153.         } catch (Exception e) {
  154.             log.error(logInfo + "异常,e:", e);
  155.         }
  156.         return byteArray;
  157.     }
  158. }

测试

测试代码

  1. public static void main(String[] args) {
  2.     try {
  4.         File file = new File("D:\\\\data\\\\105.pdf");
  5.         InputStream inputStream = Files.newInputStream(file.toPath());
  7.         PDFParamsDTO pdfParams = new PDFParamsDTO();
  8.         pdfParams.setWatermark(String.format("适用范围：%s||有效期：%s||再次复印无效", "申请页面的原因及用途申请页面的原因及用途", "2022年5月9日11:14:36"));
  9.         pdfParams.setGenerateToLocal(false);   //输入输出流
  10.         pdfParams.setInputStream(inputStream);
  11.         pdfParams.setFileDirectory("D:\\data\\105-1.pdf");
  12.         pdfParams.setAngle(30);
  13.         pdfParams.setR(210);
  14.         pdfParams.setG(210);
  15.         pdfParams.setB(210);
  16.         pdfParams.setDefaultFontSize(25);
  17.         pdfParams.setFillOpacity(0.7f);
  18.         //pdfParams.setUserPassword("123");
  19.         //pdfParams.setOwnerPassword("456");
  20.         byte[] arrByte = PDFMakerUtil.addWatermarkAuto(pdfParams);
  21.         // 步骤1：创建FileOutputStream对象
  22.         // 参数1：文件路径
  23.         // 参数2：是否追加写入（true为追加，false为覆盖）
  24.         FileOutputStream fos = new FileOutputStream(pdfParams.getFileDirectory(), false);
  25.         // 步骤2：将byte数据写入文件
  26.         // 参数：要写入的byte数组
  27.         fos.write(arrByte);
  28.         // 步骤3：关闭文件
  29.         fos.close();
  30.     } catch (Exception e) {
  31.         log.error("生成失败,e:", e);
  32.     }
  33.     //------------------------------------------------endregion
  34. }

测试结果