使用PDFBox 2.0删除替换PDF图片后Acrobat报页面错误
PDFBox 2.0 图片删除替换功能报错排查
问题现象
基于PDFBox 2.0实现指定图片删除、新图插入的流程开发完成后,运行过程无报错,但生成的PDF打开时弹出警告:
An error exists on this page. Acrobat may not display the page correctly
报错截图:
现有实现代码
public static void removeImages(String pdfFile) throws Exception { PDDocument document = PDDocument.load(new File(pdfFile)); for (PDPage page : document.getPages()) { PDResources pdResources = page.getResources(); String[] qrCodeCosName = new String[1]; pdResources.getXObjectNames().forEach(propertyName -> { if (!pdResources.isImageXObject(propertyName)) { return; } PDXObject o; try { o = pdResources.getXObject(propertyName); if (o instanceof PDImageXObject) { PDImageXObject pdImageXObject = (PDImageXObject) o; if (pdImageXObject.getMetadata() != null) { // 从资源字典移除待删除图片 ((COSDictionary) pdResources.getCOSObject().getDictionaryObject(COSName.XOBJECT)) .removeItem(propertyName); qrCodeCosName[0] = propertyName.getName(); } } } catch (IOException e) { e.printStackTrace(); } }); PDFStreamParser parser = new PDFStreamParser(page); parser.parse(); List<Object> tokens = parser.getTokens(); System.out.println("Original tokens size" + tokens.size()); List<Object> newTokens = new ArrayList<Object>(); for (int j = 0; j < tokens.size(); j++) { Object token = tokens.get(j); if (token instanceof Operator) { Operator op = (Operator) token; // 匹配图片调用指令做移除 if (op.getName().equals("Do")) { COSName cosName = (COSName) tokens.get(j - 1); if (cosName.getName().equals(qrCodeCosName[0])) { newTokens.remove(newTokens.size() - 1); continue; } } newTokens.add(token); } System.out.println("tokens size" + newTokens.size()); PDStream newContents = new PDStream(document); OutputStream out = newContents.createOutputStream(); ContentStreamWriter writer = new ContentStreamWriter(out); writer.writeTokens(newTokens); out.close(); page.setContents(newContents); // 加载待插入的新图片 PDImageXObject pdImage = PDImageXObject.createFromFile("D:\\copy\\ind.png", document); PDPageContentStream contents = new PDPageContentStream(document, page, PDPageContentStream.AppendMode.PREPEND, true, true); contents.saveGraphicsState(); // 按指定坐标尺寸绘制新图片 contents.drawImage(pdImage, 0, 0, 50, 30); contents.restoreGraphicsState(); System.out.println("Image inserted Successfully."); contents.close(); } document.save("RemoveImage.pdf"); document.close(); } }
报错根因
代码逻辑存在三处直接破坏PDF页面结构的问题:
- 内容流写入操作嵌套在token遍历循环内部:每遍历一个token就执行一次新内容流构建、token写入、页面内容覆盖的操作,最终写入的内容是被反复截断的不完整片段,完全不符合PDF语法规范。
- 指令删除逻辑违反PDF内容流语法:匹配到
Do(XObject调用指令)时,仅移除了newTokens中存的前一个COSName参数,没有跳过当前的Do运算符,留下的孤立Do指令没有匹配的参数引用,Acrobat解析时直接判定页面结构损坏。 - 流操作顺序错误:循环内反复以
PREPEND模式打开页面内容流插入新图片,多次打开/关闭内容流时没有正确衔接graphics state栈,部分场景下会出现资源引用错位,进一步触发解析错误。
修正后实现代码
严格按照PDFBox 2.0的API规范调整逻辑顺序,单次遍历、单次写入、单次流操作:
public static void removeImages(String pdfFile) throws Exception { // 用try-with-resources自动管理文档、流资源,避免泄露 try (PDDocument document = PDDocument.load(new File(pdfFile))) { for (PDPage page : document.getPages()) { PDResources pdResources = page.getResources(); String targetImageName = null; // 第一步:定位待删除的目标图片资源 for (COSName propertyName : pdResources.getXObjectNames()) { if (!pdResources.isImageXObject(propertyName)) continue; PDXObject xObject = pdResources.getXObject(propertyName); if (xObject instanceof PDImageXObject) { PDImageXObject image = (PDImageXObject) xObject; if (image.getMetadata() != null) { targetImageName = propertyName.getName(); pdResources.getXObjectCosDictionary().removeItem(propertyName); break; } } } // 第二步:一次性解析全部tokens,移除目标图片对应的Do调用 PDFStreamParser parser = new PDFStreamParser(page); parser.parse(); List<Object> tokens = parser.getTokens(); List<Object> newTokens = new ArrayList<>(); for (int j = 0; j < tokens.size(); j++) { Object token = tokens.get(j); if (token instanceof Operator op) { // 匹配到Do指令时,连带删除前面的参数和当前指令,保证配对合法 if (op.getName().equals("Do") && targetImageName != null) { COSName cosName = (COSName) tokens.get(j - 1); if (cosName.getName().equals(targetImageName)) { newTokens.remove(newTokens.size() - 1); continue; } } } newTokens.add(token); } // 第三步:一次性写入修改后的内容流,循环外执行,避免反复覆盖 try (PDStream newContents = new PDStream(document); OutputStream out = newContents.createOutputStream(COSName.FLATE_DECODE)) { ContentStreamWriter writer = new ContentStreamWriter(out); writer.writeTokens(newTokens); } page.setContents(newContents); // 第四步:单次打开内容流插入新图片 PDImageXObject newImage = PDImageXObject.createFromFile("D:\\copy\\ind.png", document); try (PDPageContentStream contentStream = new PDPageContentStream(document, page, PDPageContentStream.AppendMode.APPEND, true, true)) { contentStream.drawImage(newImage, 0, 0, 50, 30); } } document.save("RemoveImage.pdf"); } }
优化建议
- 替换原代码中用数组在lambda内传值的写法,直接用局部变量存储目标图片名,避免变量逃逸问题
- 所有流、文档对象全部用try-with-resources管理,避免流泄露导致的文件锁、写入不完整问题
- 内容流写入时指定
COSName.FLATE_DECODE压缩过滤器,减小生成PDF的体积 - 正式环境移除循环内的调试日志输出,避免频繁IO影响性能
- 不要使用
PREPEND模式插入新图片,避免新图片覆盖原有页面内容,统一用APPEND模式追加绘制即可
内容的提问来源于stack exchange,提问作者Bhailu
相关产品推荐
相关产品推荐

