poi-tl二次开发

poi-tl是一款非常好用的word模板生成库,更新响应快、文档demo齐全。堪称word模板界的小军刀!

写在前面

如果你对word模板技术有了解、或者有兴趣,更甚者工作中接触过,那么接下来的内容应该会让你有所收获。

介绍poi-tl

功能如下:

  • 文本 {{var}}
  • 表格 {{#var}}
  • 图片 {{@var}}
  • 列表 {{*var}}
  • 嵌套 {{+var}}

更多文档参考如下:poi-tl

这里不再更多的赘述poi-tl的功能了,非常优秀的一个word模板库。

二次开发

如果你还没使用过poi-tl,那么接下来的内容,你应该不太会感同身受。

poi-tl使用一段时间后会发现仍存在一些问题,比如行列表格需要自己写代码指定样式、图片需要写代码指定高度宽度、列表也写代码指定样式。

为最大化利用word的样式,减少代码量,这里在v1.6.0之上进行源码扩展。

加入模板语法:name|attr:var

  • name 为功能名称
  • attr 为属性
  • var 为数据变量名称

fork地址:github

表格

语法:{{table|limit:var}}

  • table 说明是表格
  • limit 为数据填充的行数,数据不足补空
  • var 为填充数据(JSON)的 key,可以是一个对象或者对象数组。

模板:

其中:

  • 姓名的前面出现的{{table|5:[users]}},代表了这是一个表格模板(可以出现在表格的任意位置,建议在表头),users则说明数据中存在一个 users 的 key 。
  • 表格的第二行变量会根据传递的值动态替换,{name}、{age} 等模板,则说明 users 这个 key 中的对象或对象数组存在 name、age 这两个key。
  • 由于数据只有2条,限制5条,因此补空行3条

测试代码:

@Test
public void run() {
Path path = Paths.get("src/test/resources", "table_pattern.docx");
XWPFTemplate template = XWPFTemplate.compile(path.toFile())
// 数据
.render(new HashMap<String, Object>() {{
put("users", Arrays.asList(new User("张三", 1), new User("李四", 2)));
}});
// 输出
Path outPath = Paths.get("src/test/resources", "table_pattern_out.docx");
try (OutputStream os = new BufferedOutputStream(new FileOutputStream(outPath.toFile()))) {
template.write(os);
} catch (IOException e) {
LOG.error("render tpl error", e);
} finally {
try {
template.close();
} catch (IOException e) {
LOG.error("close template error", e);
}
}
}

可以看到这里的 map 中存在 users 这个 key,且存在 2 条数据。User 这个对象有两个属性 name、age ,模板在解析时,会自动取值。

输出:

总结:表格正常渲染,而且样式也正常保留,原来的数据也会保留下来,数据不足补空行。

图片

语法:{{image|height*width:var}}

  • image 说明是图片
  • height*width 代表图片的高度和宽度,单位为厘米
  • var 为填充数据的 key,是一个图片字节通过base64加密的字符串

模板:

测试代码:

@Test
public void run() throws IOException {
Path logoPath = Paths.get("src/test/resources", "logo.png");
byte[] bytes = Files.readAllBytes(logoPath);
byte[] encode = Base64.getEncoder().encode(bytes); Path path = Paths.get("src/test/resources", "image_pattern.docx");
XWPFTemplate template = XWPFTemplate.compile(path.toFile())
// 数据
.render(new HashMap<String, Object>() {{
put("logo", new String(encode));
}});
// 输出
Path outPath = Paths.get("src/test/resources", "image_pattern_out.docx");
try (OutputStream os = new BufferedOutputStream(new FileOutputStream(outPath.toFile()))) {
template.write(os);
} catch (IOException e) {
LOG.error("render tpl error", e);
} finally {
try {
template.close();
} catch (IOException e) {
LOG.error("close template error", e);
}
}
}

输出:

总结:图片能正常根据高度宽度渲染出来

列表

语法:list|limit:var

  • list 说明是列表
  • limit 为数据填充的行数,数据不足补空
  • var 为填充数据的 key,值可以是一个字符串或者一个字符串数组。

模板:

测试代码:

@Test
public void run() {
Path inPath = Paths.get("src/test/resources", "list_pattern.docx");
Path outPath = Paths.get("src/test/resources", "list_pattern_out.docx");
Map<String, Object> model = new HashMap<String, Object>() {{
put("items", Arrays.asList("张三", "李四", "王五"));
}};
try (InputStream is = Files.newInputStream(inPath); OutputStream os = Files.newOutputStream(outPath)) {
Tpl.render(is, model).out(os);
} catch (IOException e) {
LOG.info("render tpl failed", e);
}
}

输出:

总结:列表也能正常渲染,保证原有的格式。

tips

看示例,你也许会觉得很奇怪,为什么语法明明写的var,但是截图中有的写的是[var]、有的却写的var

这是因为变量取值采用的 spring expression 语法:如果代码中是一个对象,就可以直接写var,是一个map,就写[var],数组则是var[下标]

写在最后

如果觉得有用,快快使用起来吧!

poi-tl二次开发的更多相关文章

  1. Java学习-039-源码 jar 包的二次开发扩展实例(源码修改)

    最近在使用已有的一些 jar 包时,发现有些 jar 包中的一些方法无法满足自己的一些需求,例如返回固定的格式,字符串处理等等,因而需要对原有 jar 文件中对应的 class 文件进行二次开发扩展, ...

  2. 深入理解基于selenium的二次开发

    对于做web端自动化测试的人来说,可能接触selenium比QTP还要多,但是我们在做基于selenium的二次开发的时候,经常会说到二次开发是为了易于维护,很多人可能不懂得维护的价值是什么,和到底要 ...

  3. Navisworks API 简单二次开发 (自定义工具条)

    在Navisworks软件运行的时候界面右侧有个工具条.比较方便.但是在二次开发的时候我不知道在Api那里调用.如果有网友知道请告诉我.谢谢. 我用就自己设置一个工具.界面比较丑!没有美工. 代码: ...

  4. [连载]《C#通讯(串口和网络)框架的设计与实现》- 12.二次开发及应用

    目       录 第十二章     二次开发及应用... 2 12.1        项目配制... 3 12.2        引用相关组件... 4 12.3        构建主程序... 5 ...

  5. OBS-Studio二次开发记录

    OBS-Studio 是一款跨平台的,开源的视频直播客户端软件. 公司需要对他进行二次开发,开发的目的是使用它的录屏功能. 开发的要求是:定制全新的界面,所见即所得,window系统兼容要好. 开发步 ...

  6. 小猪cms微信二次开发之怎样分页

    $db=D('Classify'); $zid=$db->where(array('id'=>$this->_GET('fid'),'token'=>$this->tok ...

  7. 承接 AutoCAD 二次开发 项目

    本人有多年的CAD开发经验,独立完成多个CAD二次开发项目.熟悉.net及Asp.net开发技术,和Lisp开发技术. 现在成立了工作室,独立承接CAD二次开发项目.结项后提供源码及开发文档,有需要的 ...

  8. 【工业串口和网络软件通讯平台(SuperIO)教程】七.二次开发服务驱动

    SuperIO相关资料下载:http://pan.baidu.com/s/1pJ7lZWf 1.1    服务接口的作用 围绕着设备驱动模块采集的数据,根据需求提供多种应用服务,例如:数据上传服务.数 ...

  9. 【工业串口和网络软件通讯平台(SuperIO)教程】三.二次开发流程

    1.1    二次开发流程图 1.2    引用相关组件 找到“开发包”,引用里边的相关组件.如下图: 1.3    开发设备驱动模块 1.3.1    开发发送协议驱动 继承SuperIO.Devi ...

  10. Civil 3D API二次开发学习指南

    Civil 3D构建于AutoCAD 和 Map 3D之上,在学习Civil 3D API二次开发之前,您至少需要了解AutoCAD API的二次开发,你可以参考AutoCAD .NET API二次开 ...

随机推荐

  1. jmeter-利用While Controller控制器实现接口报错时的重试机制

    预期功能:在jmter脚本报错的时候重试,最多重试5次 1.添加While Controller 2.添加请求 3.添加断言,在断言不符合预期的时候加上代码:vars.put("status ...

  2. css3关于body的默认滑动机制

    css关于body的默认滑动机制 大家都知道 body里面只要高度超出了原来的高度就可以滚动要取消这个机制 只能设置height:100% overflow:hidden就能取消了

  3. css3mask淡出文字

    css3mask淡出文字<pre>.p0_11wrap { width: 0.299rem; height: 7.68rem; overflow: hidden; background: ...

  4. Linux PXE自动化安装centos6,centos7系统

    1.PXE是什么? pxe是Preboot Excution Environment的缩写,是intel公司研发,基于client/server的网络模式,支持远程主机通过网络从远端服务器下载镜,并由 ...

  5. C#索引器与数组的区别

    1.索引器的索引值类型不限定为整数 2.索引器允许重载 3.索引器不是一个变量 4.索引器以函数签名方式this标识,而属性采用名称来标识,名称可以任意 5.索引器不能使用static来进行声明,属性 ...

  6. Windows下mysql的下载和安装

    下载: 1.下载地址:https://www.mysql.com/downloads/ 2.选择社区版:MySQL Community (GPL) Downloads » 3.MySQL Commun ...

  7. java实现两个json的深度对比

    两个json的深度对比 在网上找了好多资料都没有找到想要的,还是自己写个吧! 上代码!!! 1.pom.xml中加入 <dependency> <groupId>com.ali ...

  8. 【前端知识体系-CSS相关】Bootstrap相关知识

    1.Bootstrap 的优缺点? 优点:CSS代码结构合理,现成的代码可以直接使用(响应式布局) 缺点:定制流程较为繁琐,体积大 2.如何实现响应式布局? 原理:通过media query设置不同分 ...

  9. Github相关知识

    github的提交流程 mkdir 目录名      :创建一个空文件夹 mkdir webs webs代表创建的新文件名称 cd 目录名   :切换到文件夹 cd webs 切换到当前新建的目录下 ...

  10. 根据json数据中某一个属性 处理数组重组的方法 (二种)

    需求:根据role 的不同分组 渲染页面 进行后期操作 后台返回数据:   因为后台返回的json数据不是我们想要的 所以就得自己来了~  要啥样整啥样 js: 第一种处理方法 使用方法: 1: th ...