devbox
AllinToyou
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Word 模板引擎_word 作为模板引擎

作者：AllinToyou | 2024-06-12 20:34:47

赞

踩

word 作为模板引擎

poi-tl(poi-template-language)

https://github.com/Sayi/poi-tl

Word 模板引擎，基于Apache POI - the Java API for Microsoft Documents。

What is poi-tl

FreeMarker、Velocity基于文本模板和数据生成新的HTML页面、配置文件等，poi-tl是Word模板引擎，基于Microsoft Word模板和数据生成新的文档。

Word模板拥有丰富的样式，poi-tl在生成的文档中会完美保留模板中的样式，还可以为标签设置样式，标签的样式会被应用到替换后的文本上，因此你可以专注于模板设计。

poi-tl是一种 "logic-less" 模板引擎，没有复杂的控制结构和变量赋值，只有标签，一些标签可以被替换为文本、图片、表格等，一些标签会隐藏某些文档内容，而另一些标签则会将一系列文档内容循环渲染。

"Powerful" constructs like variable assignment or conditional statements make it easy to modify the look of an application within the template system exclusively... however, at the cost of separation, turning the templates themselves into part of the application logic.

《Google CTemplate》

poi-tl支持自定义渲染函数(插件)，函数可以在Word模板的任何位置执行，在文档的任何地方做任何事情(Do Anything Anywhere)是poi-tl的星辰大海。

Maven

  1. <dependency>
  2.   <groupId>com.deepoove</groupId>
  3.   <artifactId>poi-tl</artifactId>
  4.   <version>1.8.2</version>
  5. </dependency>

2分钟快速入门

从一个超级简单的例子开始：把{{title}}替换成"poi-tl 模板引擎"。

  1. 新建文档模板template.docx，包含标签{{title}}
  2. TDO模式：Template + data-model = output
  1. //核心API采用了极简设计，只需要一行代码
  2. XWPFTemplate.compile("template.docx").render(new HashMap<String, Object>(){{
  3.         put("title", "poi-tl 模板引擎");
  4. }}).writeToFile("out_template.docx");

打开out_template.docx文档吧，一切如你所愿。

标签

标签由前后两个大括号组成，{{title}}是标签，{{?title}}也是标签，title是这个标签的名称，?标识了标签类型，接下来我们来看看有哪些标签类型。

文本

文本标签是Word模板中最基本的标签类型，{{name}}会被数据模型中key为name的值替换，如果找不到默认会清空标签，可以配置是保留还是抛出异常。

文本标签的样式会应用到替换后的文本上，正如下面的例子所示。

数据:

  1. {
  2.   "name": "Mama",
  3.   "thing": "chocolates"
  4. }

Word模板:

{{name}} always said life was like a box of {{thing}}.
{{name}} always said life was like a box of {{thing}}.

输出:

Mama always said life was like a box of chocolates.
Mama always said life was like a box of chocolates.

图片

图片标签以@开始，如{{@logo}}会在数据中寻找key为logo的值，然后将标签替换成图片。由于Word文档中图片不是由字符串表示(在文本型模板中，比如HTML网页图片是由字符串<img src="" />表示)，所以图片标签对应的数据有一定的结构要求，这些结构都会有相应的Java类对应。

数据:

  1. {
  2.   "watermelon": {
  3.     "path": "assets/watermelon.png"
  4.   },
  5.   "lemon": {
  6.     "path": "http://xxx/lemon.png"
  7.   },
  8.   "banana": {
  9.     "path": "sob.png",
  10.     "width": 24,
  11.     "height": 24
  12.   }
  13. }

Word模板:

  1. Fruit Logo:
  2. watermelon {{@watermelon}}
  3. lemon {{@lemon}}
  4. banana {{@banana}}

输出:

  1. Fruit Logo:
  2. watermelon 
    声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/AllinToyou/article/detail/709519
    推荐阅读
    相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。