java后端根据模版动态生成PDF

遇到项目，需要后端动态生成PDF给前端下载，查询了几种方案，最后选定了，根据PDF模板来生成。一般模板是word提前做好的，我们可以直接导出为PDF版本。导出的PDF文件，需要使用Adobe Acrobat DC来准备表单，这里简单做一下介绍

为PDF准备表单

使用DC打开PDF文件以后，如下图，注意右侧，搜索一下，准备表单

1629278103(1).png

表单准备完毕以后，如下图

1629278187(1).png

可以看到，每个该填充数据的地方，都会有fieldName，以及这块可填充区域的大小；这些东西准备好以后，保存一下就可以开始编码了

编写代码

• 首先，准备好使用的库

        
            com.itextpdf
            itextpdf
            5.5.10
        
        
            com.itextpdf
            itext-asian
            5.2.0
        
        
        
            org.apache.pdfbox
            pdfbox
            2.0.24
        

• 核心工具方法，就两个

    /**
     * 生成PDF文件
     * @param map 要往模版中填充的数据
     * @param sourceFile 模版PDF文件的路径
     * @param targetFile 填充数据以后，生成的PDF的文件路径
     * @throws IOException
     */
    private static void genPdf(HashMap map, String sourceFile, String targetFile) throws IOException {
        File templateFile = new File(sourceFile);
        fillParam(map, FileUtils.readFileToByteArray(templateFile), targetFile);
    }

    /**
     * Description: 使用map中的参数填充pdf，map中的key和pdf表单中的field对应
     */
    public static void fillParam(Map fieldValueMap, byte[] file, String contractFileName) {
        FileOutputStream fos = null;
        try {
            fos = new FileOutputStream(contractFileName);
            PdfReader reader = null;
            PdfStamper stamper = null;
            BaseFont base;
            try {
                reader = new PdfReader(file);
                stamper = new PdfStamper(reader, fos);
                stamper.setFormFlattening(true);
                //获取字体文件,TTF_PATH表示字体文件的路径
                base = BaseFont.createFont(TTF_PATH, BaseFont.IDENTITY_H, BaseFont.EMBEDDED);
                AcroFields acroFields = stamper.getAcroFields();
                for (Object key : acroFields.getFields().keySet()) {
                    //设置字体
                    acroFields.setFieldProperty((String) key, "textfont", base, null);
                    //设置字体大小
                    acroFields.setFieldProperty((String) key, "textsize", new Float(6), null);
                }
                if (fieldValueMap != null) {
                    for (String fieldName : fieldValueMap.keySet()) {
                        //填充图片
                        if (fieldName.equals("signImage")) {
                            //这里先获取图片的byte数据
                            byte[] bytes = PDFUtil.getImage(fieldValueMap.get(fieldName));
                            if (bytes != null) {
                                int pageNo = acroFields.getFieldPositions(fieldName).get(0).page;
                                Rectangle signRect = acroFields.getFieldPositions(fieldName).get(0).position;
                                float x = signRect.getLeft();
                                float y = signRect.getBottom();
                                // 读图片
                                Image image = Image.getInstance(bytes);
                                // 获取操作的页面
                                PdfContentByte under = stamper.getOverContent(pageNo);
                                // 根据域的大小缩放图片
                                image.scaleToFit(signRect.getWidth(), signRect.getHeight());
                                // 添加图片
                                image.setAbsolutePosition(x, y);
                                under.addImage(image);
                                stamper.setFormFlattening(true);
                            }
                        } else {
                            //填充其它文本数据
                            acroFields.setField(fieldName, fieldValueMap.get(fieldName));
                        }
                    }
                }
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                if (stamper != null) {
                    try {
                        stamper.close();
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
                if (reader != null) {
                    reader.close();
                }
            }

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(fos);
        }
    }

• 调用示例

    @Test
    public void testTwo() throws IOException {
        ContractEntity contractEntity = contractEntityMapper.selectByPrimaryKey(455);
        ContractTemplate contractTemplate = new ContractTemplate();
        //往map中填充数据，键就是我们在生成模版的时候，里面的fieldName，value就是要填充的数据
        HashMap map = new HashMap();
        map.put("studentStatus","1");
        map.put("submitTime", "2");
        map.put("referenceNo","3");
        map.put("branch", "4");
        //填充图片，传入的是一个图片的url地址，但实际上，是要传下图片的byte[]数据，在工具类中，会先获取图片的byte数据，然后，再往pdf里面填充，具体可以参照工具方法中的备注
        map.put("signImage", "https://ls.resource.penrose.com.cn/");
        //模版PDF文件的地址
        String sourceFile = "C:\\Users\\admin\\Desktop\\contractForm.pdf";
        //填充以后，生成的PDF文件
        String targetFile = "C:\\Users\\admin\\Desktop\\testForm_fill.pdf";
        //调用工具方法
        genPdf(map, sourceFile, targetFile);
    }