java通过poi-tl导出word实战详细步骤

news2024/11/15 23:20:59

文章目录

与其他模版引擎对比
1.引入maven依赖包
2.新建Word文档exportWprd.docx模版
3.编写导出word接口代码
4.导出成果

poi-tl是一个基于Apache POI的Word模板引擎，也是一个免费开源的Java类库，你可以非常方便的加入到你的项目中，并且拥有着让人喜悦的特性。中文网站

可以通过word模版引擎渲染文本、图片、表格、列表数据
可以渲染条形图（3D条形图）、柱形图（3D柱形图）、面积图（3D面积图）、折线图（3D折线图）、雷达图、饼图（3D饼图）、散点图等图表渲染
可以根据条件隐藏或者显示某些文档内容（包括文本、段落、图片、表格、列表、图表等）
可以根据集合循环某些文档内容（包括文本、段落、图片、表格、列表、图表等）
支持设置书签，文档内锚点和超链接功能
模板即样式，同时代码也可以设置样式
插件化设计，在文档任何位置执行函数

与其他模版引擎对比

在这里插入图片描述

1.引入maven依赖包

（1）引入poi-tl包

<dependency>
  <groupId>com.deepoove</groupId>
  <artifactId>poi-tl</artifactId>
  <version>1.12.2</version>
</dependency>

（2）因为poi-tl依赖于Apache POI5.2.2+，所以必须映入poi依赖包

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>5.2.2</version>
</dependency>

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>5.2.2</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml-schemas</artifactId>
    <version>4.1.2</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-scratchpad</artifactId>
    <version>5.2.2</version>
    <scope>compile</scope>
</dependency>

（3）继续引入poi-tl需要的commons-io与log4j-api依赖包（必须引入，否则会报错，报错如下）

<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.11.0</version>
</dependency>

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.14.1</version>
</dependency>

不引入会导致报错，报错如下：

在这里插入图片描述

2.新建Word文档exportWprd.docx模版

在静态资源目录下resources/static/templates新建exportWord.docx，编写以下模版内容：
在这里插入图片描述

3.编写导出word接口代码

  @GetMapping("/exportWord")
  public void exportWord(HttpServletResponse response) throws FileNotFoundException {
      //存放数据，也就是填充在word里面的值
      Map<String, Object> params = new HashMap<>();
      params.put("title","测试使用poi-tl模版导出word");
      params.put("ceshi","测试使用poi-tl模版导出word");
      params.put("name","张三");
      params.put("text","知之为知之不知为不知");

      //模板路径
      // String templatePath = "E:\\demo\\word.docx";
      // 或模板在静态资源的相对路径
      File rootFile = new File((ResourceUtils.getURL("classpath:").getPath()));
      File templateFile = new File(rootFile, "/static/templates/exportWord.docx");
      //jar包获取不到文件路径`
      //URLDecoder.decode() 解决获取中文名称文件路径乱码
      String templatePath = URLDecoder.decode(templateFile.getPath());
      //生成文件名
      String fileName = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()) + "_" + System.currentTimeMillis();
      // 导出wold
      try {
          // 导出Word文档为文件
          XWPFTemplate template = XWPFTemplate.compile(templatePath).render(params);
          // 将导出的Word文件转换为流
          response.setContentType("application/octet-stream");
          response.setHeader("Content-disposition","attachment;filename=\""+fileName+".docx"+"\"");
          // HttpServletResponse response
          OutputStream out = response.getOutputStream();
          BufferedOutputStream bos = new BufferedOutputStream(out);
          template.write(bos);
          bos.flush();
          out.flush();
          // 最后不要忘记关闭这些流。
          PoitlIOUtils.closeQuietlyMulti(template, bos, out);
      } catch (Exception e) {
          System.out.println("导出Word文档时出现异常：" + e.getMessage());
      }
  }