Word模板引擎poi-tl（poi template language）使用入门指南

什么是poi-tl

poi-tl（poi template language）是Word模板引擎，使用模板和数据创建很棒的Word文档

poi-tl是一个基于Apache POI的Word模板引擎，也是一个免费开源的Java类库，可以非常方便的集成到项目中，并使用它已经封装好的功能。

为什么选择poi-tl?

具备的功能

如何集成

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

代码示例

源码参见 JUnit XWPFTemplateTest
Word模板参见：template.docx

package com.baomidou.mybatisplus.samples.wrapper;

import java.util.HashMap;
import java.util.Map;

import org.junit.jupiter.api.Test;

import com.deepoove.poi.XWPFTemplate;
import com.deepoove.poi.data.Charts;
import com.deepoove.poi.data.Numberings;
import com.deepoove.poi.data.Pictures;
import com.deepoove.poi.data.RowRenderData;
import com.deepoove.poi.data.Rows;
import com.deepoove.poi.data.TableRenderData;
import com.deepoove.poi.data.Tables;
import com.deepoove.poi.data.Texts;

/**
 * @author Sayi
 */
public class XWPFTemplateTest {

    @Test
    public void testRenderTemplate() throws Exception {
        Map<String, Object> datas = new HashMap<String, Object>();

        // create table
        RowRenderData header = Rows.of("Word处理方案", "是否跨平台", "易用性")
            .textColor("FFFFFF")
            .bgColor("ff9800")
            .center()
            .rowHeight(2.5f)
            .create();
        RowRenderData row0 = Rows.create("Poi-tl", "纯Java组件，跨平台", "简单：模板引擎功能，并对POI进行了一些封装");
        RowRenderData row1 = Rows.create("Apache Poi", "纯Java组件，跨平台", "简单，缺少一些功能的封装");
        RowRenderData row2 = Rows.create("Freemarker", "XML操作，跨平台", "复杂，需要理解XML结构");
        RowRenderData row3 = Rows.create("OpenOffice", "需要安装OpenOffice软件", "复杂，需要了解OpenOffice的API");
        TableRenderData table = Tables.create(header, row0, row1, row2, row3);

        // text
        datas.put("header", "定义文档的header");
        datas.put("name", "poi-tl使用示例");
        datas.put("word", "word模板引擎");
        datas.put("time", "2024-10-16");
        datas.put("what", "Java Word模板引擎： Minimal Microsoft word(docx) templating with {{template}} in Java.");
        datas.put("author", Texts.of("cloudcoder").color("000000").create());

        // hyperlink
        datas.put("introduce", Texts.of("Word模板引擎poi-tl（poi template language）使用指南").link("https://cloudcoder.blog.csdn.net/article/details/142970288").create());
        // picture
        datas.put("portrait", Pictures.ofLocal("src/test/resources/sayi.png").size(60, 60).create());
        // table
        datas.put("solution_compare", table);
        // numbering
        datas.put("feature",
            Numberings.create("Plug-in grammar, add new grammar by yourself",
                "Supports word text, local pictures, web pictures, table, list, header, footer...",
                "Templates, not just templates, but also style templates"));

        // chart
        datas.put("chart",
            Charts.ofMultiSeries("易用性", new String[] {"代码量", "维护量"})
                .addSeries("poi-tl", new Double[] {10.0, 5.0})
                .addSeries("freemark", new Double[] {90.0, 70.0})
                .create());

        XWPFTemplate.compile("src/test/resources/template.docx")
            .render(datas)
            .writeToFile("target/out_template.docx");
    }

}

参考资料

• poi-tl document
• GitHub 源码