当前位置：首页 > news >正文

【Java】使用FreeMarker来实现Word自定义导出

news 2025/8/5 15:33:32

前言

在对一些特定导出功能，使用常规Excel无法解决的，通常使用Word来实现导出功能，这篇介绍下如何在Java中使用FreeMarker模板注入方式来实现Word导出功能

导出案例（已作打码处理）

在这里插入图片描述
或者：

准备工作

第一步：maven依赖库

		<!-- freemarker (用于Word导出)--><dependency><groupId>org.freemarker</groupId><artifactId>freemarker</artifactId><version>${freemarker.version}</version></dependency>

第二步：Word导出工具类


import com.zrxt.common.config.RuoYiConfig;
import com.zrxt.common.core.text.CharsetKit;
import freemarker.cache.ClassTemplateLoader;
import freemarker.template.Configuration;
import freemarker.template.Template;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;/*** @ClassName WordUtil* @Description 使用Freemarker生成Word文档工具类* @Author* @Date 2023/12/14**/
public class WordUtil {/*** 使用Freemarker自动生成Word文档（磁盘路径方法）** @param dataMap      保存Word文档中所需要的数据* @param templatePath 模板文件的绝对路径* @param templateFile 模板文件的名称* @throws Exception*/public static void CreateWord(HttpServletResponse response, Map<String, Object> dataMap, String templatePath, String templateFile) throws Exception {Writer out = null;try {// 设置FreeMarker的版本Configuration configuration = new Configuration(Configuration.DEFAULT_INCOMPATIBLE_IMPROVEMENTS);// 设置Freemarker的编码格式configuration.setDefaultEncoding(CharsetKit.UTF_8);// 设置FreeMarker生成Word文档所需要的模板的路径configuration.setDirectoryForTemplateLoading(new File(templatePath));// 设置FreeMarker生成Word文档所需要的模板名称Template t = configuration.getTemplate(templateFile, CharsetKit.UTF_8);// 创建一个Word文档的输出流out = new BufferedWriter(new OutputStreamWriter(response.getOutputStream(), StandardCharsets.UTF_8));//FreeMarker使用Word模板和数据生成Word文档t.process(dataMap, out);}catch (Exception e){e.printStackTrace();}finally {assert out != null;out.flush();out.close();}}/*** 使用Freemarker自动生成Word文档** @param dataMap      保存Word文档中所需要的数据* @param templatePath 模板文件的路径（绝对）* @param templateFile 模板文件的名称* @throws Exception*/public static void GeneratorWord(HttpServletResponse response, Map<String, Object> dataMap, String templatePath, String templateFile) throws Exception {Writer out = null;try {// 设置FreeMarker的版本Configuration configuration = new Configuration(Configuration.VERSION_2_3_28);// 设置Freemarker的编码格式configuration.setDefaultEncoding(CharsetKit.UTF_8);//相对路径加载模板方法configuration.setTemplateLoader(new ClassTemplateLoader(WordUtil.class,templatePath));// 设置FreeMarker生成Word文档所需要的模板名称Template template  = configuration.getTemplate(templateFile, CharsetKit.UTF_8);// 创建一个Word文档的输出流out = new BufferedWriter(new OutputStreamWriter(response.getOutputStream(), StandardCharsets.UTF_8));//FreeMarker使用Word模板和数据生成Word文档template .process(dataMap, out);}catch (Exception e){e.printStackTrace();}finally {assert out != null;out.flush();out.close();}}/*** 下载文件** @param path     文件的位置* @param fileName 自定义下载文件的名称* @param response http响应* @param request  http请求*/public static void downloadFile(String path, String fileName, HttpServletResponse response, HttpServletRequest request) {try {File file = new File(path);// 中文乱码解决String type = request.getHeader("User-Agent").toLowerCase();if (type.indexOf("firefox") > 0 || type.indexOf("chrome") > 0) {// 谷歌或火狐fileName = new String(fileName.getBytes(StandardCharsets.UTF_8), "iso8859-1");} else {// IEfileName = URLEncoder.encode(fileName, CharsetKit.UTF_8);}// 设置响应的头部信息response.setHeader("content-disposition", "attachment;filename=" + fileName);// 设置响应内容的类型response.setContentType(getFileContentType(fileName) + "; charset=" + CharsetKit.UTF_8);// 设置响应内容的长度response.setContentLength((int) file.length());// 输出outStream(new FileInputStream(file), response.getOutputStream());} catch (Exception e) {e.printStackTrace();}}/*** 文件的内容类型*/private static String getFileContentType(String name) {String result = "";String fileType = name.toLowerCase();if (fileType.endsWith(".png")) {result = "image/png";} else if (fileType.endsWith(".gif")) {result = "image/gif";} else if (fileType.endsWith(".jpg") || fileType.endsWith(".jpeg")) {result = "image/jpeg";} else if (fileType.endsWith(".svg")) {result = "image/svg+xml";} else if (fileType.endsWith(".doc")) {result = "application/msword";} else if (fileType.endsWith(".xls")) {result = "application/x-excel";} else if (fileType.endsWith(".zip")) {result = "application/zip";} else if (fileType.endsWith(".pdf")) {result = "application/pdf";} else {result = "application/octet-stream";}return result;}/*** 基础字节数组输出*/private static void outStream(InputStream is, OutputStream os) {try {byte[] buffer = new byte[10240];int length = -1;while ((length = is.read(buffer)) != -1) {os.write(buffer, 0, length);os.flush();}} catch (Exception e) {e.printStackTrace();} finally {try {os.close();is.close();} catch (IOException e) {e.printStackTrace();}}}/*** 检查存储生成文件的路径是否存在，如果不存在则新建路径.** @param directory the directory name, like '\dir-name'*/public static void CheckDownloadPath(String directory) {File path = new File(RuoYiConfig.getDownloadPath() + directory);if (!path.exists()) {path.mkdirs();}}
}

模板准备

第一步：首先要编写Word模板，可以参考文章开头的示例图片。
第二步：Word模板编写好后，点击另存为，然后选择Word 2003 XML文档
在这里插入图片描述
第三步：保存好后的文件打开，Ctrl+A复制文档所有内容，然后在线搜索XML格式化在线工具，我这边提供一个现成的XML格式化在线工具，将内容全部粘贴进去后点击格式化按钮。

创建ftl文件

上面所有工作准备好后，就可以在resource目录下创建一个.ftl文件，然后将格式化后的代码复制到文件中即可。
在这里插入图片描述

测试导出是否完整

在Controller层编写测试代码，判断是否可以正常导出

    /*** 导出(word)关键过程控制详细信息详细信息(xml版本)*/@PostMapping(value = "/exportWord")public void getInfo(MakeCriticalProcessControl param, HttpServletResponse response) {try {MakeCriticalProcessControl obj=makeCriticalProcessControlService.selectById(param.getId());Map<String, Object> context = new HashMap<>();context.put("obj", obj);WordUtil.GeneratorWord(response, context, "/wordDocumentFtl/make/", "MakeCriticalProcessControl.ftl");} catch (Exception e) {e.printStackTrace();throw new ServiceException("导出Word文件失败，请稍后重试！");}}