基于Freemarker实现导出数据为word文档_freewarker 怎么把ftl转word-优快云博客

本文详细介绍了如何利用Spring Boot结合Freemarker模板引擎动态生成Word文档。步骤包括在pom.xml中引入依赖，创建.ftl模板，进行插值操作，最后编写接口实现数据填充并生成Word文件。示例中展示了接口信息和请求/响应参数的展示方式。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

整体流程
1、pom.xml

org.springframework.boot spring-boot-starter-freemarker 2、生成 .ftl 模版文件新建一个空的word文档，按照你预期的导出文档格式填充内容。

以我为例，我期望导出的word文档，需要包含接口的基本信息，接口请求/响应参数均以表格方式显示，如下所示：

点击“另存为”，出现如下弹框。在文件类型处，选择 xml 格式并保存

找到保存的xml文件位置，手动将文件的 .xml 后缀改成 .ftl 后缀

3、在项目的 resources目录下，新建一个templates目录，用于存放 .ftl 模版文件

4、格式化ftl模板
在使用 .ftl 文件之前，我们还需要对其进行修改，增加数据显示内容。但是，我们得到的原始 .ftl文件可读性很差，更别提要修改它啦。如下所示：

因此，我们需要借助工具对其进行格式化。我参考了一篇博客如何format格式化ftl模板中的方法，结果真的很好用，这里我就不作多余介绍了。将格式化后的内容全部copy至原来的ftl文件中，如下图所示（截图显示不全）:

5、插值操作
ftl文件只是一个格式模版，没有任何数据信息。我们最终需要的是将获取到的数据动态地展示在word文档中。因此，需要使用 ftl模板语法和指令进行插值操作。

还是以我自身为例，接口基本信息插值操作后的ftl文件如下：

接口请求/响应参数表格插值操作后的ftl文件如下：

6、编写生成word文档的接口
/**
* 生成 word 文件
*
* @param dataMap 待填充数据
* @param templateName 模板文件名称
* @param filePath 模板文件路径
* @param fileName 生成的 word 文件名称
*/
public static void createWord(Map dataMap, String templateName, String filePath, String fileName){
// 创建配置实例
Configuration configuration = new Configuration(Configuration.VERSION_2_3_28);
// 设置编码
configuration.setDefaultEncoding(StandardCharsets.UTF_8.name());
// ftl模板文件
configuration.setClassForTemplateLoading(ActionController.class, filePath);

    try {
        // 获取模板
        Template template = configuration.getTemplate(templateName);
        
        File outFile = new File(System.getProperties().getProperty("user.home") + File.separator + "filepath" + File.separator + fileName);
        Writer out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(outFile),"UTF-8"));

        // 生成文件
        template.process(dataMap, out);

        out.flush();
        out.close();
    } catch (Exception e){
        e.printStackTrace();
    }
}

@RequestMapping(value = "/generateDocumentOfApi", method = RequestMethod.GET)
public void generateDocumentOfApi(@RequestParam(value = "id") Integer id, @RequestParam(value = "type")String type) {
    System.out.println("前端传递过来的接口id：" + id + "  导出文件格式" + type);
    try{
        Action action = actionService.findByPrimaryKey(id);
        System.out.println("action: " + JSONObject.toJSONString(action));
        String fileName = action.getName() + "." + type;
        System.out.println("fileName: " + fileName);

        if(type.equals("doc")){

            ArrayList<JSONObject> headerList = Lists.newArrayList();
            JSONObject header = new JSONObject();
            header.put("name", "rpid");
            header.put("val", "1000000");
            headerList.add(header);

            Map map = Maps.newHashMap();
            map.put("apiBaseInfos", action);
            map.put("requestList", action.getRequestParameterList());
            map.put("responseList", action.getResponseParameterList());

            createWord(map, "api5.ftl", "/templates/", fileName);
        }else {
            // json
            FileUtil.createNewFile(fileName, action);
            System.out.println("文件生成成功！");
        }
    }catch (Exception e){
        e.printStackTrace();
    }
}

参考博客
1、Word Xml格式标签说明

2、freemarker ftl模板语法和指令

3、SpringBoot 中使用 freemarker 模板文件动态生成/导出 word 文档

4、java导出word的5种方式
————————————————
版权声明：本文为优快云博主「小小平不平凡」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.youkuaiyun.com/sinat_34241861/article/details/116994088