使用Aspose.word (for Java) 生成填充wor

作者: 吃茫茫 | 来源:发表于2020-04-16 21:34 被阅读0次

Aspose填充word数据

本文介绍了如何使用aspose进行word文档的生成，并提供了工具类供参考。

@[toc]

1. 建立一个word模板

1.1 定义单个变量

在word文档中，在菜单栏中依次点击插入->文档部件->域；
接着在弹出框中选择MergeField域，在域属性中填写域名，该域名即为变量名，填写完毕后点击确定即可；
设置文档域名
生成如图所示的样式，即为添加成功
变量添加成功

1.2 定义集合变量

当单一变量无法满足需求后，我们就需要定义集合变量，我就拿员工薪资统计来举例，一个表格里面会有多个数据。此时，我们应该插入List数据到模板文件中。

模板关键字：TableStart:集合名称， TableEnd:集合名称
同样的，在文本域中选择MergeField，域名要用TableStart打头，紧接冒号:，再然后就是定义集合的名称。需要注意的是，TableStart意为集合的开始，所以我们再集合结束的地方，需要添加结束标识TableEnd。
TableStart 和 TableEnd 之间的变量，就是集合中每个属性的变量名称。
添加集合数据开始
添加完毕之后，如图所示
添加集合数据开始
Word模板书写到此结束

1.3 演示模板文档下载

点击此处下载演示文档

2. 入门使用

本人在公司里，合同这一块是起了一个微服务进行的，所以是稍加整理，把文档相关的操作给简化，整合到一个类里面，供大家参考。

2.1 使用前的准备工作

导入 aspose 的包，本人使用的是 aspose-words 16.8.0版本，各位可以去网上搜索一个下载，也可以克隆项目（参照：4. Demo 代码 Git 地址（含Jar包、模板文件））。
去除水印操作，同样的，各位可以去网上搜一个 license.xml 下载。（详细可以参照：3.1 水印说明）

2.2 导入工具类

package com.chimmhuang.util;

import com.aspose.words.Document;
import com.aspose.words.SaveFormat;
import com.aspose.words.SaveOptions;
import com.aspose.words.net.System.Data.DataRow;
import com.aspose.words.net.System.Data.DataTable;
import org.springframework.util.CollectionUtils;

import java.beans.IntrospectionException;
import java.beans.PropertyDescriptor;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author Chimm Huang
 * @date 2020/01/22
 */
public class ContractUtil {

    private ContractUtil() {
    }


    /**
     * 填充 word 模板（object数据格式）
     *
     * @param modelWordByte word模版二进制文件
     * @param obj     要填充的数据
     * @return 组合数据之后的word二进制
     */
    public static byte[] fillWordDataByDomain(byte[] modelWordByte, Object obj) {
        try {
            Class<?> aClass = obj.getClass();
            Field[] fields = aClass.getDeclaredFields();
            Map<String, Object> data = new HashMap<>(fields.length);
            for (Field field : fields) {
                PropertyDescriptor pd = new PropertyDescriptor(field.getName(), aClass);
                Method method = pd.getReadMethod();
                String key = field.getName();
                Object value = method.invoke(obj);
                if (value != null) {
                    data.put(key, value);
                }
            }
            return fillWordDataByMap(modelWordByte, data);
        } catch (Exception e) {
            return new byte[0];
        }
    }


    /**
     * 填充 word 模板（map数据格式）
     *
     * @param file word二进制
     * @param data 要填充的数据
     * @return 组合数据之后的word二进制
     */
    public static byte[] fillWordDataByMap(byte[] file, Map<String, Object> data) throws Exception {
        byte[] ret = null;
        if (CollectionUtils.isEmpty(data)) {
            return ret;
        }

        try (InputStream is = new ByteArrayInputStream(file);
             ByteArrayOutputStream out = new ByteArrayOutputStream()) {
            Document doc = new Document(is);
            Map<String, String> toData = new HashMap<>();
            for (Map.Entry<String, Object> en : data.entrySet()) {
                String key = en.getKey();
                Object value = en.getValue();

                if (value instanceof List) {
                    //写入表数据
                    DataTable dataTable = fillListData((List) value, key);
                    doc.getMailMerge().executeWithRegions(dataTable);
                }

                String valueStr = String.valueOf(en.getValue());
                if (value == null || value.equals("null")) {
                    continue;
                }

                toData.put(key, valueStr);
            }

            String[] fieldNames = new String[toData.size()];
            String[] values = new String[toData.size()];

            int i = 0;
            for (Map.Entry<String, String> entry : toData.entrySet()) {
                fieldNames[i] = entry.getKey();
                values[i] = entry.getValue();
                i++;
            }

            //合并数据
            doc.getMailMerge().execute(fieldNames, values);
            doc.save(out, SaveOptions.createSaveOptions(SaveFormat.DOCX));
            ret = out.toByteArray();
        }

        return ret;
    }

