java 导出word，java根据提供word模板导出word文档

客官°小女子只卖身不卖艺 2023-10-12 18:02 212阅读 0赞

本文主要讲解，利用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 方法调用
    1. 基本介绍
    • 3.1 功能介绍
    • 3.2 版本说明
    • 3.3 快速开始

1.效果示例图

1.1 word模板

在这里插入图片描述

注意：这里提前阐述几个概念。

  1. 基本上所有的变量都由{ {}}包裹，交给poi-tl解析（变量命名随便你，中文，英文都可以）
  2. { {工作经历列表}}下方的[序号]、[公司名]、[工作时长]、[salary]、[联系]、[岗位]，就是使用了 poi-tl的表格行插件，动态渲染表格行的语法，可以简单理解为此处表格对应的每一行就是一个对象实体类，而{ {工作经历列表}}就是一个list
  3. { {?申明项列表}} { {item}} { {/申明项列表}}，此处则是使用了poi-tl的区块对标签。区块对在此处的，我只是用它来实现渲染同一个表格内的多行文本渲染，可以理解为<申明项列表>标签对应的就是一个list，< item >就是一个list中的一个个对象元素。并且此处会触发，换行后序号累加的word编排编号样式。
  4. { {@员工签字图片}}，此处需要注意，word模板中代表图片的变量，必须要加上@特殊符号修饰！

1.2 参数替换后的word

在这里插入图片描述

看到这里，如果对应的效果不满足你的需求，那么你可以出门右转了。

2.代码展示

maven 依赖，使用poi-tl需要支持 poi高版本

  1. <!--    POI 依赖 使用xlsx xml的格式(即XSSFWorkbook)   -->
  2.         <dependency>
  3.             <groupId>org.apache.poi</groupId>
  4.             <artifactId>poi</artifactId>
  5.             <version>5.2.2</version>
  6.         </dependency>
  7.         <dependency>
  8.             <groupId>org.apache.poi</groupId>
  9.             <artifactId>poi-ooxml</artifactId>
  10.             <version>5.2.2</version>
  11.         </dependency>
  12.         <dependency>
  13.             <groupId>org.apache.poi</groupId>
  14.             <artifactId>poi-scratchpad</artifactId>
  15.             <version>3.17</version>
  16.         </dependency>
  18.         <!--     poi模板导入，主力包      -->
  19.         <dependency>
  20.             <groupId>com.deepoove</groupId>
  21.             <artifactId>poi-tl</artifactId>
  22.             <version>1.12.1</version>
  23.         </dependency>

