使用Aspose.word (Java) 填充word文档数据(包含图片填充)
Aspose填充word数据
本文介绍了如何使用aspose进行word文档的生成,并提供了工具类供参考。
有问题欢迎 call 微信:905369866,小弟尽力而为。。毕竟这玩意没吃透。
1. 建立一个word模板
1.1 定义单个变量
- 在word文档中,在菜单栏中依次点击
插入
->文档部件
->域
; - 接着在弹出框中选择
MergeField
域,在域属性中填写域名,该域名即为变量名,填写完毕后点击确定
即可;
生成如图所示的样式,即为添加成功
1.2 定义集合变量
当单一变量无法满足需求后,我们就需要定义集合变量,我就拿员工薪资统计来举例,一个表格里面会有多个数据。此时,我们应该插入
List
数据到模板文件中。
- 模板关键字:
TableStart:集合名称
,TableEnd:集合名称
- 同样的,在文本域中选择
MergeField
,域名要用TableStart
打头,紧接冒号:
,再然后就是定义集合的名称。需要注意的是,TableStart
意为集合的开始,所以我们再集合结束的地方,需要添加结束标识TableEnd
。 TableStart
和TableEnd
之间的变量,就是集合中每个属性的变量名称。
添加完毕之后,如图所示
1.3 定义图片变量
图片变量与单个变量一致。
Word模板书写到此结束
1.4 演示模板文档下载
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.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 chimmhuang@163.com
* @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 开始使用
- 首先,我们先定义和模板对应的数据,我们先定义列表里面的 [员工薪资信息]
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 chimmhuang@163.com
*/
@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.awt.image.BufferedImage;
import java.math.BigDecimal;
import java.util.List;
/**
* 文档模板数据
*
* @author Chimm Huang
* @author chimmhuang@163.com
*/
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class SalaryData {
/** 公司名称 */
private String companyName;
/** 员工薪资列表 */
private List<Worker> workerList;
/** 工资总和 */
private BigDecimal totalSalary;
/** 公司log */
private BufferedImage logImg;
}
- 定义好以上数据之后,我们就可以开始进行数据的填充,工具类提供两种填充方法
- 一种是传递
Object
数据进行数据填充 - 另一种是传递
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 chimmhuang@163.com
*/
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
使用Aspose.word (Java) 填充word文档数据(包含图片填充)的更多相关文章
- 使用Freemarker导出Word文档(包含图片)代码实现及总结
.personSunflowerP { background: rgba(51, 153, 0, 0.66); border-bottom: 1px solid rgba(0, 102, 0, 1); ...
- 用 Freemarker 生成 word 文档(包含图片)
1. 用word写一个需要导出的word模板,然后存为xml格式. 2. 将xml中需要动态修改内容的地方,换成freemarker的标识符,例如: <w:p wsp:rsidR="0 ...
- 将多个 docx 文件使用 POI 进行合并,生成单个文档,包含图片
1 添加 maven 依赖,需要使用 poi 的依赖项 <!-- https://mvnrepository.com/artifact/org.apache.poi/poi-scratchpad ...
- Java 用Freemarker完美导出word文档(带图片)
Java 用Freemarker完美导出word文档(带图片) 前言 最近在项目中,因客户要求,将页面内容(如合同协议)导出成word,在网上翻了好多,感觉太乱了,不过最后还是较好解决了这个问题. ...
- 【Java】用Freemarker完美导出word文档(带图片)
Java 用Freemarker完美导出word文档(带图片) 前言 最近在项目中,因客户要求,将页面内容(如合同协议)导出成word,在网上翻了好多,感觉太乱了,不过最后还是较好解决了这个问题. ...
- 将Word,PDF文档转化为图片
#region 将Word文档转化为图片 /// <summary> /// 将Word文档转化为图片 /// </summary> /// <param name=&q ...
- C# 提取Word文档中的图片
C# 提取Word文档中的图片 图片和文字是word文档中两种最常见的对象,在微软word中,如果我们想要提取出一个文档内的图片,只需要右击图片选择另存为然后命名保存就可以了,今天这篇文章主要是实现使 ...
- 如何取出word文档里的图片
在生活当中,Word办公是必不可少的.但是在工作中也会遇到一些麻烦,比如说如何取出word文档里的图片呢?有的人会通过复制粘贴,通过画图保存,可是这种方法未免太繁琐了吧.下面我就来分享一下我的经验. ...
- word中怎样把文档里的中文以及中文字符全选?
word中怎样把文档里的中文以及中文字符全选? 参考: 百度 案例: 有个文档是中英文混杂的 现在需要把中文以及中文字符全部设置成别的颜色 应该怎样操作? 有80多页 别说让我一个一个的设置 以wor ...
随机推荐
- Spring Cloud 系列之 Consul 配置中心
前面我们已经学习过 Spring Cloud Config 了: Spring Cloud 系列之 Config 配置中心(一) Spring Cloud 系列之 Config 配置中心(二) Spr ...
- 深入理解JS中的对象(三):class 的工作原理
目录 序言 class 是一个特殊的函数 class 的工作原理 class 继承的原型链关系 参考 1.序言 ECMAScript 2015(ES6) 中引入的 JavaScript 类实质上是 J ...
- Git基本操作命令合集
平时自己敲敲代码,使用Git命令也渐渐多了起来.使用起来的确很方便,今天来分享下Git基本概念和本地代码提交到github上的过程,很简单的,多操作几次就会了. Git定义 Git 是一个开源的分布式 ...
- airflow的安装和使用 - 完全版
之前试用了azkaban一小段时间,虽然上手快速方便,但是功能还是太简单,不够灵活. Airflow使用代码来管理任务,这样应该是最灵活的,决定试一下. 我是python零基础,在使用airflow的 ...
- Java——DOS命令窗口用命令编译文件夹下所有.java文件
1.进入指定目录 cd 进入用户主目录 cd ~ 进入用户主目录 cd - 返回进入此目录之前所在的目录 cd .. 返回上级目录 cd\ 直接退回到当前盘根目录2. ...
- 掌握了Docker Layer Caching才敢自称精通Dockerfile
长话短说: 本次原创将向您展示在Docker中使用Layer Cache以加快镜像构建. 这个话题的初衷在于:应用程序打包过程是很慢的(下载并安装框架&第三方依赖包.生成assets),这在D ...
- WordPress批量更换域名
UPDATE wp_options SET option_value = replace( option_value, 'http://www.old.com', 'http://www.new.co ...
- oracle 多表连接查询 join
转 简介: 多表连接查询通过表之间的关联字段,一次查询多表数据. 下面将依次介绍 多表连接中的如下方法: 1.from a,b 2.inner join 3.left outer join 4.rig ...
- 2020由浅入深最强Java面试题
1.String,StringBuffer和StringBuilder有什么区别? String是字符串常量,不可变对象,每次对String修改都等同于生成了一个新的String象,然后将指针 ...
- pytest跳过指定的测试或模块
参考Allure官方文档,pytest官方文档 实现setup/teardown 1.运行带指定标记的测试 @pytest.mark.tags ,这里的tags可以自定义 命令行执行:pytest - ...