Freemarker - 根据模板动态生成word文档

Freemarker 根据模板动态生成word文档

Freemarker 介绍：

  FreeMarker是一个用Java语言编写的模板引擎，它基于模板来生成文本输出，word，html等等。
本篇博客简单介绍根据模板生成word。

Freemarker 使用：

1. Maven工程添加依赖

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

2. 构建文件模板：
将需要动态填充的内容用 ${} 代替

• 新建一个word文件：
  

  • 将word文件另存为xml格式的文件:
    这时候需要将动态的填充的数据，使用 ${} 进行代替，如将pentiumCM
    和程序员使用 ${user}， ${job}代替。本人推荐将这个xml文件放到 idea 进行格式化（ctrl + Alt + L）之后再修改
    
    
  • 将修改好的 xml文件 直接修改文件后缀名为：.ftl
    

至此，便得到文件模板。
网上有很多教程，是说在起初的word里面直接将需要动态填充的数据用 ${} 替换，然后另存为xml文件，本人尝试过这种方法是不可行的，这种方法另存为的xml文件中， ${}已经被分开，程序是无法匹配上的。

3. 代码实现：

    public void genFile() throws Exception {
        // 1：创建Configuration对象，参数是freemarker对应的版本号。
        Configuration configuration = new Configuration(Configuration.getVersion());
        // 2：设置模板文件所在的路径。
        configuration.setDirectoryForTemplateLoading(new File("F:/project/postGradProj/smarthealth/code/gitee/smarthealth/smarthealth/jeecg-boot-base-common/src/main/resources/templates"));
        // 3：设置模板文件使用的字符集。一般就是utf-8.
        configuration.setDefaultEncoding("utf-8");
        // 4：加载模板文件，创建模板对象。
        Template template = configuration.getTemplate("模板文件.ftl");
        // 5：创建模板使用的数据集，可以是pojo也可以是map。一般是Map。
        Map<String, Object> dataModel = new HashMap<>();
        // 向数据集中添加数据
        dataModel.put("user", "pentiumCM(FreeMarker生成)");
        dataModel.put("job", "coder(FreeMarker生成)");
        // 6：创建一个Writer对象，一般创建一FileWriter对象，指定生成的文件名。
        Writer out = new FileWriter(new File("D:/动态生成的word.doc"));
        // 7：调用模板对象的process方法输出文件。
        template.process(dataModel, out);
        // 第八步：关闭流。
        out.close();
    }

效果：

freemarker还有很多其他功能，本篇博客主要目的给大家介绍一下freemarker的大致流程，详细其他用法需继续百度。

freemarker加载模板目录的方法

Freemarker提供了3种加载模板目录的方法。 它使用Configuration类加载模板。

三种方法分别是：

public void setClassForTemplateLoading(Class clazz, String pathPrefix);
public void setDirectoryForTemplateLoading(File dir) throws IOException;
public void setServletContextForTemplateLoading(Object servletContext, String path);

1. 第一种：基于类路径，HttpWeb包下的framemaker.ftl文件
   configuration.setClassForTemplateLoading(this.getClass(), “/HttpWeb”);
   configuration.getTemplate(“framemaker.ftl”); //framemaker.ftl为要装载的模板

2. 第二种：基于文件系统
   configuration.setDirectoryForTemplateLoading(new File(“D:/template”))
   configuration.getTemplate(“framemaker.ftl”); //framemaker.ftl为要装载的模板

3. 第三种：基于Servlet Context，指的是基于WebRoot下的template下的framemaker.ftl文件
   HttpServletRequest request = ServletActionContext.getRequest();
   configuration.setServletContextForTemplateLoading(request.getSession().getServletContext(), “/template”);
   configuration.getTemplate(“framemaker.ftl”); //framemaker.ftl为要装载的模板

参考资料

https://www.jianshu.com/p/20fd71b2e6a0
https://blog.csdn.net/erpenggg/article/details/81216386