SpringBoot poi-tl通过模板占位符天生word文件

简介：

        开发中我们需要通过在word中使用占位符来动态渲染一些数据，本文解说poi-tl实现动态天生word文档，包括表格循环，对象嵌套。

---

poi-tl官网文档 Poi-tl Documentation

1. word格式

这是我的test.word

这是导出后的out.docx文件

2. 依靠

首先pom.xml导入依靠

1.                 <dependency>
2.                         <groupId>org.apache.poi</groupId>
3.                         <artifactId>poi</artifactId>
4.                         <version>5.2.2</version>
5.                 </dependency>
6.                 <dependency>
7.                         <groupId>org.apache.poi</groupId>
8.                         <artifactId>poi-ooxml</artifactId>
9.                         <version>5.2.2</version>
10.                 </dependency>
11.                 <dependency>
12.                         <groupId>com.deepoove</groupId>
13.                         <artifactId>poi-tl</artifactId>
14.                         <version>1.12.0</version>
15.                 </dependency>

复制代码

3. 实现代码

1. import com.deepoove.poi.XWPFTemplate;
2. import com.deepoove.poi.config.Configure;
3. import com.deepoove.poi.plugin.table.LoopRowTableRenderPolicy;
4. import java.io.*;
5. import java.util.ArrayList;
6. import java.util.HashMap;
7. import java.util.Map;
9. public class EditWordUtil {
10.     public static void main(String[] args) {
11.         String filePath = "D:/test.docx";
13.         try (FileInputStream resourceAsStream = new FileInputStream(new File(filePath));) {
14.             // 组装测试数据
15.             Map<String, Object> map = new HashMap<>();
16.             map.put("title", "日记");
17.             map.put("text", "好日子");
18.             map.put("score", 55);
19.             map.put("reward", "妈妈奖励我10块钱");
20.             map.put("imgUrl", "https://img2.baidu.com/it/u=485011689,3022056151&fm=253&fmt=auto&app=120&f=PNG?w=176&h=176");
22.             ArrayList<Map<String, Object>> list = new ArrayList<>();
24.             for (int i = 0; i < 4; i++) {
25.                 HashMap<String, Object> maps = new HashMap<>();
26.                 maps.put("name", "name" + i);
27.                 maps.put("age", "age" + i);
28.                 maps.put("address", "address" + i);
29.                 list.add(maps);
30.             }
31.             map.put("lists", list);
32.             // 嵌套map数据
33.             HashMap<Object, Object> table = new HashMap<>();
34.             table.put("listTitle", "这是表格标题!");
35.             map.put("table", table);
37.             // 调用生成 Word 文件方法，将结果保存到本地
38.             EditWordUtil.createWordOfList("D:/out.docx", resourceAsStream, map);
39.         } catch (IOException e) {
40.             e.printStackTrace();
41.         }
43.     }
45.     // 将生成的 Word 保存到本地文件系统
46.     public static boolean createWordOfList(String outputPath, InputStream templatePath, Map<String, Object> dates) throws IOException {
47.         try (FileOutputStream out = new FileOutputStream(outputPath);
48.              BufferedOutputStream bos = new BufferedOutputStream(out)) {
50.             // 使用Configure.ConfigureBuilder而不是Builder
51.             ConfigureBuilder builder = Configure.builder();
52.             LoopRowTableRenderPolicy loopRowTableRenderPolicy = new LoopRowTableRenderPolicy();
54.             // 动态绑定
55.             for (Map.Entry<String, Object> entry : dates.entrySet()) {
56.                 if (entry.getValue() instanceof ArrayList) {
57.                     builder.bind(entry.getKey(), loopRowTableRenderPolicy);
58.                 }
59.             }
61.             Configure configure = builder.build();
63.             // 读取模板并渲染数据
64.             XWPFTemplate template = XWPFTemplate.compile(templatePath, configure).render(dates);
65.             try {
66.                 template.write(bos);
67.                 template.close();
68.             } catch (Exception e) {
69.                 e.printStackTrace();
70.                 return false;
71.             }
73.             out.flush();
74.             bos.flush();
75.         }
76.         return true;
77.     }

复制代码

---

小结：

平凡对象字段使用 {{ }} 两个花括号包裹字段。
循环使用的是{{lists}}，循环的内容是用中括号 [ ] 包裹的字段。
注意：{{ }}和[ ] 包裹字段的时候不能有空格，否则word渲染不上。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。