JAVA利用Freemarker模版动态生成并导出Word文档(全网最详细)

一、文章背景

公司的某个需求,需要根据接口的信息生成一份word接口文档信息并支持导出功能。以前没做过这种需求,于是搜罗各种资料,最终发现java利用freemarker模版可以实现这个功能。

二、实现步骤

2.1、需要的环境

<!--springboot父依赖-->
<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
</parent>

<!--springboot启动器依赖-->
<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
</dependency>

<!--freemarker依赖-->
<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

2.2、创建模板

1)展示word文档如下所示:
在这里插入图片描述

2)将word文档动态的参数替换成占位符,如下所示:
在这里插入图片描述

3)word另存为xml格式保存
在这里插入图片描述

4)将xml文件更改为ftl文件
在这里插入图片描述

2.3、书写java类

1)将上一步生成的ftl文件重命名cdsnUser.ftl放到resource目录的templates文件夹下面,并格式化文件
在这里插入图片描述
ps:
1.1)因用户列表是list集合遍历的形式动态展示,所以需要遍历列表标签并展示数据。遍历的语法如下:<#list 集合 as 对象名> </#list>在这里插入图片描述
1.2)注意此处对象别名要和生成word占位符的属性对应上,不然取不到值
1.3)标签是行的意思,遍历的范围要对,不然word打不开或者后台报错

2)新建User类

import lombok.Data;

@Data
public class User {
    private String name;
    private String sex;
    private String iphone;
    private String idcard;
    private String idNum;
}

3)wordUtil工具类

import freemarker.template.Configuration;
import freemarker.template.Template;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.util.Map;

public class WordUtil {
    //配置信息,代码本身写的还是很可读的,就不过多注解了
    private static Configuration configuration = null;
    // 这里注意的是利用WordUtils的类加载器动态获得模板文件的位置

    //private static final String templateFolder = wordUtils.class.getClassLoader().getResource("../../../../templates").getPath();
    private static final String templateFolder = WordUtil.class.getResource("/templates").getPath();

    static {
        configuration = new Configuration();
        configuration.setDefaultEncoding("utf-8");
        try {
            System.out.println(templateFolder);
            configuration.setDirectoryForTemplateLoading(new File(templateFolder));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    private WordUtil() {
        throw new AssertionError();
    }

    /**
     * 导出excel
     * @param request 请求对象
     * @param response 响应对象
     * @param map word文档中参数
     * @param wordName 为模板的名字  例如xxx.ftl
     * @param fileName 是word 文件的名字 格式为:"xxxx.doc"
     * @param name 是临时的文件夹米名称 string类型 可随意定义
     * @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;
    }
}

4)Controller类

import com.example.word_download.dao.InterfaceWord;
import com.example.word_download.dao.Parameter;
import com.example.word_download.dao.User;
import com.example.word_download.util.WordUtil;
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("/testControllerDownload")
public class wordController {
    /**
     * 测试用户列表word的初级
     * @param request
     * @param response
     * @throws IOException
     */
    @GetMapping("/getWord")
    public void getWord(HttpServletRequest request, HttpServletResponse response) throws IOException {
        User user1 = new User();
        user1.setName("lisa");
        user1.setSex("girl");
        user1.setIphone("1243435512434");
        user1.setIdcard("4211821997909021");
        user1.setIdNum("12");
        User user2 = new User();
        user2.setName("tom");
        user2.setSex("boy");
        user2.setIphone("1243435512434");
        user2.setIdcard("4211821997909021");
        user2.setIdNum("12");
        ArrayList<User> users = new ArrayList<>();
        users.add(user1);
        users.add(user2);
        //HashMap<String, List<User>> map1 = new HashMap<>();
        HashMap<String, Object> map = new HashMap<>();
        map.put("users",users);
        map.put("appName","用户信息");

        String wordName = "csdnUser.ftl";  
        String fileName = "interfaceWord.doc";
        String name = "name";

        WordUtil.exportMillCertificateWord(request,response,map,wordName,fileName,name);
    }
}

2.4、测试

1)启动springboot项目后,在浏览器地址栏中输入请求路径,即可生成word文档并下载。
在这里插入图片描述

2)word文档内容如下:
在这里插入图片描述

三、freemarker技术点

3.1、简介

FreeMarker是一款模板引擎: 即一种基于模板和要改变的数据, 并用来生成输出文本(HTML网页、电子邮件、配置文件、源代码等)的通用工具。 它不是面向最终用户的,而是一个Java类库,是一款程序员可以嵌入他们所开发产品的组件。

3.2、常用语法

1、判断语法
<#if condition>
...
<#elseif condition2>
...
<#elseif condition3>
...
<#else>
...
</#if>

=========================ps:if 空值判断===========================
// 当 photoList 不为空时
<#if photoList??>...</#if>

2、遍历语法
<#list empList! as emp> 
    ${emp.name!}
</#list>

3.3、某些标签的意思

<w:tr>:行的标签
<w:tbl>:表格的标签
ps:了解某些特定标签在遍历的时候很方便排错

3.4、常见问题

1)如下,获取值没有进行空值判断,加入空值判断就可以去除,如2中空值语法判断所示。
在这里插入图片描述
2)生成word打不开,是标签或者遍历的位置加入不对,导致word文件异常。
3)模板找不到路径
https://blog.csdn.net/qq_45087487/article/details/129973017

