本文主要讲解,利用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
- {{” />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 + ":8080/api/file/download" />;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,不会触发类似于 的动作stateItem.put("item", stateListFromMySQL.get(i) + "\n");stateList.add(stateItem);}// 从网络url 下载word模板到指定文件夹File wordTemplate = HttpUtil.downloadFileFromUrl("http://" + ip + ":8080/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 + ":8080/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 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>gradleimplementation '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
如果有哪里看不懂的,评论区评论,我有空就来给你解答。