1、poi-tl是什么
poi-tl是一个基于Apache POI的Word模板引擎,同时它也是一个免费开源(github地址)的Java类库,给Java程序员带来了word处理上的便捷。
2、官方介绍
在文档的任何地方做任何事情(Do Anything Anywhere)是poi-tl的星辰大海。
2.1 poi-tl与其他word模板引擎的对比
2.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依赖
4、标签
4.1 文本
标签
{{var}}
数据模型
- String:文本
- TextRenderData:有样式的文本
- HyperlinkTextRenderData :超链接和锚点文本
- Object:调用 toString() 方法转化为文本
测试模板
4.2 图片
标签
{{@var}}
数据模型
- String:图片url或者本地路径。默认使用图片自身尺寸
- PictureRenderData
测试模板
测试代码
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)); } }
4.3 表格
标签
{{#var}}
数据模型
- TableRenderData
测试模板
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)); } }