使用poi-tl动态生成Word文档中的表格与动态列数据

poi-tl动态生成Word文档中的表格与动态列数据

引言

poi-tl是一个基于Apache POI的模板引擎，它极大地简化了Word文档的自动化生成过程，特别是在需要动态插入表格和列数据时。本文将详细介绍如何使用poi-tl来动态生成包含复杂表格结构的Word文档，强调其在处理复杂文档结构和提高文档生成效率方面的优势。

准备工作

引入poi-tl库：
通过Maven引入poi-tl及其依赖库。建议使用最新版本以确保最佳兼容性和功能支持。https://deepoove.com/poi-tl/)

<dependency>  
    <groupId>com.deepoove</groupId>  
    <artifactId>poi-tl</artifactId>  
    <version>最新版本号</version> <!-- 请替换为实际最新版本号 -->  
</dependency>

模板设计

1. 定义模板：准备一个Word文档模板，其中包含用于插入表格的占位符。例如，使用{{?questions}}和{{/questions}}来定义循环区域，用于动态插入多个表格或表格行。

2. 占位符：在模板中，使用{{}}双花括号来定义数据占位符。对于表格，可以使用{{xxx}}等占位符来指示动态数据的插入位置。

3. 表格占位符：对于动态表格，可以在模板中预留一个表格框架，并通过poi-tl的特定语法（如{{dataList}}）来指定哪些数据将填充到这个表格中。动态列数据可以通过在表格单元格中使用[]方括号占位符来指定。
   

4. 编程实现

   1. 加载模板：使用poi-tl的API加载准备好的Word模板文件。
   2. 准备数据：根据业务需求准备表格数据和列数据。这些数据可以来自数据库、文件或用户输入。
   3. 配置渲染策略：对于需要动态列的情况，使用LoopColumnTableRenderPolicy等策略来配置模板的渲染行为。
   4. 数据填充与渲染：将准备好的数据填充到模板的占位符中，并渲染生成最终的Word文档。
   5. poi方法使用：LoopColumnTableRenderPolicy 是一个列循环的插件。 详细参考上述官网介绍

LoopColumnTableRenderPolicy policy = new LoopColumnTableRenderPolicy();

Configure config = Configure.builder().bind("goods", policy).build();

XWPFTemplate template = XWPFTemplate.compile(resource, config).render(
  new HashMap<String, Object>() {{
      put("goods", goods);
    }}
);

// 示例数据
List<QuestionnaireOptionStatisticsSubject> subjectList = createSampleData();

// 问卷样本统计与分析说明
List<Map<String, Object>> typeList = new ArrayList<>();
List<QuestionnaireOptionStatisticsSubject> subjectList = responseQuestionnaire.getQuestionnaireOptionStatisticsSubjectList();
for (QuestionnaireOptionStatisticsSubject questionnaireOptionStatisticsSubject : subjectList) {
    Map<String, Object> detailMap = new HashMap<>();
    detailMap.put("title", questionnaireOptionStatisticsSubject.getLabel());
    typeList.add(detailMap);
}

// 组装表格列表数据
List<List<Quest>> detailList = new ArrayList<>();
for (QuestionnaireOptionStatisticsSubject subject : subjectList) {
    List<Quest> quests = new ArrayList<>();
    for (Map.Entry<String, QuestionnaireOptionStatisticsChoice> entry : subject.getQuestionnaireOptionStatisticsChoiceMap().entrySet()) {
        Quest quest = new Quest();
        String option = entry.getKey();
        QuestionnaireOptionStatisticsChoice choice = entry.getValue();
        quest.setOption(option + "." + choice.getLabel());
        quest.setNum(choice.getCount());
        quest.setRate(choice.getRate());
        quests.add(quest);
    }
    detailList.add(quests);
}

// 组装整体数据
List<Map<String, Object>> tList = new ArrayList<>();
for (int i = 0; i < subjectList.size(); i++) {
    QuestionnaireOptionStatisticsSubject subject = subjectList.get(i);
    Map<String, Object> tMap = new HashMap<>();
    int index = i + 1;
    String indexString = index + "-" + index;
    tMap.put("index1", "(" + convertToChineseNumeral(index) + ")");
    tMap.put("index", indexString);
    tMap.put("title", subject.getLabel());
    tMap.put("detailList", detailList.get(i));
    tMap.put("summary", "根据表" + indexString + subject.getQuestSummary());
    tList.add(tMap);
}

// 渲染表格 动态行
LoopColumnTableRenderPolicy policy = new LoopColumnTableRenderPolicy();
Configure config = Configure.newBuilder()
    .bind("typeList", policy)
    .bind("detailList", policy)
    .build();

 params.put("typeList", typeList);
 params.put("questions", tList);

try {
    File templateFile = new ClassPathResource("static/template/报告模板.docx").getFile();
    XWPFTemplate template = XWPFTemplate.compile(templateFile, config).render(params);
    try (FileOutputStream out = new FileOutputStream("文件输出.docx")) {
        template.write(out);
    }
    template.close();
    System.out.println("完成");
} catch (IOException e) {
    e.printStackTrace(); // 更具体的异常处理逻辑
}

• 注意事项

  • 版本兼容性：确保poi-tl与Apache POI的版本兼容，并考虑与项目中其他依赖的兼容性。
  • 模板设计：在Word模板中设计表格时，注意表格的行列数应与预期动态数据相匹配，避免渲染时出现格式错误。
  • 性能优化：当处理大量数据时，考虑使用分批处理或缓存策略来优化性能。
  • 错误处理：在代码中加入适当的错误处理逻辑，以便在模板加载、数据填充或文档渲染过程中出现问题时能够及时处理。

  结论

  通过poi-tl，我们可以轻松实现Word文档的自动化生成，特别是当文档中包含复杂的表格和动态列数据时。掌握poi-tl的使用，将大大提高文档处理的效率和准确性。

填充或文档渲染过程中出现问题时能够及时处理。

结论

通过poi-tl，我们可以轻松实现Word文档的自动化生成，特别是当文档中包含复杂的表格和动态列数据时。掌握poi-tl的使用，将大大提高文档处理的效率和准确性。