超好用的按模板导出word(一)

在开发时候经?;嵊龅缴杀ǜ娴男枨螅虻ヒ坏愕纳蒭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模板

image.png

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"));
    }
}

三、最终效果

image.png

四、重点解释之变量

  1. 文本参数使用{{var}}定义
  2. 图片参数使用{{@var}}定义
  3. 表格参数使用{{#var}}定义
  4. 还有嵌套、组合图表等多种支持,可以参考官方文档

五、重点解释之图表

图表生成稍微复杂一些,使用office--插入--图表,选择需要的图表类型,如下图:


image.png

然后定义页面上替换的变量(具体渲染数据见代码)


image.png

具体传入的数据、X轴、Y轴、图例等等,可以参考API官方文档

?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,992评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,212评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,535评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,197评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,310评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,383评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,409评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,191评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,621评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,910评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,084评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,763评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,403评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,083评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,318评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,946评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,967评论 2 351

推荐阅读更多精彩内容