使用poi-tl向word插入图片、文本、表格行循环

使用poi-tl向word插入图片、文本、表格行循环

工作中难免会向word中操作数据,本文主要介绍poi-tl的使用,先来看效果图
在这里插入图片描述
在这里插入图片描述
核心介绍: 标签
1、插入文本标签 : {{var}}
2、插入图片标签: {{@var}}

操作步骤:
1、引入依赖

 <dependency>
      <groupId>org.apache.poi</groupId>
      <artifactId>poi</artifactId>
      <version>4.1.2</version>
      <exclusions>
        <exclusion>
          <groupId>org.apache.xmlbeans</groupId>
          <artifactId>xmlbeans</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
<!--    #我在开发时遇到poi 4.1.2版本缺失xmlbeans依赖,于是自行补上-->
    <dependency>
      <groupId>org.apache.xmlbeans</groupId>
      <artifactId>xmlbeans</artifactId>
      <version>3.1.0</version>
    </dependency>

    <dependency>
      <groupId>org.apache.poi</groupId>
      <artifactId>poi-ooxml</artifactId>
      <version>4.1.2</version>
    </dependency>
    
    <dependency>
      <groupId>org.apache.poi</groupId>
      <artifactId>poi-ooxml-schemas</artifactId>
      <version>4.1.2</version>
    </dependency>
    
    <dependency>
      <groupId>com.deepoove</groupId>
      <artifactId>poi-tl</artifactId>
      <version>1.10.3</version>
    </dependency>

2、Java核心代码

// 关于以下参数datas如何生成,我简单写一个例子,因为大家可以看到开始的图片,我做的时候需要套接的字太多了,
// 但不难,大家有多少写多少就ok,主要是将套接字和需要填充的字段连接起来
 Map<String,Object> datas =new HashMap<>();
  datas.put("year",year); // 套接普通文本
  
  //如果有循环表格怎么办呢,下问题,仔细看Map的value是Object类型,你可以封装一个新的map集合作为value
  List<Map<String,Object>> detailList = new ArrayList<>();
  for(...){
  		Map<String,Object> map =new HashMap<>();
  		 map.put("index",i + 1);
         map.put("code",baseDocument.getCode());
  		 detailList.add(map);
  }
  datas.put("dataList",detailList); //嵌套循环表格数据,想要得倒循环的效果记得要绑定,见下列readModel函数
  PictureRenderData pic = getPictureData(inputStream)
  datas.put("pic1",pic) // 套接图片
  
/**
    * @Param datas 标签与需要填充的字段
    * @return void
    **/
 public void readModel(Map<String,Object> datas) {
        // 获取文件模版的输入流 ,也可以使用IO流访问文件具体的路径,
        InputStream stream = readResult.stream;
        
        // 循环行表格锁定函数
        LoopRowTableRenderPolicy policy = new LoopRowTableRenderPolicy();
// 将需要循环的表格的上一列插入{{var}},下面需要循环的数据使用[var]
        Configure config = Configure.builder()
                .bind("dataList", policy) // 绑定循环行标签,有几个循环行则绑定几个,即绑定{{var}}
                .bind("picList",policy)
                .bind("arcList",policy)
                .build();
        XWPFTemplate template = XWPFTemplate.compile(stream,config).render(datas);  // 这里的datas是Map<String,Object> 类型,key与模版中的标签一致,value就是想要填充的值
        try {
        	FileOutputStream out;
       	    out = new FileOutputStream("输出路径");
             // 生成word的输出流
            template.write(out);           
            out.flush();
            out.close();
            byteArrayInputStream.close();
            template.close();
        } catch (IOException e) {
            e.printStackTrace();
            log.info(e.getMessage());
        }
    }
    /**
     * 传入图片的输入流获取图片文件
     * @param inputStream
     * @return
     */
    public PictureRenderData getPictureData(InputStream inputStream){
        return new PictureRenderData(80,25,PictureType.JPEG,inputStream);
    }

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

总结

1、准备模版,定义好需要的标签
2、查询模版
3、获取需要填充的字段
4、将需要套接的关键字和需要填充的字段组合成Map<String,Object> datas(其中key为标签,value为需要填充的字段)
5、写入datas并生成新的word

常见问题

1、项目直接报错,没有生成word
可能的原因:

  1. 项目构建Map<String,Object> datas 里有空指针异常
  2. poi-tl与poi版本冲突,详见官网选择合适的版本

