springboot基础(78):Freemarker模板生成word文档

前言

利用Freemarker模板生成word文档。示例，将左侧的模板生成为右侧的文档并下载。

如何使用Freemakrer生成word文档

1. 制作模板

1.编辑一份addr.docx文档

2. 另存为addr.xml文档

3. 打开addr.xml文件，修改内容，由于table表格，需要遍历list集合，需要添加

<#list users as user>
表格内容
#list>

4. 将addr.xml后缀更改为addr.ftl文件，存放到resources/templates下
   

2. 编写工具类

package com.example.demo01.util;

import freemarker.template.Configuration;
import freemarker.template.Template;
import lombok.extern.slf4j.Slf4j;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.util.Map;

/**
 * word导出工具
 */
@Slf4j
public class WordUtils {
    private static Configuration configuration = null;//配置

    private static  String templateFolder;

    static {
        templateFolder = WordUtils.class.getResource("/templates").getPath();
        configuration = new Configuration();
        configuration.setDefaultEncoding("utf-8");
        try {
            log.info("模板配置路径:" + templateFolder);
            configuration.setDirectoryForTemplateLoading(new File(templateFolder));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

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

    /**
     * 导出word
     *
     * @param request
     * @param response
     * @param map      参数
     * @param wordName 模板名，示例xxx.ftl
     * @param fileName 要到处的word文件名称,示例:test.doc
     * @param name     临时文件名
     * @throws IOException
     */
    public static void exportMillCertificateWord(HttpServletRequest request, HttpServletResponse response, Map map, String wordName, String fileName, String name) throws IOException {
        Template freemarkerTemplate = configuration.getTemplate(wordName);
        File file = null;
        InputStream fin = null;
        ServletOutputStream out = null;
        try {
            // 调用createDoc方法生成Word文档
            file = createDoc(map, freemarkerTemplate, name);
            fin = new FileInputStream(file);
            response.setCharacterEncoding("utf-8");
            response.setContentType("application/x-download");
            fileName = new String(fileName.getBytes(), "ISO-8859-1");
            response.setHeader("Content-Disposition", "attachment;filename=".concat(String.valueOf(fileName)));
            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) {
        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;
    }
}

package com.example.demo01.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

    private String name;

    private String dept;

    private String phone;

    private String addr;
}

2. 编写controller 下载

package com.example.demo01.controller;

import com.example.demo01.model.User;
import com.example.demo01.util.WordUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@RestController
@RequestMapping("/word")
public class WordController {

    @GetMapping("/downloadWord")
    public void downloadWord(HttpServletRequest request, HttpServletResponse response) throws IOException {
        List<User> list = new ArrayList<>();
        list.add(new User("王小鱼", "三(1)班", "1380000000", "北京市朝阳区幸福小区101号"));
        list.add(new User("李一一", "三(3)班", "1360000000", "北京市朝阳区汤臣一品61号"));

        Map<String, Object> map = new HashMap<>();
        map.put("users", list);
        map.put("date", "2023年1月2日");
        map.put("company", "保护伞公司");

        String wordName = "addr.ftl";
        String fileName = "通讯录11.doc";
        String name = "test";
        WordUtils.exportMillCertificateWord(request, response, map, wordName, fileName, name);
    }
}

3. 启动服务器，访问下载路径 http://localhost:8080/word/downloadWord
   
   

遇到的问题

下载失败

请检查模板是否正确，并且保证所有的参数必须存在。

如何只生成文件不下载

只要在createDoc后，将file保存下来即可。

<dependency>
            <groupId>commons-iogroupId>
            <artifactId>commons-ioartifactId>
            <version>2.13.0version>
        dependency>

    file = createDoc(map, freemarkerTemplate, name);
    File targetFile =  new File("D:\\test\\1.doc");
    FileUtils.copyFile(file, targetFile);//复制文件到指定目录