2.1 根据网络生成word

  1. /**
  2.      * 根据网络生成word
  3.      **/
  4.     public static void generateByNetWork() {
  6.         String ip = "192.168.x.x";
  7.         // 我这里是用文件服务器返回的网络文件流，你也可以直接放置一个文件的url
  8.         String pictureUrl = "http://" + ip + ":8080/api/file/download?id=b9e0ac0336a84fc0b4ebb4cdf2c805e0.png";
  9.         HashMap<String, Object> finalMap = new HashMap<>();
  10.         finalMap.put("姓名", "张三");
  11.         finalMap.put("身份证号", "511232XXXXXXX");
  12.         finalMap.put("手机号", "1328292xxxx");
  13.         finalMap.put("员工签字", "张三");
  14.         finalMap.put("日期", "2023-05-16");
  15.         // 从网络流读取图片，置入word模板，等待编译
  16.         if (Validator.isNotEmpty(pictureUrl)) {
  18.             PictureRenderData picture = Pictures.ofUrl(pictureUrl).size(40, 30).create();
  19.             finalMap.put("员工签字图片", picture);
  20.         }
  21.         ArrayList<Object> workList = CollUtil.newArrayList();
  22.         finalMap.put("工作经历列表", workList);
  23.         for (int i = 0; i < 3; i++) {
  25.             // 模拟从mysql查询列表数据
  26.             HashMap<String, Object> workItem = new HashMap<>();
  27.             workItem.put("序号", i + 1);
  28.             workItem.put("公司名", "四川有限公司" + i);
  29.             workItem.put("工作时长", i + 10 + "小时");
  30.             workItem.put("salary", "800" + i);
  31.             workItem.put("联系", "项目经理" + i);
  32.             workItem.put("岗位", "java工程师" + i);
  33.             workList.add(workItem);
  34.         }
  35.         // 注意：此处用的是 <区块对> key是字符串，value则放置一个集合，类似于模板引擎的foreach标签
  36.         ArrayList<Object> stateList = CollUtil.newArrayList();
  37.         finalMap.put("申明项列表", stateList);
  38.         // 模拟从mysql查询数据，改造为word模板所需的数据结构
  39.         List<String> stateListFromMySQL = Arrays.asList("本人所递交的所有办理人才引进材料及填写的情况均属实；"
  40.                 , "我已认真阅读以上内容并确认；"
  41.                 , "若在申请期间信息变更不做变更。若违反，本人愿意承担由此产生的后果。");
  42.         for (int i = 0; i < stateListFromMySQL.size(); i++) {
  44.             HashMap<String, Object> stateItem = new HashMap<>();
  45.             // 此处在 每行文字后，都添加\n 的换行符。注意：此换行仅仅只是换行，并不等同于enter，不会触发类似于 <在word中enter换行，自动触发编排序号累加> 的动作
  46.             stateItem.put("item", stateListFromMySQL.get(i) + "\n");
  47.             stateList.add(stateItem);
  48.         }
  49.         // 从网络url 下载word模板到指定文件夹
  50.         File wordTemplate = HttpUtil.downloadFileFromUrl("http://" + ip + ":8080/file/download" + "?id=talentsTemplate.docx", "D://upload" + File.separator);
  51.         // 此处使用了poi-tl的<表格行循环插件>，此处一定要进行参数bind，方便word模板参数替换
  52.         LoopRowTableRenderPolicy policy = new LoopRowTableRenderPolicy();
  53.         Configure build = Configure.builder().bind(policy, "工作经历列表").build();
  54.         // 进行编译
  55.         XWPFTemplate render = XWPFTemplate.compile(wordTemplate.getAbsolutePath(), build).render(finalMap);
  56.         File word = new File("D://upload" + File.separator + IdUtil.getSnowflake().nextId() + ".docx");
  57.         try {
  59.             // 关键步骤，
  60.             render.writeToFile(word.getAbsolutePath());
  61.         } catch (IOException e) {
  63.             throw new RuntimeException(e);
  64.         }
  65.         // 下面的方法可以根据业务调整，我这里是将参数替换后的word上传到项目对应的文件服务器，拿到的url进行存入数据库
  66.         String json = HttpUtil.createPost("http://" + ip + ":8080/file/upload")
  67.                 .header("Content-Type", ContentType.MULTIPART.getValue())
  68.                 .form("file", word)
  69.                 .execute()
  70.                 .body();
  71.         // hutool工具类，删除 word。因为在这个流程中，word只是一个中间产物，因为我上边已经把该word 上传到我的文件服务器，并且文件服务器 会返回给我它对应的url
  72.         FileUtil.del(word);
  73.         List<String> list = JSONUtil.parseArray(json).toList(String.class);
  75.     }