2、已生成新的word文件,但部分数据没有渲染,展示出的是模版字段,例如模版中存在{{var}},导出来还是{{var}}
可能的原因:

  1. 标签关键字跟java代码中的key不一致,需要仔细看
  2. 部分标签的命名有点长,可能存在空格或换行符,将空格或换行符删掉即可。

本文未给出全部代码,但关键性的代码已给出,并作了详细的注释,加上本人所踩的坑一并奉上,希望能帮助到你。

  • 3
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论
注:下文中的 *** 代表文件名中的版本号。 # 【poi-ooxml-***.jar中文文档.zip】 中包含: 中文文档:【poi-ooxml-***-javadoc-API文档-中文(简体)版.zip】 jar包下载地址:【poi-ooxml-***.jar下载地址(官方地址+国内镜像地址).txt】 Maven依赖:【poi-ooxml-***.jar Maven依赖信息(可用于项目pom.xml).txt】 Gradle依赖:【poi-ooxml-***.jar Gradle依赖信息(可用于项目build.gradle).txt】 源代码下载地址:【poi-ooxml-***-sources.jar下载地址(官方地址+国内镜像地址).txt】 # 本文件关键字: poi-ooxml-***.jar中文文档.zip,java,poi-ooxml-***.jar,org.apache.poi,poi-ooxml,***,org.apache.poi.ooxml,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,apache,poi,ooxml,中文API文档,手册,开发手册,使用手册,参考手册 # 使用方法: 解压 【poi-ooxml-***.jar中文文档.zip】,再解压其中的 【poi-ooxml-***-javadoc-API文档-中文(简体)版.zip】,双击 【index.html】 文件,即可用浏览器打开、进查看。 # 特殊说明: ·本文档为人性化翻译,精心制作,请放心使用。 ·只翻译了该翻译的内容,如:注释、说明、描述、用法讲解 等; ·不该翻译的内容保持原样,如:类名、方法名、包名、类型、关键字、代码 等。 # 温馨提示: (1)为了防止解压后路径太长导致浏览器无法打开,推荐在解压时选择“解压到当前文件夹”(放心,自带文件夹,文件不会散落一地); (2)有时,一套Java组件会有多个jar,所以在下载前,请仔细阅读本篇描述,以确保这就是你需要的文件; # Maven依赖: ``` <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>***</version> </dependency> ``` # Gradle依赖: ``` Gradle: implementation group: 'org.apache.poi', name: 'poi-ooxml', version: '***' Gradle (Short): implementation 'org.apache.poi:poi-ooxml:***' Gradle (Kotlin): implementation("org.apache.poi:poi-ooxml:***") ``` # 含有的 Java package(包)(此处仅列举3个): ``` org.apache.poi.ooxml org.apache.poi.ooxml.dev org.apache.poi.ooxml.extractor ...... ``` # 含有的 Java class(类)(此处仅列举3个): ``` org.apache.poi.ooxml.POIXMLDocument org.apache.poi.ooxml.POIXMLDocumentPart org.apache.poi.ooxml.POIXMLDocumentPart.RelationPart ...... ```
poi-tl是一个基于POIJava模板引擎,可以用于导出Word文档。在poi-tl中,可以使用foreach指令实现循环,并根据需要循环输出列表和列。 在poi-tl中,可以将需要循环的数据存储在一个List对象中,然后使用foreach指令进循环遍历。假设我们有一个List<RowData>对象,其中RowData是自定义的类,用于表示每一的数据。RowData类中可以包含一些属性,代表每一中的不同列。 首先,我们需要在Word模板中使用foreach指令,来循环输出列表和列。可以使用标签${foreach items=listVar item=rowVar}和${end}将需要循环的部分包围起来。其中listVar是存储数据的List对象的名称,rowVar是循环过程中每一数据的临时变量名。 然后,在foreach指令中,可以使用${rowVar.property}的方式获取每一的属性值,来完成对列表和列的输出。property代表RowData类中的某一个属性的名称。 最后,使用poi-tl提供的模板渲染引擎,将数据填充到Word模板中,生成目标Word文档。 综上所述,利用poi-tl可以很方便地循环输出列表和列。首先需要准备好存储数据的List对象,并在Word模板中使用foreach指令进循环遍历。然后,在循环过程中使用${rowVar.property}的方式获取每一的属性值,完成对列表和列的输出。最终,使用poi-tl提供的模板渲染引擎将数据填充到Word模板中,生成目标Word文档。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

暮春二十四

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值