java 导出word,java根据提供word模板导出word文档
本文主要讲解,利用poi-tl在word中动态生成表格行,进行文字、图片填充。一共提供了两种方式,1.基于本地文件 2.基于网络文件
本文讲解思路,1.先看示例,2. 示例对应的代码展示 3. 基本概念讲解(api自行查阅文档)。
这样便于快速展示,不符合你的业务需求的可以直接划走
目录标题
- 1.效果示例图
- 1.1 word模板
- 1.2 参数替换后的word
- 2.代码展示
- 2.1 根据网络生成word
- 2.2 根据本地文件流生成word
- 2.3 方法调用
- 3. 基本介绍
- 3.1 功能介绍
- 3.2 版本说明
- 3.3 快速开始
1.效果示例图
1.1 word模板
注意:这里提前阐述几个概念。
- 基本上所有的变量都由{{}}包裹,交给poi-tl解析(变量命名随便你,中文,英文都可以)
- {{工作经历列表}}下方的[序号]、[公司名]、[工作时长]、[salary]、[联系]、[岗位],就是使用了 poi-tl的表格行插件,动态渲染表格行的语法,可以简单理解为此处表格对应的每一行就是一个对象实体类,而{{工作经历列表}}就是一个list
- {{?申明项列表}} {{item}} {{/申明项列表}},此处则是使用了poi-tl的区块对标签。区块对在此处的,我只是用它来实现渲染同一个表格内的多行文本渲染,可以理解为<申明项列表>标签对应的就是一个list,< item >就是一个list中的一个个对象元素。并且此处会触发,换行后序号累加的word编排编号样式。
- {{@员工签字图片}},此处需要注意,word模板中代表图片的变量,必须要加上@特殊符号修饰!
1.2 参数替换后的word
看到这里,如果对应的效果不满足你的需求,那么你可以出门右转了。
2.代码展示
maven 依赖,使用poi-tl需要支持 poi高版本
<!-- POI 依赖 使用xlsx xml的格式(即XSSFWorkbook) --><dependency><groupId>org.apache.poi</groupId><artifactId>poi</artifactId><version>5.2.2</version></dependency><dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml</artifactId><version>5.2.2</version></dependency><dependency><groupId>org.apache.poi</groupId><artifactId>poi-scratchpad</artifactId><version>3.17</version></dependency><!-- poi模板导入,主力包 --><dependency><groupId>com.deepoove</groupId><artifactId>poi-tl</artifactId><version>1.12.1</version></dependency>
2.1 根据网络生成word
/*** 根据网络生成word**/public static void generateByNetWork() {String ip = "192.168.x.x";// 我这里是用文件服务器返回的网络文件流,你也可以直接放置一个文件的urlString pictureUrl = "http://" + ip + ":9527/api/asset/file/download?id=b9e0ac0336a84fc0b4ebb4cdf2c805e0.png";HashMap<String, Object> finalMap = new HashMap<>();finalMap.put("姓名", "张三");finalMap.put("身份证号", "511232XXXXXXX");finalMap.put("手机号", "1328292xxxx");finalMap.put("员工签字", "张三");finalMap.put("日期", "2023-05-16");// 从网络流读取图片,置入word模板,等待编译if (Validator.isNotEmpty(pictureUrl)) {PictureRenderData picture = Pictures.ofUrl(pictureUrl).size(40, 30).create();finalMap.put("员工签字图片", picture);}ArrayList<Object> workList = CollUtil.newArrayList();finalMap.put("工作经历列表", workList);for (int i = 0; i < 3; i++) {// 模拟从mysql查询列表数据HashMap<String, Object> workItem = new HashMap<>();workItem.put("序号", i + 1);workItem.put("公司名", "四川有限公司" + i);workItem.put("工作时长", i + 10 + "小时");workItem.put("salary", "800" + i);workItem.put("联系", "项目经理" + i);workItem.put("岗位", "java工程师" + i);workList.add(workItem);}// 注意:此处用的是 <区块对> key是字符串,value则放置一个集合,类似于模板引擎的foreach标签ArrayList<Object> stateList = CollUtil.newArrayList();finalMap.put("申明项列表", stateList);// 模拟从mysql查询数据,改造为word模板所需的数据结构List<String> stateListFromMySQL = Arrays.asList("本人所递交的所有办理人才引进材料及填写的情况均属实;", "我已认真阅读以上内容并确认;", "若在申请期间信息变更不做变更。若违反,本人愿意承担由此产生的后果。");for (int i = 0; i < stateListFromMySQL.size(); i++) {HashMap<String, Object> stateItem = new HashMap<>();// 此处在 每行文字后,都添加\n 的换行符。注意:此换行仅仅只是换行,并不等同于enter,不会触发类似于 <在word中enter换行,自动触发编排序号累加> 的动作stateItem.put("item", stateListFromMySQL.get(i) + "\n");stateList.add(stateItem);}// 从网络url 下载word模板到指定文件夹File wordTemplate = HttpUtil.downloadFileFromUrl("http://" + ip + ":9091/file/download" + "?id=talentsTemplate.docx", "D://upload" + File.separator);// 此处使用了poi-tl的<表格行循环插件>,此处一定要进行参数bind,方便word模板参数替换LoopRowTableRenderPolicy policy = new LoopRowTableRenderPolicy();Configure build = Configure.builder().bind(policy, "工作经历列表").build();// 进行编译XWPFTemplate render = XWPFTemplate.compile(wordTemplate.getAbsolutePath(), build).render(finalMap);File word = new File("D://upload" + File.separator + IdUtil.getSnowflake().nextId() + ".docx");try {// 关键步骤,render.writeToFile(word.getAbsolutePath());} catch (IOException e) {throw new RuntimeException(e);}// 下面的方法可以根据业务调整,我这里是将参数替换后的word上传到项目对应的文件服务器,拿到的url进行存入数据库String json = HttpUtil.createPost("http://" + ip + ":9091/file/upload").header("Content-Type", ContentType.MULTIPART.getValue()).form("file", word).execute().body();// hutool工具类,删除 word。因为在这个流程中,word只是一个中间产物,因为我上边已经把该word 上传到我的文件服务器,并且文件服务器 会返回给我它对应的urlFileUtil.del(word);List<String> list = JSONUtil.parseArray(json).toList(String.class);}
2.2 根据本地文件流生成word
/*** 根据本地文件流生成word**/public static void generateByFile() {// 此处直接是本地文件的绝对路径String pictureUrl = "C://Users//x//Desktop//博客//word模板填参//generate//sign.png";HashMap<String, Object> finalMap = new HashMap<>();finalMap.put("姓名", "张三");finalMap.put("身份证号", "511232XXXXXXX");finalMap.put("手机号", "1328292xxxx");finalMap.put("员工签字", "张三");finalMap.put("日期", "2023-05-16");// 从本地读取图片,置入word模板,等待编译if (Validator.isNotEmpty(pictureUrl)) {PictureRenderData picture = Pictures.ofLocal(pictureUrl).size(60, 50).create();finalMap.put("员工签字图片", picture);}ArrayList<Object> workList = CollUtil.newArrayList();finalMap.put("工作经历列表", workList);for (int i = 0; i < 3; i++) {// 模拟从mysql查询列表数据HashMap<String, Object> workItem = new HashMap<>();workItem.put("序号", i + 1);workItem.put("公司名", "成都有限公司" + i);workItem.put("工作时长", i + 5 + "小时");workItem.put("salary", "1000" + i);workItem.put("联系", "联系人" + i);workItem.put("岗位", "岗位" + i);workList.add(workItem);}// 注意:此处用的是 <区块对> key是字符串,value则放置一个集合,类似于模板引擎的foreach标签ArrayList<Object> stateList = CollUtil.newArrayList();finalMap.put("申明项列表", stateList);// 模拟从mysql查询数据,改造为word模板所需的数据结构List<String> stateListFromMySQL = Arrays.asList("本人所递交的所有办理人才引进材料及填写的情况均属实;", "我已认真阅读以上内容并确认;", "若在申请期间信息变更不做变更。若违反,本人愿意承担由此产生的后果。");for (int i = 0; i < stateListFromMySQL.size(); i++) {HashMap<String, Object> stateItem = new HashMap<>();stateItem.put("item", stateListFromMySQL.get(i) + "");stateList.add(stateItem);}// 从网络url 下载word模板到指定文件夹File wordTemplate = new File("C://Users//x//Desktop//博客//word模板填参//talentsTemplate.docx");// 此处使用了poi-tl的<表格行循环插件>,此处一定要进行参数bind,方便word模板参数替换LoopRowTableRenderPolicy policy = new LoopRowTableRenderPolicy();Configure build = Configure.builder().bind(policy, "工作经历列表").build();// 进行编译String absolutePath = wordTemplate.getAbsolutePath();XWPFTemplate render = XWPFTemplate.compile(absolutePath, build).render(finalMap);// 此处是利用File,直接在本地创建文件,将参数替换后的文件流写入到该文件,word就是最终的结果File word = new File("C://Users//x//Desktop//博客//word模板填参//generate" + File.separator + IdUtil.getSnowflake().nextId() + ".docx");try {render.writeToFile(word.getAbsolutePath());} catch (IOException e) {throw new RuntimeException(e);}// 下面的方法可以根据业务调整,我这里是将参数替换后的word上传到项目对应的文件服务器,拿到的url进行存入数据库
// FileUtil.del(word);
// List<String> list = JSONUtil.parseArray(json).toList(String.class);}
2.3 方法调用
public static void main(String[] args) {// generateByNetWork();generateByFile();}
总结: 上面的备注已经说的很清楚了,这边不做过多解释。如果有哪里看不懂的,评论区评论,我有空就来给你解答。
3. 基本介绍
此处不做api介绍,只做基本概念介绍,不需要的可以跳过了!
官网 http://deepoove.com/poi-tl/
poi-tl(poi template language)是Word模板引擎,使用Word模板和数据创建很棒的Word文档。
方案 | 移植性 | 功能性 | 易用性 |
---|---|---|---|
Poi-tl | Java跨平台 | Word模板引擎,基于Apache POI,提供更友好的API | 低代码,准备文档模板和数据即可 |
Apache POI | Java跨平台 | Apache项目,封装了常见的文档操作,也可以操作底层XML结构 | 文档不全,这里有一个教程:Apache POI Word快速入门 |
Freemarker | XML跨平台 | 仅支持文本,很大的局限性 | 不推荐,XML结构的代码几乎无法维护 |
OpenOffice | 部署OpenOffice,移植性较差 | - | 需要了解OpenOffice的API |
HTML浏览器导出 | 依赖浏览器的实现,移植性较差 | HTML不能很好的兼容Word的格式,样式糟糕 | - |
Jacob、winlib | Windows平台 | - | 复杂,完全不推荐使用 |
3.1 功能介绍
3.2 版本说明
本文博客使用的是poi-tl最新版,需要apache poi 5.1.0+,不然会报错,no such method
3.3 快速开始
依赖引入
maven
<dependency><groupId>com.deepoove</groupId><artifactId>poi-tl</artifactId><version>1.12.1</version>
</dependency>gradle
implementation 'com.deepoove:poi-tl:1.12.1'
官网demo示例
XWPFTemplate template = XWPFTemplate.compile("template.docx").render(new HashMap<String, Object>(){{put("title", "Hi, poi-tl Word模板引擎");
}});
template.writeAndClose(new FileOutputStream("output.docx"));
基本就是三部曲:
- compile 编译模板
- render 渲染数据
- write 输出到流
TDO模式:Template + data-model = output
最后再次贴出官网链接,http://deepoove.com/poi-tl/#_why_poi_tl
如果有哪里看不懂的,评论区评论,我有空就来给你解答。
java 导出word,java根据提供word模板导出word文档相关推荐
- 基于java web servlet生鲜商城管理系统源码含报告文档
(一)目的 电子商务的迅速兴起,网上购物也为人们的生活提供了极大的便利,不受时间和空间的限制.商城系统的兴起,扩大了消费市场的空间,对于大型企业来说,建设商城系统是正确的选择,不仅要扩大销售渠道,而且 ...
- 【Java神器】跟jQuery那样简单方便操作Html文档的Java工具类,今天我必须要告知你!...
神器介绍 今天我要介绍一款操作Html文档非常好用的Java插件,强烈安利!因为实在太好用了! " Jsoup 是一款纯Java实现,可以非常方便读取和操作Html文档的一款插件.她的API ...
- java mysql基于SSM宠物寄养中心系统源码+文档
活动地址:毕业季·进击的技术er 博主介绍:✌在职Java研发工程师.专注于程序设计.源码分享.技术交流.专注于Java技术领域和毕业设计✌ 项目名称 java mysql基于SSM宠物寄养中心系统源 ...
- java计算机毕业设计计算机专业招聘网站MyBatis+系统+LW文档+源码+调试部署
java计算机毕业设计计算机专业招聘网站MyBatis+系统+LW文档+源码+调试部署 java计算机毕业设计计算机专业招聘网站MyBatis+系统+LW文档+源码+调试部署 本源码技术栈: 项目架构 ...
- java高校墨香文学社管理系统计算机毕业设计MyBatis+系统+LW文档+源码+调试部署
java高校墨香文学社管理系统计算机毕业设计MyBatis+系统+LW文档+源码+调试部署 java高校墨香文学社管理系统计算机毕业设计MyBatis+系统+LW文档+源码+调试部署 本源码技术栈: ...
- java计算机毕业设计健身房管理系统演示录像2021MyBatis+系统+LW文档+源码+调试部署
java计算机毕业设计健身房管理系统演示录像2021MyBatis+系统+LW文档+源码+调试部署 java计算机毕业设计健身房管理系统演示录像2021MyBatis+系统+LW文档+源码+调试部署 ...
- 计算机毕业设计Java河池市旅游信息系统(源码+系统+mysql数据库+lw文档)
计算机毕业设计Java河池市旅游信息系统(源码+系统+mysql数据库+lw文档) 计算机毕业设计Java河池市旅游信息系统(源码+系统+mysql数据库+lw文档) 本源码技术栈: 项目架构:B/S ...
- 基于Java毕业设计研究生招生信息管理源码+系统+mysql+lw文档+部署软件
基于Java毕业设计研究生招生信息管理源码+系统+mysql+lw文档+部署软件 基于Java毕业设计研究生招生信息管理源码+系统+mysql+lw文档+部署软件 本源码技术栈: 项目架构:B/S架构 ...
- 计算机毕业设计Java新生报到管理(源码+系统+mysql数据库+lw文档)
计算机毕业设计Java新生报到管理(源码+系统+mysql数据库+lw文档) 计算机毕业设计Java新生报到管理(源码+系统+mysql数据库+lw文档) 本源码技术栈: 项目架构:B/S架构 开发语 ...
- 基于JAVA糖果销售管理系统计算机毕业设计源码+数据库+lw文档+系统+部署
基于JAVA糖果销售管理系统计算机毕业设计源码+数据库+lw文档+系统+部署 基于JAVA糖果销售管理系统计算机毕业设计源码+数据库+lw文档+系统+部署 本源码技术栈: 项目架构:B/S架构 开发语 ...
最新文章
- 指针变量p与“零值”进行比较的if 语句怎么写?
- ffmpeg基本用法
- 如何在MacOS上创建第一个iOS Flutter应用
- Podfile grammar
- Microsoft Deployment Toolkit 2010 新功能实战之一
- 【转】C#命名空间与java包的区别分析
- python量化数据处理小细节(以后还会不断补充)
- LeetCode 5367. 最长快乐前缀
- C语言的本质(2)——二进制、八进制、十六进制与十进制
- [Windows]GFlag内存泄漏排查
- git 公钥提交代码_Git自由之章 - 关于SSH 公钥
- 英读廊——如果运动引起摩擦,摩擦生热,为什么风吹得越快却越冷
- 悉尼大学计算机专业本科学费,悉尼大学
- python 把矩阵变成一维_python矩阵转换为一维数组的实例
- 【计算机网络】谢希仁笔记 应用层
- 学习Matlab的第一个程序——用二分法求根
- 物联网连接拼图:蜂窝与非蜂窝
- 最简单的Java设计模式
- golang map 锁_go 安全map 实现, 互斥锁和读写锁
- 2022年广东高新技术企业优惠政策及高新企业申请条件,补贴20-100万