2.2 根据本地文件流生成word

  1. /**
  2.      * 根据本地文件流生成word
  3.      **/
  4.     public static void generateByFile() {
  6.         // 此处直接是本地文件的绝对路径
  7.         String pictureUrl = "C://Users//x//Desktop//博客//word模板填参//generate//sign.png";
  8.         HashMap<String, Object> finalMap = new HashMap<>();
  9.         finalMap.put("姓名", "张三");
  10.         finalMap.put("身份证号", "511232XXXXXXX");
  11.         finalMap.put("手机号", "1328292xxxx");
  12.         finalMap.put("员工签字", "张三");
  13.         finalMap.put("日期", "2023-05-16");
  14.         // 从本地读取图片，置入word模板，等待编译
  15.         if (Validator.isNotEmpty(pictureUrl)) {
  17.             PictureRenderData picture = Pictures.ofLocal(pictureUrl).size(60, 50).create();
  18.             finalMap.put("员工签字图片", picture);
  19.         }
  20.         ArrayList<Object> workList = CollUtil.newArrayList();
  21.         finalMap.put("工作经历列表", workList);
  22.         for (int i = 0; i < 3; i++) {
  24.             // 模拟从mysql查询列表数据
  25.             HashMap<String, Object> workItem = new HashMap<>();
  26.             workItem.put("序号", i + 1);
  27.             workItem.put("公司名", "成都有限公司" + i);
  28.             workItem.put("工作时长", i + 5 + "小时");
  29.             workItem.put("salary", "1000" + i);
  30.             workItem.put("联系", "联系人" + i);
  31.             workItem.put("岗位", "岗位" + i);
  32.             workList.add(workItem);
  33.         }
  34.         // 注意：此处用的是 <区块对> key是字符串，value则放置一个集合，类似于模板引擎的foreach标签
  35.         ArrayList<Object> stateList = CollUtil.newArrayList();
  36.         finalMap.put("申明项列表", stateList);
  37.         // 模拟从mysql查询数据，改造为word模板所需的数据结构
  38.         List<String> stateListFromMySQL = Arrays.asList("本人所递交的所有办理人才引进材料及填写的情况均属实；"
  39.                 , "我已认真阅读以上内容并确认；"
  40.                 , "若在申请期间信息变更不做变更。若违反，本人愿意承担由此产生的后果。");
  41.         for (int i = 0; i < stateListFromMySQL.size(); i++) {
  43.             HashMap<String, Object> stateItem = new HashMap<>();
  44.             stateItem.put("item", stateListFromMySQL.get(i) + "");
  45.             stateList.add(stateItem);
  46.         }
  47.         // 从网络url 下载word模板到指定文件夹
  48.         File wordTemplate = new File("C://Users//x//Desktop//博客//word模板填参//talentsTemplate.docx");
  49.         // 此处使用了poi-tl的<表格行循环插件>，此处一定要进行参数bind，方便word模板参数替换
  50.         LoopRowTableRenderPolicy policy = new LoopRowTableRenderPolicy();
  51.         Configure build = Configure.builder().bind(policy, "工作经历列表").build();
  52.         // 进行编译
  53.         String absolutePath = wordTemplate.getAbsolutePath();
  54.         XWPFTemplate render = XWPFTemplate.compile(absolutePath, build).render(finalMap);
  55.         // 此处是利用File，直接在本地创建文件，将参数替换后的文件流写入到该文件，word就是最终的结果
  56.         File word = new File("C://Users//x//Desktop//博客//word模板填参//generate" + File.separator + IdUtil.getSnowflake().nextId() + ".docx");
  57.         try {
  59.             render.writeToFile(word.getAbsolutePath());
  60.         } catch (IOException e) {
  62.             throw new RuntimeException(e);
  63.         }
  64.         // 下面的方法可以根据业务调整，我这里是将参数替换后的word上传到项目对应的文件服务器，拿到的url进行存入数据库
  65. //        FileUtil.del(word);
  66. //        List<String> list = JSONUtil.parseArray(json).toList(String.class);
  69.     }

2.3 方法调用

  1. public static void main(String[] args) {
  3. //        generateByNetWork();
  4.         generateByFile();
  5.     }

总结： 上面的备注已经说的很清楚了，这边不做过多解释。如果有哪里看不懂的，评论区评论，我有空就来给你解答。

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 快速开始

依赖引入

  1. maven
  2. <dependency>
  3.   <groupId>com.deepoove</groupId>
  4.   <artifactId>poi-tl</artifactId>
  5.   <version>1.12.1</version>
  6. </dependency>
  8. gradle
  9. implementation 'com.deepoove:poi-tl:1.12.1'

官网demo示例

  1. XWPFTemplate template = XWPFTemplate.compile("template.docx").render(
  2.   new HashMap<String, Object>(){
  3.     {
  5.     put("title", "Hi, poi-tl Word模板引擎");
  6. }});  
  7. template.writeAndClose(new FileOutputStream("output.docx"));

基本就是三部曲：

  1. compile 编译模板
  2. render 渲染数据
  3. write 输出到流
    TDO模式：Template + data-model = output

最后再次贴出官网链接，http://deepoove.com/poi-tl/\#\_why\_poi\_tl

如果有哪里看不懂的，评论区评论，我有空就来给你解答。

发表评论

表情：
评论列表 （有 0 条评论，212人围观）

还没有评论，来说两句吧...

相关阅读