在開(kāi)發(fā)時(shí)候經(jīng)常會(huì)遇到生成報(bào)告的需求，簡(jiǎn)單一點(diǎn)的生成excel后用戶再提取數(shù)據(jù)分析，本著能用程序盡量不要人工參與的原則，最好直接生成word版本，用戶拿到一個(gè)基本可用的匯報(bào)材料才是最優(yōu)解。但是java本身poi對(duì)生成word不是十分友好，也有一些第三方框架已經(jīng)提供的基本模板生成，比如easypoi、apache poi等等，各有優(yōu)劣，經(jīng)過(guò)小編多種對(duì)比測(cè)試，非常推薦使用poi-tl來(lái)進(jìn)行word生成。
“poi-tl（poi template language）是Word模板引擎，使用模板和數(shù)據(jù)創(chuàng)建很棒的Word文檔。”“在文檔的任何地方做任何事情（Do Anything Anywhere）是poi-tl的星辰大?！?/em>
本文主要實(shí)現(xiàn)導(dǎo)出文本、超鏈接、圖片、表格、chart圖表。
一、依賴引入
注意：poi-tl依賴的有poi，且需要有版本對(duì)應(yīng)，如果本身項(xiàng)目中已集成有poi，需要核對(duì)一下版本是否匹配。
<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>
<dependency>
<groupId>com.deepoove</groupId>
<artifactId>poi-tl</artifactId>
<version>1.12.2</version>
</dependency>
二、功能實(shí)現(xiàn)
大體實(shí)現(xiàn)邏輯：
- 定義模板
- 渲染數(shù)據(jù)
- 文檔生成
下面先show code，最后再解釋重點(diǎn)步驟。
1、定義word模板
image.png
2、渲染數(shù)據(jù)及生成word
import com.deepoove.poi.XWPFTemplate;
import com.deepoove.poi.data.*;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
public class WordGen {
public static void main(String[] args) {
// 渲染的數(shù)據(jù)
Map<String, Object> map = new HashMap<>();
/*文本*/
txtSimple(map);
//圖表
chartSimple(map);
//表格
tableSimple(map);
//圖片
imgSimple(map);
try {
ClassLoader classLoader = WordGen.class.getClassLoader();
URL resourceUrl = classLoader.getResource("demo/wordGen.docx");
XWPFTemplate.compile(resourceUrl.getFile()).render(map).writeToFile("D:\\2.docx");
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private static void imgSimple(Map<String, Object> map) {
try {
ClassLoader classLoader = WordGen.class.getClassLoader();
URL resourceUrl = classLoader.getResource("static//images//star-bg.jpg");
map.put("imgSimple", Pictures.ofStream(new FileInputStream(resourceUrl.getFile()), PictureType.JPEG)
.size(500, 500).create());
URL myQrCodeUrl = classLoader.getResource("static//images//qrcode.jpg");
map.put("myQr", Pictures.ofStream(new FileInputStream(myQrCodeUrl.getFile()), PictureType.JPEG)
.size(300, 300).create());
} catch (FileNotFoundException e) {
throw new RuntimeException(e);
}
}
private static void tableSimple(Map<String, Object> map) {
RowRenderData row0 = Rows.of("姓名", "性別", "年齡", "班級(jí)").textColor("FFFFFF")
.bgColor("4472C4").center().create();
TableRenderData renderData = Tables.create(row0);
for (int i = 0; i < 50; i++) {
String gen = i % 3 == 1 ? "男" : "女";
RowRenderData row = Rows.create("櫻木花道", gen, "17", "三年二班");
renderData.addRow(row);
}
map.put("tableSimple", renderData);
}
private static void chartSimple(Map<String, Object> map) {
map.put("lineChart", Charts.ofLine("變化趨勢(shì)", new String[]{"2021", "2022", "2023", "2024", "2025", "2026"})
.addSeries("數(shù)量", new Number[]{1, 2, 3, 4, 5, 6}).create());
//單系列圖表指的是餅圖（3D餅圖）、圓環(huán)圖等。
map.put("chart1", Charts
.ofSingleSeries("綜合測(cè)評(píng)結(jié)果統(tǒng)計(jì)", new String[]{"正常", "異常", "其他"})
.series("badAndgood", new Integer[]{19, 17, 15})
.create());
map.put("barChart", Charts.ofBar3D("GDP", new String[]{"2021", "2022", "2023", "2024"})
.addSeries("數(shù)量", new Number[]{100, 300, 320, 380})
.create());
}
private static void txtSimple(Map<String, Object> map) {
map.put("name", "小塵哥");
map.put("author", new TextRenderData("cccccc", "小塵哥"));
map.put("poilink", new HyperlinkTextRenderData("poi-tl官方網(wǎng)站", "https://deepoove.com/poi-tl/"));
map.put("mygiteelink", new HyperlinkTextRenderData("我的gitee", "https://gitee.com/chemors/mos-simple.git"));
}
}
三、最終效果
image.png
四、重點(diǎn)解釋之變量
- 文本參數(shù)使用{{var}}定義
- 圖片參數(shù)使用{{@var}}定義
- 表格參數(shù)使用{{#var}}定義
- 還有嵌套、組合圖表等多種支持，可以參考官方文檔
五、重點(diǎn)解釋之圖表
圖表生成稍微復(fù)雜一些，使用office--插入--圖表，選擇需要的圖表類型，如下圖：
image.png
然后定義頁(yè)面上替換的變量（具體渲染數(shù)據(jù)見(jiàn)代碼）
image.png
具體傳入的數(shù)據(jù)、X軸、Y軸、圖例等等，可以參考API官方文檔。
