java实现pdf电子合同设置合同编号

前言

    现在有一些用户信息合同,要求在合同上添加合同编号,合同编号要求按照一定规则系统生成.看过很多同学的实现方案,也尝试过很多,为了方便以后有同样需求的同学可以节省时间,进行了相关内容的梳理.

实现过程以及原理说明

    pdf内容处理可以使用开源项目itextpdf,本文仅适用免费部分.pdf格式文件中动态添加内容是基于表单域进行的.表单域可以这么理解,比如说下面是一份合同，其中有很多需要填写的地方,需要填写姓名、身份证、手机号等信息，每个需要填写的地方可以认为是一个表单域的一部分。

每个长方形的框称为域,每个域中都有一个域名称与之对应.

    本文的需求就是将合同编号一栏设置为动态生成。
    关于pdf编辑问题,需要使用pdf编辑器,当时下载过很多的编辑器,但是都是需要进行付费,这里推荐使用Adobe,下载地址(附安装步骤):Adobe Acrobat 9.0

处理过程

1. pdf表单域设置域名称

使用Adobe Acrobat打开合同文件,选择表单–添加或是编辑域

    选择合同编号所在域,设置合同编号对应的域名称,此处定义为contractNo.

    编辑好之后进行保存即可.

2. 代码部分

    需要导入的依赖:

		<dependency>
			<groupId>com.itextpdf</groupId>
			<artifactId>itextpdf</artifactId>
			<version>5.5.11</version>
		</dependency>
		<dependency>
			<groupId>com.itextpdf</groupId>
			<artifactId>itext-asian</artifactId>
			<version>5.2.0</version>
		</dependency>

    为方便使用,直接封装了一个工具类PdfUtils.java

public class PdfUtils {

    /**
     * 根据PDF模版生成PDF文件
     * @param templateFilePath PDF模版文件路径
     * @param pdfFilePath pdf文件保存路径
     * @param contractNo 合同编号
     */
    public static void buildPdf(String templateFilePath,String pdfFilePath,String contractNo) throws Exception {

        // 表单域数据填充
        HashMap<String,String> data = new HashMap<>();
        data.put("contractNo",contractNo);
        
	createPDF(templateFilePath,data,true,pdfFilePath);
    }

    /**
     * 根据PDF模版生成PDF文件
     * @param templateFilePath PDF模版文件路径
     * @param data 表单域数据
     * @param formFlattening false：生成后的PDF文件表单域仍然可编辑 true：生成后的PDF文件表单域不可编辑
     * @param pdfFilePath 生成PDF的文件路径
     */
    private static void createPDF(String templateFilePath, HashMap<String,String> data,
        boolean formFlattening, String pdfFilePath) throws Exception{
        PdfReader reader = null;
        ByteArrayOutputStream bos = null;
        PdfStamper pdfStamper = null;
        FileOutputStream fos = null;
        try{
            // 读取PDF模版文件
            reader = new PdfReader(templateFilePath);
            // 输出流
            bos = new ByteArrayOutputStream();
            // 构建PDF对象
            pdfStamper = new PdfStamper(reader, bos);

            // 获取表单数据
            AcroFields form = pdfStamper.getAcroFields();

            // 使用中文字体 使用 AcroFields填充值的不需要在程序中设置字体，在模板文件中设置字体为中文字体 Adobe 宋体 std L
            BaseFont bfChinese = BaseFont.createFont("STSongStd-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
            form.addSubstitutionFont(bfChinese);

            // 表单赋值
            for(String key : data.keySet()){
                form.setField(key,data.get(key));
                // 也可以指定字体
                form.setFieldProperty(key, "textfont", bfChinese, null);
            }

            // 如果为false那么生成的PDF文件还能编辑，一定要设为true
            pdfStamper.setFormFlattening(formFlattening);
            pdfStamper.close();

            // 保存文件
            fos = new FileOutputStream(pdfFilePath);
            fos.write(bos.toByteArray());
            fos.flush();
        }finally {
            if(null != fos){
                try {fos.close(); }catch (Exception e){e.printStackTrace();}
            }

            if(null != bos){
                try {bos.close(); }catch (Exception e){e.printStackTrace();}
            }

            if(null != reader){
                try {reader.close(); }catch (Exception e){e.printStackTrace();}
            }
        }
    }
}

    生成之后内容预览:

    系统生成的合同编号已添加,到此功能完成!
    如有帮助,欢迎评论区留言点赞!