SpringBoot調用Poi-tl實現(xiàn)渲染數據并生成Word文檔
前言
產品經理急沖沖地走了過來。「現(xiàn)在需要將按這些數據生成一個 Word 報告文檔，你來安排下」
項目中有這么一個需求，需要將用戶填寫的數據填充到一個 Word 文檔中，而這個 Word 文檔是人家給定了的。換句話說，讓你按照這個文檔的內容格式生成新的文檔。
什么是 Poi-tl
官網：http://deepoove.com/poi-tl/1.9.x/
poi-tl（poi template language）是一種 Word 模板引擎，可以基于 Word 模板和數據生成新的文檔，它的底層是通過 Apache POI 來實現(xiàn)的。
Apache POI 不僅封裝了易用的文檔 API （文本、圖片、表格、頁眉、頁腳、圖表等），也可以在底層直接操作文檔XML結構。
poi-tl 擁有如下特性（了解瞄一眼就行）：
| 內容 | 描述 |
|---|---|
| 文本 | 將標簽渲染為文本 |
| 圖片 | 將標簽渲染為圖片 |
| 表格 | 將標簽渲染為表格 |
| 列表 | 將標簽渲染為列表 |
| 圖表 | 條形圖（3D條形圖）、柱形圖（3D柱形圖）、面積圖（3D面積圖）、折線圖（3D折線圖）、雷達圖、餅圖（3D餅圖）等圖表渲染 |
| If Condition判斷 | 隱藏或者顯示某些文檔內容（包括文本、段落、圖片、表格、列表、圖表等） |
| Foreach Loop循環(huán) | 循環(huán)某些文檔內容（包括文本、段落、圖片、表格、列表、圖表等） |
| Loop表格行 | 循環(huán)渲染表格的某一行 |
| Loop表格列 | 循環(huán)渲染表格的某一列 |
| Loop有序列表 | 支持有序列表的循環(huán)，同時支持多級列表 |
| 圖片替換 | 將原有圖片替換成另一張圖片 |
| 書簽、錨點、超鏈接 | 支持設置書簽，文檔內錨點和超鏈接功能 |
| 強大的表達式 | 完全支持SpringEL表達式，可以擴展更多的表達式：OGNL, MVEL… |
| 標簽定制 | 支持自定義標簽前后綴 |
| 文本框 | 文本框內標簽支持 |
| 樣式 | 模板即樣式，同時代碼也可以設置樣式 |
| 模板嵌套 | 模板包含子模板，子模板再包含子模板 |
| 合并 | Word合并Merge，也可以在指定位置進行合并 |
| 用戶自定義函數(插件) | 在文檔任何位置執(zhí)行函數 |
我們就可以使用這個它來實現(xiàn)這個需求。
如何使用 Poi-tl
本篇文章將以 Spring Boot 項目作為演示，屏幕前的朋友們可以一起跟著我的步驟來，實踐一番！
1.首先創(chuàng)建一個 Spring Boot 項目，版本目前我的 Demo 是 2.2.1，你可以更改你的 Spring Boot 版本，那現(xiàn)在我這里已經創(chuàng)建好了。
其中， pom.xml 只有兩個依賴項，一個 web 和一個 test ：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Spring Boot Test 依賴 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>2.接著在 pom.xml 中引入 Poi-tl 的依賴項：
<!-- Poi-tl Word 模板引擎-->
<dependency>
<groupId>com.deepoove</groupId>
<artifactId>poi-tl</artifactId>
<version>1.9.1</version>
</dependency>3.準備一個 Word 模板
這一步你可以自己動手做一個 Word 模板，這里我先演示下。就先創(chuàng)建一個名為 Hello World.docx 的 Word 文檔，模板內容如下：
找一個你喜歡的位置存放這個模板，我現(xiàn)在把它放到項目的 resource 目錄。
{{title}} 這種由兩個大括號包住的，目前可以看成占位符，這個模板中有 4 個占位符，后續(xù)的數據就渲染到這些地方上。
4.獲取模板所在的路徑，并將數據渲染到模板上
渲染只需一行代碼，就是使用 XWPFTemplate 的 API 就可以了，通過 complie 和 render 方法，就可以將數據渲染到模板中，得到渲染好的新文檔。
@SpringBootTest
public class PoiTlApplicationTest {
@Test
public void test() {
// 獲取 Word 模板所在路徑
String filepath = this.getClass().getClassLoader().getResource("hello-world.docx").getPath();
// 通過 XWPFTemplate 編譯文件并渲染數據到模板中
XWPFTemplate template = XWPFTemplate.compile(filepath).render(
new HashMap<String, Object>(){{
put("title", "Hello, poi-tl Word模板引擎");
put("text", "Hello World");
put("author", "god23bin");
put("description", "這還不關注 god23bin ？再不關注我可要求你關注了！");
}});
try {
// 將完成數據渲染的文檔寫出
template.writeAndClose(new FileOutputStream("output.docx"));
} catch (IOException e) {
e.printStackTrace();
}
}
}執(zhí)行這個單元測試，就可以看到在項目所在目錄下輸出了新的文檔 output.docx，打開這個文檔，我們就可以看到如下圖所示的內容：
大功告成，這就是渲染好的新文檔了，是不是很簡單，一行代碼就完成了根據模板進行數據的渲染！
相關概念
模板
模板是 Docx 格式的 Word 文檔，我們可以使用 Microsoft office、WPS Office 等軟件來制作模板。
標簽
上面說到 {{title}} 這種理解成占位符，實際上，官方是稱之為「標簽」。
所有的標簽都是以 {{ 開頭，以 }} 結尾，標簽可以出現(xiàn)在任何位置，包括頁眉，頁腳，表格內部，文本框等。
表格布局可以設計出很多優(yōu)秀專業(yè)的文檔，推薦使用表格布局。
poi-tl 模板遵循 所見即所得 的設計，模板和標簽的樣式會被完全保留，就如我上面演示的，一級標題和字體顏色的樣式就被保留下來了。
數據模型
數據模型，也就是我們需要渲染到模板中的數據，可以是哈希表，也可以是普通的 Java 對象。
哈希表（key 名是標簽名）：
Map<String, Object> data = new HashMap<>();
data.put("title", "Hello, poi-tl Word模板引擎");
data.put("text", "Hello World");
data.put("author", "god23bin");
data.put("description", "這還不關注 god23bin ？再不關注我可要求你關注了！");Java 對象（屬性名是標簽名）：
public class DataModel {
private String title;
private String text;
private String author;
private String description;
// 省略 getter 和 setter
}
DataModel data = new DataModel();
data.setTitle("Hello, poi-tl Word模板引擎");
data.setText("Hello World");
data.setAuthor("god23bin");
data.setDescription("這還不關注 god23bin ？再不關注我可要求你關注了！");有了哈希表和或者 Java 對象的數據模型后，將這個數據丟給渲染的 API，就可以完成數據的渲染了。
標簽的寫法
poi-tl 里只有標簽，那么我們需要知道標簽的寫法是怎樣的。在 Word 文檔里，可以有：文本、圖片、表格、列表等元素，那么對應的，咱們的標簽也有這些。
文本標簽 {{var}}
簡單粗暴，直接 {{標簽名}} 就是文本標簽了。
圖片標簽 {{@var}}
{{@標簽名}} 就是圖片標簽，@ 標識了這個標簽的類型是圖片，其他的也是同理，不同的符號標識不同類型的標簽。
表格標簽 {{#var}}
使用 # 標識這是一個表格標簽。
列表標簽 {{*var}}
使用 * 標識這是一個列表標簽。
其余的標簽
剩下的標簽還有很多，詳細的內容你可以閱讀官方文檔，這里就不一一介紹了。
下面我將寫下我用過的內容。
插件
插件，又稱為自定義函數，它允許我們在模板標簽位置處執(zhí)行預先定義好的函數。由于插件機制的存在，我們幾乎可以在模板的任何位置執(zhí)行任意操作。
插件是 poi-tl 的核心，默認的標簽和引用標簽都是通過插件加載。
默認插件
poi-tl 默認提供了八個策略插件，用來處理文本、圖片、列表、表格、文檔嵌套、引用圖片、引用多系列圖表、引用單系列圖表等：
- TextRenderPolicy
- PictureRenderPolicy
- NumberingRenderPolicy
- TableRenderPolicy
- DocxRenderPolicy
- MultiSeriesChartTemplateRenderPolicy
- SingleSeriesChartTemplateRenderPolicy
- DefaultPictureTemplateRenderPolicy
由于這 8 個插件是經常用到的，所以這些插件被注冊為不同的標簽類型，也就是我們看到過的 {{var}}、{{@var}}、{{#var}} 等不同類型的標簽，從而搭建了 poi-tl 的標簽體系。
除了這 8 個通用的策略插件外，還內置了一些額外用途的插件：
| DynamicTableRenderPolicy | 動態(tài)表格插件，允許直接操作表格對象 | 示例-動態(tài)表格 |
|---|---|---|
| HackLoopTableRenderPolicy | 循環(huán)表格行，下文會詳細介紹 | 示例-表格行循環(huán) |
| LoopColumnTableRenderPolicy | 循環(huán)表格列 | 示例-表格列循環(huán) |
| BookmarkRenderPolicy | 書簽和錨點 | 示例-Swagger文檔 |
| JSONRenderPolicy | 高亮顯示JSON代碼塊 | 示例-Swagger文檔 |
| AbstractChartTemplateRenderPolicy | 引用圖表插件，允許直接操作圖表對象 | |
| ParagraphRenderPolicy | 渲染一個段落，可以包含不同樣式文本，圖片等 | |
| DocumentRenderPolicy | 渲染多個段落和表格 | |
| TOCRenderPolicy | Beta實驗功能：目錄，打開文檔時需要更新域 |
使用插件
為了讓插件在某個標簽處執(zhí)行，我們需要將插件與標簽綁定。
當我們有個模板標簽為 {{description}}，默認是文本標簽，如果希望在這個位置做些不一樣或者更復雜的事情，我們可以將插件應用到這個模板標簽，比如渲染 HTML：
ConfigureBuilder builder = Configure.builder();
builder.bind("description", new HtmlRenderPolicy());此時，{{description}} 將不再是一個文本標簽，而是一個自定義的支持 HTML 渲染的標簽。
當然，這里的 HTML 渲染的插件，默認是沒有提供的，需要引入以下的依賴項，才能支持 HTML 的渲染。
<!-- 支持渲染 HTML 的插件 -->
<dependency>
<groupId>io.github.draco1023</groupId>
<artifactId>poi-tl-ext</artifactId>
<version>0.3.3</version>
</dependency>示例：我們對 {{author}} 這個標簽綁定上支持 HTML 渲染的插件，這樣就能渲染 HTML 的文本了。
@SpringBootTest
public class PoiTlApplicationTest {
@Test
public void test() {
// 獲取 Word 模板所在路徑
String filepath = this.getClass().getClassLoader().getResource("hello-world.docx").getPath();
// 給標簽綁定插件
Configure configure = Configure.builder().bind("author", new HtmlRenderPolicy()).build();
// 通過 XWPFTemplate 編譯文件并渲染數據到模板中
XWPFTemplate template = XWPFTemplate.compile(filepath, configure).render(
new HashMap<String, Object>(){{
put("title", "Hello, poi-tl Word模板引擎");
put("text", "Hello World");
put("author", "<h2>god23bin</h2>");
put("description", "這還不關注 god23bin ？再不關注我可要求你關注了！");
}});
try {
// 將完成數據渲染的文檔寫出
template.writeAndClose(new FileOutputStream("output.docx"));
} catch (IOException e) {
e.printStackTrace();
}
}
}生成的 Word 文檔如下圖所示，可以看到 {{author}} 這個標簽的 HTML 文本已經渲染成功了?。ㄋ{框框）
表格行循環(huán)
當有類似如下需求的時候，在表格里展示多行同類型的數據，那么就需要用到表格的行循環(huán)了。
這里也是涉及到插件的，具體就是使用 HackLoopTableRenderPolicy 這個插件策略，這個策略能夠根據集合數據進行循環(huán)渲染，這樣就渲染數據到表格的行上了，集合有多少個元素，那么就有多少行。
我們來看下這個表格行循環(huán)的模板是怎樣寫的，是這樣的：
可以看到 {{articles}} 和 {{columns}} 是標準的文本標簽，我們這里將這兩個標簽置于循環(huán)行的上一行，循環(huán)行里設置要循環(huán)的標簽和內容，注意這里的標簽是使用 [] 的，以此來區(qū)分標準的標簽語法。
同時 {{articles}} 和 {{columns}} 標簽對應的數據就是文章和專欄的集合。
我們寫一個該模板的數據模型，以 Java 對象來寫，同時模擬數據從數據庫中讀取。
數據模型：AcWordModel
public class AcWordModel {
/**
* 文章明細數據模型-表格行循環(huán)
*/
private List<Article> articles;
/**
* 專欄明細數據模型
*/
private List<SpecialColumn> columns;
// 省略 getter 和 setter
}其中的 Article 和 SpecialColumn 模型如下：
public class Article {
private String title;
private String tags;
private Integer reading;
private Integer likes;
// 省略 getter 和 setter
}public class SpecialColumn {
private String name;
private Integer subscription;
private Integer nums;
// 省略 getter 和 setter
}進行測試，獲取數據和模板，讓標簽和表格行循環(huán)的插件進行綁定
@Test
public void rowLoopTest() {
// 獲取數據，這里假裝是從數據庫中查詢得到的
AcWordModel data = getFromDB();
// 獲取 Word 模板所在路徑
String filepath = this.getClass().getClassLoader().getResource("table-row-loop.docx").getPath();
// 給標簽綁定插件，這里就綁定表格行循環(huán)的插件
Configure configure = Configure.builder()
.bind("articles", new HackLoopTableRenderPolicy())
.bind("columns", new HackLoopTableRenderPolicy())
.build();
// 通過 XWPFTemplate 編譯文件并渲染數據到模板中
XWPFTemplate template = XWPFTemplate.compile(filepath, configure).render(data);
try {
// 將完成數據渲染的文檔寫出
template.writeAndClose(new FileOutputStream("ac-word.docx"));
} catch (IOException e) {
e.printStackTrace();
}
}這樣，就能實現(xiàn)表格的行循環(huán)了！
封裝 Word 渲染生成新文檔的工具
我們可以再封裝下這個 API，寫一個工具類，如下：
package cn.god23bin.demo.util;
import com.deepoove.poi.XWPFTemplate;
import com.deepoove.poi.config.Configure;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Map;
public class WordUtil {
/**
* 生成 word 文檔
* @param wordTemplatePath word 模板路徑
* @param targetWordFilePath 生成目標文檔路徑
* @param data 待渲染的數據模型-哈希表形式
*/
public static void generateWordFile(String wordTemplatePath, String targetWordFilePath, Map<String, Object> data) {
XWPFTemplate template = XWPFTemplate.compile(wordTemplatePath).render(data);
try {
template.writeAndClose(new FileOutputStream(targetWordFilePath));
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 生成 word 文檔
* @param wordTemplatePath word 模板路徑
* @param targetWordFilePath 生成目標文檔路徑
* @param data 待渲染的數據模型-Java對象形式
*/
public static void generateWordFile(String wordTemplatePath, String targetWordFilePath, Object data) {
XWPFTemplate template = XWPFTemplate.compile(wordTemplatePath).render(data);
try {
template.writeAndClose(new FileOutputStream(targetWordFilePath));
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 生成 word 文檔
* @param wordTemplatePath word 模板路徑
* @param targetWordFilePath 生成目標文檔路徑
* @param data 待渲染的數據模型-哈希表形式
* @param configure 渲染配置
*/
public static void generateWordFile(String wordTemplatePath, String targetWordFilePath, Map<String, Object> data, Configure configure) {
XWPFTemplate template = XWPFTemplate.compile(wordTemplatePath, configure).render(data);
try {
template.writeAndClose(new FileOutputStream(targetWordFilePath));
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 生成 word 文檔
* @param wordTemplatePath word 模板路徑
* @param targetWordFilePath 生成目標文檔路徑
* @param data 待渲染的數據模型-Java對象形式
* @param configure 渲染配置
*/
public static void generateWordFile(String wordTemplatePath, String targetWordFilePath, Object data, Configure configure) {
XWPFTemplate template = XWPFTemplate.compile(wordTemplatePath, configure).render(data);
try {
template.writeAndClose(new FileOutputStream(targetWordFilePath));
} catch (IOException e) {
e.printStackTrace();
}
}
}以上就是SpringBoot調用Poi-tl實現(xiàn)渲染數據并生成Word文檔的詳細內容，更多關于SpringBoot生成Word文檔的資料請關注腳本之家其它相關文章！
相關文章
java application maven項目打自定義zip包實例(推薦)
下面小編就為大家?guī)硪黄猨ava application maven項目打自定義zip包實例(推薦)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-05-05
Spring中AOP概念與兩種動態(tài)代理模式原理詳解
AOP是面向切面編程的技術,AOP基于IoC基礎,是對OOP的有益補充,流行的AOP框架有Sping AOP、AspectJ,這篇文章主要給大家介紹了關于Spring中AOP概念與兩種動態(tài)代理模式原理的相關資料,需要的朋友可以參考下2021-10-10
這篇文章主要介紹了JAVA SE包裝類和泛型的相關資料,包括基本數據類型與包裝類的對應關系,以及裝箱和拆箱的概念,并重點講解了自動裝箱和自動拆箱的機制,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2025-03-03
SpringBoot+Redis+Lua分布式限流的實現(xiàn)
本文主要介紹了SpringBoot+Redis+Lua分布式限流的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-08-08
這篇文章主要給大家介紹了關于Java中Date時間類的使用方法,在java開發(fā)中，很多字段是Date類型的,文中通過代碼示例將Date時間類使用的方法介紹的非常詳細,需要的朋友可以參考下2023-08-08
這篇文章主要介紹了Java編程基礎元素-運算符，運算符就是在用變量或常量進行運算時，經常需要用到的運算符，Java?提供了豐富的運算符，可分為算術運算符、關系運算符、邏輯運算符和位運算符，下面來看具體的內容介紹吧2022-01-01
在 Java 中,指令重排是一種性能優(yōu)化技術,它涉及到編譯器和處理器對程序中指令的執(zhí)行順序進行調整,以提高執(zhí)行效率,本文給大家詳細介紹了Java中的指令重排,需要的朋友可以參考下2023-12-12
本文主要介紹了java通過DelayQueue實現(xiàn)延時任務，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-07-07
Java實現(xiàn)對視頻進行截圖的方法【附ffmpeg下載】
這篇文章主要介紹了Java實現(xiàn)對視頻進行截圖的方法,結合實例形式分析了Java使用ffmpeg針對視頻進行截圖的相關操作技巧,并附帶ffmpeg.exe文件供讀者下載使用,需要的朋友可以參考下2018-01-01
這篇文章主要介紹了SpringBoot?Web依賴教程，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-11-11