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

poi-tl导出word

作者：盐析白兔 | 2024-05-22 06:01:42

赞

踩

poi-tl

1、poi-tl是什么

poi-tl是一个基于Apache POI的Word模板引擎，同时它也是一个免费开源（github地址）的Java类库，给Java程序员带来了word处理上的便捷。

2、官方介绍

在文档的任何地方做任何事情（Do Anything Anywhere）是poi-tl的星辰大海。

2.1 poi-tl与其他word模板引擎的对比

方案 移植性 功能性 易用性

Poi-tl Java跨平台 Word模板引擎 基于Apache POI，更友好的API

Apache POI Java跨平台 Apache项目，不仅封装了易用的文档API(文本、图片、表格、页眉、页脚、图表等)，也可以在底层直接操作XML结构 文档不全，这里有一个教程：Apache POI Word快速入门

Freemarker XML跨平台 仅支持文本，很大的局限性 不推荐，需要维护XML结构，代码后期不可维护

OpenOffice 部署OpenOffice，移植性较差 - 需要了解OpenOffice的API

HTML浏览器导出 依赖浏览器的实现，移植性较差 HTML不能很好的兼容Word的格式 -

Jacob、winlib Windows平台 - 复杂，完全不推荐使用

2.2 poi-tl的编码模式

TDO模式： Template + data-model = output

2.2.1 Template—模板

模板即Docx格式的Word文档

2.2.2 Data-model—数据

数据即模板中需要替换的数据结构，类似哈希或者字典，常用Map结构，其中key即需要替换的标签

2.2.3 Output—输出

输出即最终文档的流产生，可以是文件流或网络流等

3、软件要求

Apache POI 4.1.2

jdk 1.8+

maven依赖

  1. <dependency>
  2.  
  3. <groupId>com.deepoove</groupId>
  4.  
  5. <artifactId>poi-tl</artifactId>
  6.  
  7. <version>1.10.0</version>
  8.  
  9. </dependency>

4、标签

4.1 文本

标签

{{var}}数据模型

  1. String：文本
  2. TextRenderData：有样式的文本
  3. HyperlinkTextRenderData ：超链接和锚点文本
  4. Object：调用 toString() 方法转化为文本

测试模板

  1. ​
  2. package http://com.ruoyi.poiTl;
  3.  
  4. import http://com.deepoove.poi.XWPFTemplate;
  5.  
  6. import http://com.deepoove.poi.data.Texts;
  7.  
  8. import http://java.io.FileOutputStream;
  9.  
  10. import http://java.io.IOException;
  11.  
  12. import http://java.util.HashMap;
  13.  
  14. /**
  16. * poi_tl导出word文档测试
  18. * @author: lbx
  20. * @create: 23/03/15 015
  22. **/
  23.  
  24. public class DocTest {
  25.  
  26. public static void main(String[] args) throws IOException {
  27.  
  28. String filePath = "E:\\works\\zj\\ruoyi-admin\\src\\main\\resources\\testTest.docx";
  29.  
  30. String targetPath = "E:\\works\\zj\\ruoyi-admin\\src\\main\\resources\\textTestTarget.docx";
  31.  
  32. XWPFTemplate template = XWPFTemplate.compile(filePath).render(
  33.  
  34. new HashMap<String, Object>() {
  35.  
  36. {
  37.  
  38. put("name", "测试");
  39.  
  40. put("author", Texts.of("Liziba").color("000000").create());
  41.  
  42. put("link", Texts.of("百度").link("https://baidu.com").create());
  43.  
  44. put("anchor", Texts.of("anchortxt").anchor("appendix1").create());
  45.  
  46. }
  47.  
  48. });
  49.  
  50. template.writeAndClose(new FileOutputStream(targetPath));
  51.  
  52. }
  53.  
  54. }
  55.  
  56. ​

测试结果

4.2 图片

标签

{{@var}}

数据模型

  1. String：图片url或者本地路径。默认使用图片自身尺寸
  2. PictureRenderData

测试模板

