当前位置: article > 正文

Spring Boot + FreeMarker 实现按模板导出 Word 文档_springboot页面实现word导出功能

作者：爱喝兽奶帝天荒 | 2024-07-19 20:39:06

踩

springboot页面实现word导出功能

SpringBoot是一个简化新Spring应用的初始搭建以及开发过程的框架，而FreeMarker是一个基于模板引擎的Java库，可以用来生成HTML网页、配置文件、电子邮件以及各种格式的文本文档。在这篇文章中，我们将结合使用SpringBoot和FreeMarker来生成和导出Word文档。

项目设置

首先，我们需要创建一个SpringBoot项目，并添加必要的依赖。我们使用 Maven作为构建工具。

Maven 依赖

在pom.xml文件中添加以下依赖：


 
<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    
    <!-- FreeMarker -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-freemarker</artifactId>
    </dependency>
    
    <!-- Apache POI for Word document creation -->
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml</artifactId>
        <version>5.0.0</version>
    </dependency>
</dependencies>

创建 FreeMarker 模板

接下来，我们需要创建一个FreeMarker模板文件。假设我们要生成一份简单的报告，模板文件report.ftl可以如下所示：


 
<#-- report.ftl -->
<html>
<head>
    <title>${title}</title>
</head>
<body>
    <h1>${title}</h1>
    <p>${content}</p>
</body>
</html>

将该模板文件放在src/main/resources/templates目录下。

实现导出功能

在这一步，我们将创建一个控制器来处理导出请求，并生成Word文档。

创建控制器


 
package com.example.demo.controller;
 
import freemarker.template.Configuration;
import freemarker.template.Template;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
 
import javax.servlet.http.HttpServletResponse;
import java.io.ByteArrayOutputStream;
import java.io.OutputStreamWriter;
import java.util.HashMap;
import java.util.Map;
 
@RestController
public class ExportController {
 
    @Autowired
    private Configuration freemarkerConfig;
 
    @GetMapping("/export")
    public void exportWord(HttpServletResponse response) throws Exception {
        // 设置 FreeMarker 模板参数
        Map<String, Object> dataModel = new HashMap<>();
        dataModel.put("title", "报告标题");
        dataModel.put("content", "这是报告的内容。");
 
        // 获取 FreeMarker 模板
        Template template = freemarkerConfig.getTemplate("report.ftl");
 
        // 将模板数据输出到字符串
        ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
        try (OutputStreamWriter outputStreamWriter = new OutputStreamWriter(byteArrayOutputStream)) {
            template.process(dataModel, outputStreamWriter);
        }
 
        // 创建 Word 文档
        XWPFDocument document = new XWPFDocument();
        XWPFParagraph paragraph = document.createParagraph();
        XWPFRun run = paragraph.createRun();
        run.setText(byteArrayOutputStream.toString());
 
        // 设置响应头
        response.setContentType("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
        response.setHeader("Content-Disposition", "attachment; filename=report.docx");
 
        // 将 Word 文档写入响应输出流
        document.write(response.getOutputStream());
        response.getOutputStream().flush();
        document.close();
    }
}

配置 FreeMarker

在src/main/resources目录下创建application.properties文件，添加以下配置：


spring.freemarker.template-loader-path=classpath:/templates
spring.freemarker.default-encoding=UTF-8

运行与测试

启动SpringBoot应用，并在浏览器中访问http://localhost:8080/export，浏览器将下载生成的Word文档。

总结

本文介绍了如何使用SpringBoot和FreeMarker实现按模板导出Word文档。通过这种方式，我们可以轻松地生成复杂的文档内容，并导出为用户友好的 Word 格式。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/爱喝兽奶帝天荒/article/detail/853397