poi-tl—一个超级好用开源的Word模板引擎

简介: poi-tl—一个超级好用开源的Word模板引擎

1、poi-tl是什么

poi-tl是一个基于Apache POI的Word模板引擎,同时它也是一个免费开源(github地址)的Java类库,给Java程序员带来了word处理上的便捷。



2、官方介绍

在文档的任何地方做任何事情(Do Anything Anywhere)是poi-tl的星辰大海。


2.1 poi-tl与其他word模板引擎的对比

image.pngimage.png2.2.1 Template—模板

模板即Docx格式的Word文档


2.2.2 Data-model—数据

数据即模板中需要替换的数据结构,类似哈希或者字典,常用Map结构,其中key即需要替换的标签


2.2.3 Output—输出

输出即最终文档的流产生,可以是文件流或网络流等



3、软件要求

Apache POI 4.1.2

jdk 1.8+

maven依赖

image.png

4、标签

4.1 文本

标签

{{var}}

数据模型

  1. String:文本
  2. TextRenderData:有样式的文本
  3. HyperlinkTextRenderData :超链接和锚点文本
  4. Object:调用 toString() 方法转化为文本

测试模板

image.pngimage.pngimage.png4.2 图片

标签

{{@var}}

数据模型

  1. String:图片url或者本地路径。默认使用图片自身尺寸
  2. PictureRenderData

测试模板

image.png

测试代码

package com.lizba.poi;
import com.deepoove.poi.XWPFTemplate;
import com.deepoove.poi.data.PictureType;
import com.deepoove.poi.data.Pictures;
import com.deepoove.poi.data.Texts;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.HashMap;
/**
 * <p>
 *    图片测试
 * </p>
 *
 * @Author: Liziba
 * @Date: 2021/6/24 21:49
 */
public class PictureTest {
    public static void main(String[] args) throws IOException {
        String filePath = "D:\\poi-tl\\pictureTest.docx";
        String targetPath =  "D:\\poi-tl\\pictureTest2.docx";
        String picPath =  "D:\\poi-tl\\pic.jpg";
        XWPFTemplate template = XWPFTemplate.compile(filePath).render(
                new HashMap<String, Object>() {
                    {
                        // 方法一、图片路径(原大小)
                        put("picture", picPath);
                        // 方法二、指定图片大小
                        put("picture", Pictures.ofLocal(picPath).size(420,350).center().create());
                        // 方法三、图片流
                        put("picture", Pictures.ofStream(new FileInputStream(picPath), PictureType.JPEG)
                                .size(420,350).create());
                        // 针对网络图片、SVG图片、Java图片都有处理
                    }
                });
        template.writeAndClose(new FileOutputStream(targetPath));
    }
}

image.png4.3 表格

标签

{{#var}}

数据模型

  1. TableRenderData

测试模板image.png

package com.lizba.poi;
import com.deepoove.poi.XWPFTemplate;
import com.deepoove.poi.data.*;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.HashMap;
/**
 * <p>
 *    列表测试
 * </p>
 *
 * @Author: Liziba
 * @Date: 2021/6/24 21:49
 */
public class TableTest {
    public static void main(String[] args) throws IOException {
        String filePath = "D:\\poi-tl\\tableTest.docx";
        String targetPath =  "D:\\poi-tl\\tableTest2.docx";
        // 表头
        RowRenderData tableHead = Rows.of("姓名", "性别", "地址", "微信公众号").center().bgColor("4472c4").create();
        // 第一行
        RowRenderData row1 = Rows.create("张三", "男", "广东深圳", "liziba_98");
        // 第二行
        RowRenderData row2 = Rows.create("李四", "男", "广东深圳", "liziba_98");
        // 合并第一行和第二行的第二列与第三列
        MergeCellRule rule = MergeCellRule.builder().map(MergeCellRule.Grid.of(1, 1), MergeCellRule.Grid.of(2, 1))
                .map(MergeCellRule.Grid.of(1, 2), MergeCellRule.Grid.of(2, 2)).build();
        XWPFTemplate template = XWPFTemplate.compile(filePath).render(
            new HashMap<String, Object>() {
                {
                    put("table", Tables.of(tableHead, row1, row2).mergeRule(rule).center().create());
                }
            });
        template.writeAndClose(new FileOutputStream(targetPath));
    }
}

image.png

目录
相关文章
|
消息中间件 Java 调度
自顶向下学习 RocketMQ(六):定时消息
定时消息会暂存在名为 SCHEDULE_TOPIC_XXXX 的 topic 中,并根据 delayTimeLevel 存入特定的 queue,queueId = delayTimeLevel – 1,即一个 queue 只存相同延迟的消息,保证具有相同发送延迟的消息能够顺序消费。broker 会调度地消费 SCHEDULE_TOPIC_XXXX,将消息写入真实的 topic。
自顶向下学习 RocketMQ(六):定时消息
Springboot 导出word,动态填充表格数据
Springboot 导出word,动态填充表格数据
|
前端开发 Java 数据库连接
Spring Boot 3 整合 Mybatis-Plus 动态数据源实现多数据源切换
Spring Boot 3 整合 Mybatis-Plus 动态数据源实现多数据源切换
|
Java Apache Maven
Java中使用poi+poi-tl实现根据模板导出word文档
这个过程不仅简化了文档生成的工作,而且保证了生成文档的一致性与准确性,特别适合于那些需要生成大量文档的自动化场景。通过以上步骤,Java开发人员可以实现高效、可靠的Word文档导出功能。
3017 0
|
Java BI API
SpringBoot + POI-TL:高效生成Word报表的技术盛宴
【8月更文挑战第22天】在日常的工作与学习中,文档处理特别是Word报表的自动生成,是许多项目中不可或缺的一环。传统的手工编辑Word文档不仅效率低下,还容易出错,特别是在需要批量生成包含动态数据的报告时,更是令人头疼不已。幸运的是,结合Spring Boot的简洁高效与POI-TL的强大功能,我们能够轻松实现Word报表的快速生成,既提升了工作效率,又保证了数据的准确性和报表的美观性。
1272 0
|
Java Apache
Java 使用word模板创建word文档报告教程
Java 使用word模板创建word文档报告教程
848 0
Java 使用word模板创建word文档报告教程
|
12月前
|
Oracle 关系型数据库 Windows
如何彻底卸载 IDEA,将IDEA完全删除
本文提供了一个详细的教程,指导用户如何彻底卸载 IntelliJ IDEA,包括使用Uninstall.exe程序和通过注册表删除残留项的步骤。
6738 3
如何彻底卸载 IDEA,将IDEA完全删除
|
Java Apache
超实用!教你如何在POI-TL框架中熟练使用Configure类,快速完成Office文档生成!
POI-TL是一个用于生成Office文档的Java库,Configure类是该库中的一个配置类,其作用是提供了一些全局的配置选项,可以用于定制化生成的文档。
768 0
|
数据库 对象存储
状态机的原理简析及重要用途
状态机的原理简析及重要用途
304 1