poi-tl是什么
poi-tl是一个基于Apache POI的Word模板引擎，也是一个免费开源的Java类库，你可以非常方便的加入到你的项目中，并且拥有着让人喜悦的特性。
为什么选择poi-tl
| 方案 | 移植性 | 功能性 | 易用性 |
| Poi-tl | Java跨平台 | Word模板引擎，基于Apache POI，提供更友好的API | 低代码，准备文档模板和数据即可 |
| Apache POI | Java跨平台 | Apache项目，封装了常见的文档操作，也可以操作底层XML结构 | 文档不全，这里有一个教程：Apache POI Word快速入门 |
| Freemarker | XML跨平台 | 仅支持文本，很大的局限性 | 不推荐，XML结构的代码几乎无法维护 |
| OpenOffice | 部署OpenOffice，移植性较差 | - | 需要了解OpenOffice的API |
| HTML浏览器导出 | 依赖浏览器的实现，移植性较差 | HTML不能很好的兼容Word的格式，样式糟糕 | 需要了解OpenOffice的API |
| Jacob、winlib | Windows平台 | - | 复杂，完全不推荐使用 |
引入依赖
注意，poi-tl是基于poi的，如还引入poi需要注意版本
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>5.2.5</version>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>5.2.5</version>
</dependency>
<!--<!– Poi-tl Word 模板引擎–>-->
<dependency>
<groupId>com.deepoove</groupId>
<artifactId>poi-tl</artifactId>
<version>1.12.2</version>
</dependency>
下面介绍一下poi-tl的几种常见使用方法
1、文本
标签：{{text}}
数据模型：
String ：文本
TextRenderData ：有样式的文本
HyperlinkTextRenderData ：超链接和锚点文本
Object ：调用 toString() 方法转化为文本
word模板：
代码示例：
public static void main(String[] args) {
try {
/*文本*/
Map<String, Object> map = new HashMap<>();
map.put("name", "Sayi");
map.put("author", new TextRenderData("000000", "Sayi"));
map.put("link", new HyperlinkTextRenderData("website", "http://deepoove.com"));
map.put("anchor", new HyperlinkTextRenderData("anchortxt", "anchor:appendix1"));
XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\1.docx");
} catch (IOException e) {
e.printStackTrace();
}
}
}
效果：
2、图片
标签：{{@var}}
数据模型：
String ：图片url或者本地路径，默认使用图片自身尺寸
PictureRenderData
ByteArrayPictureRenderData
FilePictureRenderData
UrlPictureRenderData
word模板:
代码示例：
public static void main(String[] args) {
try {
Map<String, Object> map = new HashMap<>();
/*图片*/
map.put("image", "D:\\pic.jpg"); // 指定图片路径
map.put("svg", "https://profile-avatar.csdnimg.cn/840f4549a5ae4144b243b203900b98c5_qq_38860250.jpg"); // svg图片
map.put("image1", Pictures.ofLocal("D:\\pic.jpg").size(120, 120).create()); // 设置图片宽高
map.put("streamImg", Pictures.ofStream(new FileInputStream("D:\\pic.jpg"), PictureType.JPEG) // 图片流
.size(100, 120).create());
map.put("urlImg", Pictures.ofUrl("https://profile-avatar.csdnimg.cn/840f4549a5ae4144b243b203900b98c5_qq_38860250.jpg")
.size(100, 100).create()); // 网络图片(注意网络耗时对系统可能的性能影响)
XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\2.docx");
} catch (IOException e) {
e.printStackTrace();
}
}
效果：
3、表格
标签：{{#tableTest}}
数据模型：
- TableRenderData
推荐使用工厂 `Tables` 、 `Rows` 和 `Cells` 构建表格模型。
模板：
代码示例：
public static void main(String[] args) {
try {
Map<String, Object> map = new HashMap<>();
/*表格*/
RowRenderData row0 = Rows.of("姓名", "学历").textColor("FFFFFF")
.bgColor("4472C4").center().create();
RowRenderData row1 = Rows.create("李四", "博士");
map.put("tableTest", Tables.create(row0, row1));
XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\3.docx");
} catch (IOException e) {
e.printStackTrace();
}
}
效果：
4、列表
标签：{{*var}}
数据模型：
- List<String>
- NumberingRenderData
推荐使用工厂 `Numberings` 构建列表模型。
模板：
代码示例：
public static void main(String[] args) {
try {
Map<String, Object> map = new HashMap<>();
/*列表*/
map.put("listTest", Numberings.create("Plug-in grammar",
"Supports word text, pictures, table...",
"Not just templates"));
XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\4.docx");
} catch (IOException e) {
e.printStackTrace();
}
}
效果：
5、嵌套
标签：{{+nested}}
数据模型：
- DocxRenderData
推荐使用工厂 `Includes` 构建嵌套模型。
模板：
嵌套子模板：
代码示例：
/**
* @Title: PoiTlTest
* @Description:
* @author: leon
* @date: 2023/3/14 19:11
*/
public class PoiTlTest {
public static void main(String[] args) {
try {
Map<String, Object> map = new HashMap<>();
/*嵌套*/
List<AddrModel> subData = new ArrayList<>();
subData.add(new AddrModel("Guangdong,China"));
subData.add(new AddrModel("Shanghai,China"));
map.put("nested", Includes.ofLocal("D:\\subInTest.docx").setRenderModel(subData).create());
XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\5.docx");
} catch (IOException e) {
e.printStackTrace();
}
}
}
class AddrModel {
private String addr;
public AddrModel(String addr) {
this.addr = addr;
}
// Getter/Setter
}
效果：
6、条件判断显示
标签 :
{{?condition}} 需要显示的内容 {{/condition}}
模板：
总结
上面是poi-tl的一些简单用例，如对其他功能感兴趣的朋友，可以去poi-tl的官网学习，地址为：http://deepoove.com/poi-tl/