在开发时候经?;嵊龅缴杀ǜ娴男枨螅虻ヒ坏愕纳蒭xcel后用户再提取数据分析,本着能用程序尽量不要人工参与的原则,最好直接生成word版本,用户拿到一个基本可用的汇报材料才是最优解。但是java本身poi对生成word不是十分友好,也有一些第三方框架已经提供的基本模板生成,比如easypoi、apache poi等等,各有优劣,经过小编多种对比测试,非常推荐使用poi-tl来进行word生成。
“poi-tl(poi template language)是Word模板引擎,使用模板和数据创建很棒的Word文档?!薄霸谖牡档娜魏蔚胤阶鋈魏问虑椋―o Anything Anywhere)是poi-tl的星辰大海”
本文主要实现导出文本、超链接、图片、表格、chart图表。
一、依赖引入
注意: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>
<dependency>
<groupId>com.deepoove</groupId>
<artifactId>poi-tl</artifactId>
<version>1.12.2</version>
</dependency>
二、功能实现
大体实现逻辑:
- 定义模板
- 渲染数据
- 文档生成
下面先show code,最后再解释重点步骤。
1、定义word模板
2、渲染数据及生成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) {
// 渲染的数据
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("姓名", "性别", "年龄", "班级").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("变化趋势", new String[]{"2021", "2022", "2023", "2024", "2025", "2026"})
.addSeries("数量", new Number[]{1, 2, 3, 4, 5, 6}).create());
//单系列图表指的是饼图(3D饼图)、圆环图等。
map.put("chart1", Charts
.ofSingleSeries("综合测评结果统计", new String[]{"正常", "异常", "其他"})
.series("badAndgood", new Integer[]{19, 17, 15})
.create());
map.put("barChart", Charts.ofBar3D("GDP", new String[]{"2021", "2022", "2023", "2024"})
.addSeries("数量", 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官方网站", "https://deepoove.com/poi-tl/"));
map.put("mygiteelink", new HyperlinkTextRenderData("我的gitee", "https://gitee.com/chemors/mos-simple.git"));
}
}
三、最终效果
四、重点解释之变量
- 文本参数使用{{var}}定义
- 图片参数使用{{@var}}定义
- 表格参数使用{{#var}}定义
- 还有嵌套、组合图表等多种支持,可以参考官方文档
五、重点解释之图表
图表生成稍微复杂一些,使用office--插入--图表,选择需要的图表类型,如下图:
然后定义页面上替换的变量(具体渲染数据见代码)
具体传入的数据、X轴、Y轴、图例等等,可以参考API官方文档。