Java 生产word并下载

原创

mob64ca12d652c7 2024-08-08 14:04:16 ©著作权

文章标签 Word Java spring 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12d652c7的原创作品，请联系作者获取转载授权，否则将追究法律责任

使用Java生成Word文档并下载

在现代软件开发中，生成文档是一个非常常见的需求。尤其是在企业应用中，自动生成报告、发票或其他重要文档，可以节省大量的时间和精力。在这篇文章中，我们将探讨如何使用Java生成Word文档并提供下载功能。

1. 环境准备

要生成Word文档，我们通常使用Apache POI库。Apache POI是一个强大的Java库，可以用来读取和写入Microsoft Office格式的文件，包括Word、Excel和PowerPoint。

1.1 Maven依赖

在项目的pom.xml中添加以下依赖：

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>5.2.3</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml-schemas</artifactId>
    <version>4.1.2</version>
</dependency>
<dependency>
    <groupId>org.apache.xmlbeans</groupId>
    <artifactId>xmlbeans</artifactId>
    <version>5.0.2</version>
</dependency>

1.2 创建基础项目

创建一个简单的Spring Boot项目或者Java控制台程序。为了方便起见，我们将使用Spring Boot框架来处理HTTP请求。

2. 程序核心逻辑

2.1 生成Word文档

以下是生成Word文档的代码示例。我们将创建一个简单的Word文档，里面包含一些文本。

import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;

import java.io.FileOutputStream;
import java.io.IOException;

public class WordGenerator {
    public void createWord(String filePath) {
        try (XWPFDocument document = new XWPFDocument()) {
            XWPFParagraph paragraph = document.createParagraph();
            XWPFRun run = paragraph.createRun();
            run.setText("Hello, this is a word document generated by Java!");
            run.setBold(true);
            run.setFontSize(20);
            try (FileOutputStream out = new FileOutputStream(filePath)) {
                document.write(out);
            }
            System.out.println("Word document created successfully at " + filePath);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

2.2 提供下载接口

为了将生成的Word文档提供下载功能，我们可以在Spring Boot中创建一个REST控制器。

import org.springframework.core.io.FileSystemResource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.File;

@RestController
public class WordController {

    @GetMapping("/download/word")
    public ResponseEntity<FileSystemResource> downloadWord() {
        String filePath = "generated-document.docx";
        
        WordGenerator wordGenerator = new WordGenerator();
        wordGenerator.createWord(filePath);
        
        File file = new File(filePath);
        
        if (!file.exists()) {
            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
        }

        HttpHeaders headers = new HttpHeaders();
        headers.add("Content-Disposition", "attachment; filename=" + file.getName());
        
        return new ResponseEntity<>(new FileSystemResource(file), headers, HttpStatus.OK);
    }
}

2.3 启动和测试

确保你的Spring Boot应用程序已启动。然后，可以通过浏览器或者API客户端（如Postman）访问http://localhost:8080/download/word来触发下载。

3. 代码流程图

为了更好地理解上面的代码流程，以下是一个简单的关系图，描述了Word生成和下载的过程：

erDiagram
    WordController {
        +createWord()
        +downloadWord()
    }

    WordGenerator {
        +createWord(filePath: String)
    }

    WordController -- WordGenerator : "uses"

在这个图中，WordController负责处理HTTP请求并调用WordGenerator来生成Word文档。