poi-tl模板引擎生成word统计图实践

2025-05-10

字数统计: 746字 | 阅读时长≈ 3分

前言

poi-tl 是一个基于 Apache POI 功能强大、易于使用且灵活的 Word 模板引擎，非常适合需要自动化生成 Word 文档的 Java 应用场景；笔者之前用过FreeMarker和Easy-poi模板引擎，前者基于xml语法的模板可读性和可维护性极差，后者模板语法功能不全且解析不稳定，两者都不支持统计图模板的生成，而poi-tl模板引擎很好的解决了两者的痛点，所以推荐大家使用poi-tl模板引擎。

实践

1.引入依赖

<dependency>
    <groupId>com.deepoove</groupId>
    <artifactId>poi-tl</artifactId>
    <version>1.12.2</version>
</dependency>

个人搭建的demo项目就直接引入了最新版本的poi-tl依赖，项目中要根据实际的poi版本引入对应的版本否则有不兼容的情况。

2.创建Word模板

用WPS新建一个空白文档，然后在文档中插入需要的图表，比如饼状图、柱状图等，选中插入的图，在右边属性->文本选项->可选文字->标题输入标签名称如表示插入饼状图的数据，表示插入柱状图的数据。
饼状图模板样例
柱状图模板样例

3.填充图数据代码

以下代码只列举了饼状图和柱状图的生成，其他的图表数据应该类似，可以参考官方文档进行查看。

/**
 * @author yinshuang
 * @date 2024/9/8 17:07
 * @description PoiWordTest
 * @copyright(c) chinacscs all rights reserved
 */
@Slf4j
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = PoiWordApplication.class)
public class PoiWordTest {


    @Test
    @DisplayName("测试word模板生成饼状图")
    public void testPieChartWordCreate() throws IOException {
        // 1.解析模板
        File templateFile = FileUtil.file("templates/pieChartTemplate.docx");
        XWPFTemplate template = XWPFTemplate.compile(templateFile);
        // 2.数据map
        Map<String, Object> dataMap = assemblePieChartData();
        // 3.渲染模板
        template.render(dataMap);
        // 4.输出文件
        String outputPath = FileUtil.getAbsolutePath("./../../wordTmp/");
        if (!FileUtil.exist(outputPath)) {
            FileUtil.mkdir(outputPath);
        }
        template.writeToFile(outputPath + "/pieChartTemplateOutput.docx");
        template.close();
    }

    @Test
    @DisplayName("测试word模板生成柱状图")
    public void testBarChartWordCreate() throws IOException {
        // 1.解析模板
        File templateFile = FileUtil.file("templates/barChartTemplate.docx");
        XWPFTemplate template = XWPFTemplate.compile(templateFile);
        // 2.数据map
        Map<String, Object> dataMap = assembleBarChartData();
        // 3.渲染模板
        template.render(dataMap);
        // 4.输出文件
        String outputPath = FileUtil.getAbsolutePath("./../../wordTmp/");
        if (!FileUtil.exist(outputPath)) {
            FileUtil.mkdir(outputPath);
        }
        template.writeToFile(outputPath + "/barChartTemplateOutput.docx");
        template.close();
    }



    private Map<String, Object> assemblePieChartData() {
        Map<String, Object> dataMap = new HashMap<>(16);
        ChartSingleSeriesRenderData pieChartData = Charts
                .ofSingleSeries("男女比例", new String[] { "男", "女" })
                .series("人数", new Integer[] { 9826675, 9596961 })
                .create();
        dataMap.put("pieChart", pieChartData);
        return dataMap;
    }

    private Map<String, Object> assembleBarChartData() {
        Map<String, Object> dataMap = new HashMap<>(16);
        ChartMultiSeriesRenderData barChartData = Charts
                .ofMultiSeries("商品销售量", new String[]{"家居","厨房用品","文具"})
                .addSeries("商品数量", new Integer[]{66,13,21})
                .create();
        dataMap.put("barChart", barChartData);
        return dataMap;
    }
}

4.运行测试

如下执行测试类
执行代码
打开生产的word文件，可以看到已经生成了饼状图和柱状图。

本文作者： yinshuang
本文链接： https://yinshuang007.github.io/2025/05/10/poi-tl模板引擎生成word统计图实践/
版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！