使用Aspose.word (Java) 填充word文檔數據（包含圖片填充）

Aspose填充word數據

本文介紹了如何使用aspose進行word文檔的生成，並提供了工具類供參考。
有問題歡迎 call 微信：905369866，小弟盡力而為。。畢竟這玩意沒吃透。

目錄

• Aspose填充word數據
  • 1. 建立一個word模板
    • 1.1 定義單個變量
    • 1.2 定義集合變量
    • 1.3 定義圖片變量
    • 1.4 演示模板文檔下載
  • 2. 入門使用
    • 2.1 使用前的准備工作
    • 2.2 導入工具類
    • 2.3 開始使用
    • 2.4 結果展示
  • 3. 注意事項
    • 3.1 水印說明
    • 3.2 如何添加 license
  • 4. Demo 代碼 Git 地址（含Jar包、模板文件）

1. 建立一個word模板

1.1 定義單個變量

1. 在word文檔中，在菜單欄中依次點擊插入->文檔部件->域；
2. 接着在彈出框中選擇MergeField域，在域屬性中填寫域名，該域名即為變量名，填寫完畢后點擊確定即可；
   
   生成如圖所示的樣式，即為添加成功
   

1.2 定義集合變量

當單一變量無法滿足需求后，我們就需要定義集合變量，我就拿員工薪資統計來舉例，一個表格里面會有多個數據。此時，我們應該插入List數據到模板文件中。

1. 模板關鍵字：TableStart:集合名稱， TableEnd:集合名稱
2. 同樣的，在文本域中選擇MergeField，域名要用TableStart打頭，緊接冒號:，再然后就是定義集合的名稱。需要注意的是，TableStart意為集合的開始，所以我們再集合結束的地方，需要添加結束標識TableEnd。
3. TableStart 和 TableEnd 之間的變量，就是集合中每個屬性的變量名稱。
   
   添加完畢之后，如圖所示
   

1.3 定義圖片變量

圖片變量與單個變量一致。

Word模板書寫到此結束

1.4 演示模板文檔下載

點擊此處下載演示文檔

2. 入門使用

本人在公司里，合同這一塊是起了一個微服務進行的，所以是稍加整理，把文檔相關的操作給簡化，整合到一個類里面，供大家參考。

2.1 使用前的准備工作

1. 導入 aspose 的包，本人使用的是 aspose-words 16.8.0版本，各位可以去網上搜索一個下載，也可以克隆項目（參照：4. Demo 代碼 Git 地址（含Jar包、模板文件））。
2. 去除水印操作，同樣的，各位可以去網上搜一個 license.xml 下載。（詳細可以參照：3.1 水印說明）

2.2 導入工具類

package com.chimmhuang.util;

import com.aspose.words.Document;
import com.aspose.words.DocumentBuilder;
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 java.awt.*;
import java.awt.geom.AffineTransform;
import java.awt.image.BufferedImage;
import java.awt.image.ColorModel;
import java.awt.image.WritableRaster;
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.Method;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author Chimm Huang
 * @author [e-mail]
 * @date 2020/01/22
 */
public class ContractUtil {

    private ContractUtil() {
    }

    /**
     * 調整bufferedimage大小
     * @param source BufferedImage 原始image
     * @param targetW int  目標寬
     * @param targetH int  目標高
     * @param flag boolean 是否同比例調整
     * @return BufferedImage  返回新image
     */
    public static BufferedImage resizeBufferedImage(BufferedImage source, int targetW, int targetH, boolean flag) {
        int type = source.getType();
        BufferedImage target = null;
        double sx = (double) targetW / source.getWidth();
        double sy = (double) targetH / source.getHeight();
        if (flag && sx > sy) {
            sx = sy;
            targetW = (int) (sx * source.getWidth());
        } else if(flag && sx <= sy){
            sy = sx;
            targetH = (int) (sy * source.getHeight());
        }
        if (type == BufferedImage.TYPE_CUSTOM) { // handmade
            ColorModel cm = source.getColorModel();
            WritableRaster raster = cm.createCompatibleWritableRaster(targetW, targetH);
            boolean alphaPremultiplied = cm.isAlphaPremultiplied();
            target = new BufferedImage(cm, raster, alphaPremultiplied, null);
        } else {
            target = new BufferedImage(targetW, targetH, type);
        }
        Graphics2D g = target.createGraphics();
        g.setRenderingHint(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY);
        g.drawRenderedImage(source, AffineTransform.getScaleInstance(sx, sy));
        g.dispose();
        return target;
    }


    /**
     * 填充 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 (data == null || data.isEmpty()) {
            return ret;
        }

        try (InputStream is = new ByteArrayInputStream(file);
             ByteArrayOutputStream out = new ByteArrayOutputStream()) {
            Document doc = new Document(is);
            DocumentBuilder builder = new DocumentBuilder(doc);
            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, builder);
                    doc.getMailMerge().executeWithRegions(dataTable);
                }

                if (value instanceof BufferedImage) {
                    builder.moveToMergeField(key);
                    builder.insertImage((BufferedImage) value);
                }

                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, DocumentBuilder builder) throws Exception {

        //創建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 開始使用

1. 首先，我們先定義和模板對應的數據，我們先定義列表里面的 [員工薪資信息]Worker 的數據

package com.chimmhuang.pojo;

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

import java.math.BigDecimal;

/**
 * 員工薪資信息
 *
 * @author Chimm Huang
 * @author [e-mail]
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Worker {
    /** 員工姓名 */
    private String name;
    /** 年齡 */
    private Integer age;
    /** 性別 */
    private String sex;
    /** 工資 */
    private BigDecimal salary;
}

2. 接着我們定義整個模板的基本數據：SalaryData

package com.chimmhuang.pojo;

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

import java.awt.image.BufferedImage;
import java.math.BigDecimal;
import java.util.List;

/**
 * 文檔模板數據
 *
 * @author Chimm Huang
 * @author [e-mail]
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class SalaryData {
    /** 公司名稱 */
    private String companyName;
    /** 員工薪資列表 */
    private List<Worker> workerList;
    /** 工資總和 */
    private BigDecimal totalSalary;
    /** 公司log */
    private BufferedImage logImg;
}

3. 定義好以上數據之后，我們就可以開始進行數據的填充，工具類提供兩種填充方法
   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 javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.FileInputStream;
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
 * @author [e-mail]
 */
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);

        // 圖片填充使用 BufferedImage 接受圖片
        BufferedImage image = ImageIO.read(new FileInputStream("C:\\Users\\huangshuai\\Desktop\\魚.png"));
        BufferedImage bufferedImage = ContractUtil.resizeBufferedImage(image, 50, 50, true);

        // 封裝文檔模板數據
        SalaryData data = SalaryData.builder()
                .companyName("王多魚股份有限公司")
                .workerList(workerList)
                .totalSalary(totalSalary)
                .logImg(bufferedImage)
                .build();


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

        // 調用工具類，獲取填充數據后的文件
        byte[] resultByte = ContractUtil.fillWordDataByDomain(modelByte, data);

        // 處理該二進制文件，此處處理為輸出到桌面
        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包、模板文件）

碼雲地址：https://gitee.com/chimmhuang/Aspose-word-demo
歡迎 Star、fork