测试代码

  1. ​
  2. package http://com.ruoyi.poiTl;
  3.  
  4. import http://com.deepoove.poi.XWPFTemplate;
  5.  
  6. import http://com.deepoove.poi.data.PictureType;
  7.  
  8. import http://com.deepoove.poi.data.Pictures;
  9.  
  10. import http://com.deepoove.poi.data.Texts;
  11.  
  12. import http://java.io.FileInputStream;
  13.  
  14. import http://java.io.FileOutputStream;
  15.  
  16. import http://java.io.IOException;
  17.  
  18. import http://java.util.HashMap;
  19.  
  20. /**
  22. * 导出图片测试
  24. *
  26. * @author: lbx
  28. * @create: 23/03/15 015
  30. **/
  31.  
  32. public class PictureTest {
  33.  
  34. public static void main(String[] args) throws IOException {
  35.  
  36. String filePath = "E:\\works\\zj\\ruoyi-admin\\src\\main\\resources\\testTest.docx";
  37.  
  38. String targetPath = "E:\\works\\zj\\ruoyi-admin\\src\\main\\resources\\pictureTest2.docx";
  39.  
  40. String picPath = "E:\\works\\zj\\ruoyi-admin\\src\\main\\resources\\2056870.jpg";
  41.  
  42. XWPFTemplate template = XWPFTemplate.compile(filePath).render(
  43.  
  44. new HashMap<String, Object>() {
  45.  
  46. {
  47.  
  48. put("name", "测试");
  49.  
  50. put("author", Texts.of("Liziba").color("000000").create());
  51.  
  52. put("link", Texts.of("百度").link("https://baidu.com").create());
  53.  
  54. put("anchor", Texts.of("anchortxt").anchor("appendix1").create());
  55.  
  56. // 方法一、图片路径（原大小）
  57.  
  58. put("picture", picPath);
  59.  
  60. // 方法二、指定图片大小
  61.  
  62. put("picture", Pictures.ofLocal(picPath).size(3840, 2160).center().create());
  63.  
  64. // 方法三、图片流
  65.  
  66. put("picture", Pictures.ofStream(new FileInputStream(picPath), PictureType.JPEG)
  67.  
  68. .size(384, 216).create());
  69.  
  70. // 针对网络图片、SVG图片、Java图片都有处理
  71.  
  72. }
  73.  
  74. });
  75.  
  76. template.writeAndClose(new FileOutputStream(targetPath));
  77.  
  78. }
  79.  
  80. }
  81.  
  82. ​

测试结果

4.3 表格

标签

{{#var}}

数据模型

  1. TableRenderData

测试模板

测试代码

  1. ​
  2. package http://com.ruoyi.poiTl;
  3.  
  4. import http://com.deepoove.poi.XWPFTemplate;
  5.  
  6. import com.deepoove.poi.data.*;
  7.  
  8. import http://java.io.FileInputStream;
  9.  
  10. import http://java.io.FileOutputStream;
  11.  
  12. import http://java.io.IOException;
  13.  
  14. import http://java.util.HashMap;
  15.  
  16. /**
  18. * @author: lbx
  20. * @create: 23/03/15 015
  22. **/
  23.  
  24. public class TableTest {
  25.  
  26. public static void main(String[] args) throws IOException {
  27.  
  28. String filePath = "E:\\works\\zj\\ruoyi-admin\\src\\main\\resources\\testTest.docx";
  29.  
  30. String targetPath = "E:\\works\\zj\\ruoyi-admin\\src\\main\\resources\\pictureTest2.docx";
  31.  
  32. String picPath = "E:\\works\\zj\\ruoyi-admin\\src\\main\\resources\\2056870.jpg";
  33.  
  34. // 表头
  35.  
  36. RowRenderData tableHead = Rows.of("姓名", "性别", "地址", "微信公众号").center().bgColor("4472c4").create();
  37.  
  38. // 第一行
  39.  
  40. RowRenderData row1 = Rows.create("张三", "男", "广东深圳", "liziba_98");
  41.  
  42. // 第二行
  43.  
  44. RowRenderData row2 = Rows.create("李四", "男", "广东深圳", "liziba_98");
  45.  
  46. // 合并第一行和第二行的第二列与第三列
  47.  
  48. MergeCellRule rule = MergeCellRule.builder().map(MergeCellRule.Grid.of(1, 1), MergeCellRule.Grid.of(2, 1))
  49.  
  50. .map(MergeCellRule.Grid.of(1, 2), MergeCellRule.Grid.of(2, 2)).build();
  51.  
  52. XWPFTemplate template = XWPFTemplate.compile(filePath).render(
  53.  
  54. new HashMap<String, Object>() {
  55.  
  56. {
  57.  
  58. put("name", "测试");
  59.  
  60. put("author", Texts.of("Liziba").color("000000").create());
  61.  
  62. put("link", Texts.of("百度").link("https://baidu.com").create());
  63.  
  64. put("anchor", Texts.of("anchortxt").anchor("appendix1").create());
  65.  
  66. // 方法一、图片路径（原大小）
  67.  
  68. put("picture", picPath);
  69.  
  70. // 方法二、指定图片大小
  71.  
  72. put("picture", Pictures.ofLocal(picPath).size(3840, 2160).center().create());
  73.  
  74. // 方法三、图片流
  75.  
  76. put("picture", Pictures.ofStream(new FileInputStream(picPath), PictureType.JPEG)
  77.  
  78. .size(384, 216).create());
  79.  
  80. // 针对网络图片、SVG图片、Java图片都有处理
  81.  
  82. put("table", Tables.of(tableHead, row1, row2).mergeRule(rule).center().create());
  83.  
  84. }
  85.  
  86. });
  87.  
  88. template.writeAndClose(new FileOutputStream(targetPath));
  89.  
  90. }
  91.  
  92. }
  93.  
  94. ​

测试结果

4.4 列表、区块对、嵌套

5、总结

开发过程中，我们为了效率和可用性，都不大会考虑重复造轮子，在有成熟工具的时候选择一个合适的工具是一件事半功倍的事情，以上讲述了poi-tl的部分简单功能，看了上述编码方式也是仁者见仁智者见智吧，作者是非常喜欢通过poi-tl来处理word文档。具体其他特性读者可以去poi-tl的官网学习。

官网地址：http://deepoove.com/poi-tl

github地址：https://github.com/Sayi/poi-tl

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

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

  

闽ICP备14008679号