freemarker实现word文档模板动态生成

携手创作，共同成长！这是我参与「掘金日新计划 · 8 月更文挑战」的第29天，点击查看活动详情

1.写在前面

很多时候，我们可能需要根据一个word模板，动态生成，我们所需要得一个word文档。

那这里，通过word模板生成word文档，我之前写过一个案例： [word模板数据填充并转pdf]

这个案例得word模板，有什么弊端呢？我们来看一下这个word模板，格式如下：

图片.png

这样得一个word模板，我之前得做法是 替换段落文本 ，那会有啥问题？

文本的格式可能会丢失。
替换内容标识，可能会读取不到(单词别隔开)。
无法动态循环输出一个list集合。
table表格无法做到动态输出。

当然啦，因为我们之前的业务功能比较简单，使用之前的 替换段落文本 方式，也是能实现到，所以就一直没有去研究，有无更好的方式。

嘿，随着业务功能的不断深入，动态list集合，动态table，这些功能也要求要实现了。

那我们作为一个程序员，这不得深入研究嘛？

巧了，哥们这几天，也研究了一个方式，可以实现动态list集合，动态table的渲染，那就是 freemarker模板引擎 。

好了，废话不多说，直接进入主题了！！！

图片.png

2.freemarker实现

首先说一下实现步骤：通过将word模板，另存为 .xml 格式，然后将 .xml 文件后缀改成 .ftl ，然后再使用freemarker模板引擎，将数据填充到 .ftl ，然后再输出成一个 word 文档。

实现步骤，还是挺清晰的。那接下来，我们来实现一下：

2.1 word模板

图片.png

例如：我们有一个这样的api接口文档，然后我们的系统后台会配置管理了很多api接口，然后导出到一个word文件。

1.输出的word文件，要带上文档目录结构(左边)

2.api的内容，要有table表格

3.api接口是一个list集合

由此可见，如果还是用我以前的方式，估计实现起来就相当麻烦了。

那这里用freemarker，如何实现呢？freemarker的语法是：${xxxx}，那我们来改造模板，格式如下

图片.png

这里为什么要用：${api.xxx}呢？我们来看一下freemarker是如何渲染一个list的？

<#list apiList as api> 
  ${api.apiName}   
</#list>

看到这，估计大家都懂了把？

就是说我们有一个 apiList 集合对象， apiList as api ，别名为 api ，进行遍历。 ${api.apiName} 就输出了apiName对应的属性的值。

看到这，我们的上面的模板，就很好理解了把？那我们来另存为xml。

图片.png

2.2 .xml改.ftl

使用idea打开.ftl，然后格式化一下，搜索一下 ${api.apiName}

图片.png

这里要注意一下，可能会有些地方报错，例如下面：

图片.png

对于这些内容，我们改一下即可。

图片.png

参考 ${api.apiName} 的格式即可。

好了，这里会有个问题，我们并没有看到有渲染一个list集合的？那这里，我们只能自己去构造了。

找到所有需要动态list渲染的内容，然后再加上 <#list > 标签

图片.png

看到这里，估计大家都知道怎么改 .ftl 模板了吧？这里就不在一一列举了。

2.3 freemarker渲染

如果是使用springboot，那我们的pom.xml文件，可以添加下面的依赖：

<!-- freemarker-starter -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
    <version>2.3.12.RELEASE</version>
</dependency>

当然，直接引入fremarker依赖也是可以的，例如下面：

<dependency>
  <groupId>org.freemarker</groupId>
  <artifactId>freemarker</artifactId>
  <version>2.3.31</version>
</dependency>

代码实现

@Autowired
private Configuration configuration;

@GetMapping("/doExportApiDoc2Word")
public void doExportApiDoc2Word(HttpServletResponse response,
                                @ApiParam @RequestParam(value = "projectId") String projectId){
    try {
        //返回word文档
        String fileName = URLEncoder.encode("接口文档" + DateUtil.format(new Date(), "yyyyMMddHHmmss"), "UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.addHeader("Content-Disposition", "attachment; filename="" + fileName + ".docx"");

        //获取apiDoc所需要的数据
        Map<String, Object> dataModel = llsydnService.getApiDocData(projectId);

        //加载模板
        Template template = configuration.getTemplate("apiDoc.ftl", "utf-8");
        //渲染模板
        template.process(dataModel, response.getWriter());
        //response的Writer不需要我们手动关，tomcat会帮我们关的
    } catch (Exception e) {
        log.error("导出word异常：", e);
    }
}