    /**
     * 封装 list 数据到 word 模板中（word表格）
     *
     * @param list 数据
     * @param tableName 表格列表变量名称
     * @return word表格数据DataTable
     */
    private static DataTable fillListData(List<Object> list, String tableName) throws IntrospectionException, InvocationTargetException, IllegalAccessException {
        //创建DataTable,并绑定字段
        DataTable dataTable = new DataTable(tableName);
        for (Object obj : list) {
            //创建DataRow，封装该行数据
            DataRow dataRow = dataTable.newRow();
            Class<?> objClass = obj.getClass();
            Field[] fields = objClass.getDeclaredFields();
            for (int i = 0; i < fields.length; i++) {
                Field field = fields[i];
                dataTable.getColumns().add(fields[i].getName());
                PropertyDescriptor pd = new PropertyDescriptor(field.getName(), objClass);
                Method method = pd.getReadMethod();
                dataRow.set(i,method.invoke(obj));
            }
            dataTable.getRows().add(dataRow);
        }
        return dataTable;
    }

    //    private static License license = null;

    /**
     * 加载 license
     * 由于 aspose是收费的，若没有 license，则会出现水印。
     */
//    static {
//        try {
//            InputStream is = ContractUtil.class.getResourceAsStream("/license.xml");
//            license = new License();
//            license.setLicense(is);
//        } catch (Exception e) {
//            throw new RuntimeException("自动加载aspose证书文件失败!");
//        }
//    }
}

2.3 开始使用

首先，我们先定义和模板对应的数据，我们先定义列表里面的 [员工薪资信息]Worker 的数据

package com.chimmhuang.pojo;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.math.BigDecimal;

/**
 * 员工薪资信息
 *
 * @author Chimm Huang
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Worker {
    /** 员工姓名 */
    private String name;
    /** 年龄 */
    private Integer age;
    /** 性别 */
    private String sex;
    /** 工资 */
    private BigDecimal salary;
}

接着我们定义整个模板的基本数据：SalaryData

package com.chimmhuang.pojo;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.math.BigDecimal;
import java.util.List;

/**
 * 文档模板数据
 *
 * @author Chimm Huang
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class SalaryData {
    /** 公司名称 */
    private String companyName;
    /** 员工薪资列表 */
    private List<Worker> workerList;
    /** 工资总和 */
    private BigDecimal totalSalary;
}

定义好以上数据之后，我们就可以开始进行数据的填充，工具类提供两种填充方法
1. 一种是传递 Object 数据进行数据填充
2. 另一种是传递 Map 数据进行数据填充

我在这里采用第一种方式进行数据的填充，个人也比较推荐使用domain数据。

package com.chimmhuang.run;

import com.chimmhuang.pojo.SalaryData;
import com.chimmhuang.pojo.Worker;
import com.chimmhuang.util.ContractUtil;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.math.BigDecimal;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.List;

/**
 * @author Chimm Huang
 */
public class App {

    public static void main(String[] args) throws IOException {

        // 封装员工薪资信息
        Worker worker1 = Worker.builder()
                .name("张三")
                .age(18)
                .sex("男")
                .salary(BigDecimal.valueOf(1000))
                .build();
        Worker worker2 = Worker.builder()
                .name("李四")
                .age(16)
                .sex("女")
                .salary(BigDecimal.valueOf(2000))
                .build();
        List<Worker> workerList = Arrays.asList(worker1, worker2);

        // 计算工资总和
        BigDecimal totalSalary = workerList.stream()
                .map(Worker::getSalary)
                .reduce(BigDecimal.ZERO, BigDecimal::add);

        // 封装文档模板数据
        SalaryData data = SalaryData.builder()
                .companyName("王多鱼股份有限公司")
                .workerList(workerList)
                .totalSalary(totalSalary)
                .build();


        // 读取模板文件
        byte[] modelByte = Files.readAllBytes(Paths.get("C:\\Users\\huangshuai\\Desktop\\模板.docx"));

        // 调用工具类，获取填充数据后的文件
        byte[] resultByte = ContractUtil.fillWordDataByDomain(modelByte, data);

        // 处理该二进制文件
        // 该二进制文件，即最终的word，在web中的应用，可通过response回写前端，也可上传到文件服务器
        // 具体的操作随工作需求而定，此处处理为输出到桌面
        File resultFile = new File("C:\\Users\\huangshuai\\Desktop\\员工薪资统计表.docx");
        FileOutputStream fos = new FileOutputStream(resultFile);
        fos.write(resultByte);
        fos.close();
    }
}

2.4 结果展示

结果展示

3. 注意事项

3.1 水印说明

看上方的图相比大家也不难发现，文档生成的同时，也多了红色的一串字体。
由于 aspose 是收费的，所以想要去水印使用，需要添加 license.xml，由于本人使用的是公司提供的凭证，所以我就不传上来了，如有需要，可以选择购买 aspose 的服务，或者上网搜一个 license.xml。

3.2 如何添加 license

我已经在工具类中提供了一个静态初始化方法，大家下载好 license.xml 之后，放入对应的目录，将注释部分去掉即可。

4. Demo 代码 Git 地址（含Jar包、模板文件）

<span id="title-4"></span>
码云地址：https://gitee.com/chimmhuang/Aspose-word-demo
欢迎 Star、fork