freemarker 生成word

freemarker 生成word

新公司给了我一个任务，生成word，模板用freemarker，刚好又学了个新东西

1，导freemarker jar包

公司项目没用啥框架，也没用maven 用jar包导入的

maven依赖

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

2，准备好flt后缀模板

2.1 准备word模板

根据需求设置不同的值 ${String}

2.2 另存为xml文件

2.3 修改xml后缀为ftl

3，word生成工具类

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.net.URLEncoder;
import java.util.Map;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import freemarker.template.Configuration;
import freemarker.template.Template;

public class WordUtils {
    //配置信息,代码本身写的还是很可读的,就不过多注解了
    private static Configuration configuration = null;
    //FTL文件所存在的位置
    //这里注意的是利用WordUtils的类加载器动态获得模板文件的位置
    private static final String templateFolder = WordUtils.class.getClassLoader().getResource("").getPath().replaceAll("^(/)|(/WEB-INF/classes/)$", "")+"/print/templete/ftl/";

    static {
        configuration = new Configuration();
        configuration.setDefaultEncoding("utf-8");
        try {
            configuration.setDirectoryForTemplateLoading(new File(templateFolder));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    private WordUtils() {
        throw new AssertionError();
    }

    public static void exportMillCertificateWord(HttpServletRequest request, HttpServletResponse response, Map map,String fileTemplateName) throws IOException {
        Template freemarkerTemplate = configuration.getTemplate(fileTemplateName);
        File file = null;
        InputStream fin = null;
        ServletOutputStream out = null;
        try {
            // 调用工具类的createDoc方法生成Word文档
            file = createDoc(map, freemarkerTemplate);
            fin = new FileInputStream(file);
            request.setCharacterEncoding("utf-8");
            //response.setCharacterEncoding("utf-8");
            response.setContentType("application/msword");
            // 设置浏览器以下载的方式处理该文件名
            String fileName = "续保通知书" + ".doc";

            //String fileName = "材质单"+DateUtils.curDateTimeStr14() + ".doc";

            response.setHeader("Content-Disposition", "attachment;filename=".concat(String.valueOf(URLEncoder.encode(fileName, "UTF-8"))));

            out = response.getOutputStream();
            byte[] buffer = new byte[512];  // 缓冲区
            int bytesToRead = -1;
            // 通过循环将读入的Word文件的内容输出到浏览器中
            while ((bytesToRead = fin.read(buffer)) != -1) {
                out.write(buffer, 0, bytesToRead);
            }
        } finally {
            if (fin != null) fin.close();
            if (out != null) out.close();
            if (file != null) file.delete(); // 删除临时文件
        }
    }

    private static File createDoc(Map<?, ?> dataMap, Template template) {
        String name = "d:/test.doc";
        File f = new File(name);
        Template t = template;
        try {
            // 这个地方不能使用FileWriter因为需要指定编码类型否则生成的Word文档会因为有无法识别的编码而无法打开
            Writer w = new OutputStreamWriter(new FileOutputStream(f), "utf-8");
            t.process(dataMap, w);
            w.close();
        } catch (Exception ex) {
            ex.printStackTrace();
            throw new RuntimeException(ex);
        }
        return f;
    }
}

这个工具了类还待完善，不生成临时文件的前提下，导出word

4，导出word

Map<String, Object> tMap = new HashMap<String, Object>();
tMap.put("name","小白");
tMap.put("age","18");
tMap.put("sex","女");
tMap.put("live","敲代码");
WordUtils.exportMillCertificateWord(request,response,tMap,"freemarker.ftl");
        

success

5，踩过的坑

5.1 生成的word文件打开显示xml数据错误

我碰到到的这个问题是填充的值有特殊字符，如&,< 等

tMap.put("name","小白");
tMap.put("age","18");
tMap.put("sex","女");
tMap.put("live","123&1456");//特殊字符word能生成，但是打不开

解决办法：进行字符串替换

 tMap.put("live","123&1456".replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;"));

5.2 生成的时候报错

这就是要填充的值为null，可以在java代码里处理，也可以在ftl模板上处理

在java操作就不演示了，在ftl处理 把 ${live}修改成${(live)?if_exists}就可以了

6，注意的点

当要填充的值为 数字类型

tMap.put("live",123456);

页面上显示的效果，会进行分割

7，循环操作

List list = new ArrayList();
list.add("1");
list.add("2");
list.add("3");
list.add("4");
list.add("5");
tMap.put("list",list);

在ftl中找到${list}的位置，加入<#list list as list></#list>

导出

success

---

2019-11-29，妈的 ，巨坑，之前用office去操作word生成ftl模板，后面换成wps去操作，去导出操作，图片死活加载不出来，找了半天了，终于找到问题了
wps生成的ftl文件

office生成的ftl文件，两个工具生成的根本不一样。

记录一下，freemarker 导出word wps和office的区别