四、其他导出word实现方式

JAVA采用Apache POI动态导出word文档

  • 15
    点赞
  • 82
    收藏
    觉得还不错? 一键收藏
  • 11
    评论
### 回答1: Java导出Word文档可以利用Apache POI和Freemarker模板引擎来实现。 Apache POI是一个用于操作Microsoft Office文档的Java API。它提供了对Word文档的读取、创建和修改的功能。通过使用Apache POI,可以轻松地在Java代码中创建一个空的Word文档,并添加文本、表格、图片等内容。同时,还可以设置文档的样式、格式和布局等,以满足不同的需求。 而Freemarker模板引擎则是用于生成动态文本输出的工具。它基于模板和数据模型,可以将数据动态填充到指定的Word模板中,生成最终的Word文档。使用Freemarker模板引擎可以使文档的生成更加灵活和可扩展,根据不同的数据模型生成不同的文档内容,提高了代码的可维护性和重用性。 要实现导出Word文档的功能,首先需要引入Apache POI和Freemarker的相关依赖库。接下来,创建一个空的Word文档,使用Apache POI的API对文档进行操作,例如添加标题、段落、表格等内容,以及设置样式和格式。然后,结合Freemarker模板引擎,根据自定义的数据模型填充数据到Word模板中,生成最终的Word文档。 通过以上的方法,利用Apache POI和Freemarker模板引擎可以轻松地实现Java导出Word文档的功能。这种方式方便、灵活,适用于需要动态生成Word文档的各种场景,例如报告生成、合同生成等。同时,这两个工具库都有良好的文档和丰富的示例代码,方便开发者进行学习和使用。 ### 回答2: Java 导出 Word 文档利用 Apache POI 和 FreeMarker 模板引擎的基本步骤如下: 1. 首先,确保你的项目已经导入了 Apache POI 和 FreeMarker 的相关依赖。 2. 创建一个 Word 文档模板,可以使用 Microsoft Office 软件创建一个空白文档,并将需要的样式和占位符添加到模板中。占位符可以使用自定义的标记,例如 `${name}`。 3. 在 Java 代码中,使用 Apache POI 创建一个 Word 文档对象 `XWPFDocument`。例如:`XWPFDocument document = new XWPFDocument();`。 4. 使用 FreeMarker 模板引擎加载并解析 Word 文档模板。创建一个 `Configuration` 对象,并设置模板文件的路径或类路径。例如:`Configuration configuration = new Configuration(Configuration.VERSION_2_3_23);`。 5. 根据模板文件路径或类路径加载模板文件。例如:`Template template = configuration.getTemplate("template.docx");`。 6. 创建一个数据模型,将数据填充到模板中。可以使用 `Map` 或自定义的 Java 对象作为数据模型。例如:`Map<String, String> data = new HashMap<>();`,然后将需要填充的数据放入 `data` 中。 7. 使用 FreeMarker 模板引擎的 `process` 方法将数据模型与模板进行合并,生成最终的 Word 文档内容。例如:`StringWriter writer = new StringWriter();`,`template.process(data, writer);`。 8. 将生成Word 文档内容写入到 Apache POI 的 `XWPFDocument` 对象中。可以使用 `OutputStream` 将内容写入到文档对象中。例如:`OutputStream outputStream = new FileOutputStream("output.docx");`,`writer.flush();`,`document.write(outputStream);`,`outputStream.close();`。 9. 最后,记得在使用完毕后关闭相关资源,例如关闭输出流、释放内存等。 以上就是利用 Apache POI 和 FreeMarker 模板引擎导出 Word 文档的基本步骤,通过动态填充数据,可以生成灵活且具有个性化内容的 Word 文档。 ### 回答3: Java导出Word文档可以使用Apache POI和Freemarker模板引擎相结合的方法来实现。Apache POI是一个用于处理Microsoft Office文档的Java库,而Freemarker是一个基于模板的文本生成引擎。 首先,我们需要在项目中引入Apache POI和Freemarker的相关依赖。 然后,我们需要创建一个Word文档的模板文件,模板文件中可以包含一些占位符,用于动态添加数据。比如,我们可以在模板文件中添加一个{{name}}的占位符。 接下来,在Java中,我们可以使用Freemarker来解析模板文件。首先,我们需要创建一个Configuration对象,并指定模板文件的路径。然后,我们可以使用Template类的getTemplate方法来获取模板对象。 接着,我们可以创建一个Map对象,将需要动态添加的数据放入其中。比如,我们可以将姓名(name)放入Map中。 然后,我们可以调用Template类的process方法来解析模板并将数据填充到占位符中。我们可以将解析后的结果保存在一个字符串中。 最后,我们可以使用Apache POI来创建一个新的Word文档。我们可以创建一个XWPFDocument对象,并使用其createParagraph方法来创建段落。然后,我们可以使用XWPFRun对象的setText方法将之前解析后的结果添加到段落中。 最后,我们可以将生成Word文档保存到指定路径。我们可以使用XWPFDocument对象的write方法将文档保存为文件。 综上所述,通过使用Apache POI和Freemarker模板引擎,我们可以方便地导出Word文档。我们只需要创建一个模板文件,使用Freemarker来解析模板并将数据填充到占位符中,然后使用Apache POI来创建新的文档并保存即可。这种方法可以加快开发速度,同时也使得代码结构更加清晰易读。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 11
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值