java 生成xls 并提供下载url

原创

mob64ca12e4972a 2024-08-30 09:28:58 ©著作权

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

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

Java生成XLS并提供下载URL的指导

引言

在现代应用程序中，生成并下载Excel文件是一项常见需求。本文将引导刚入行的小白如何使用Java实现生成XLS文件，并提供下载的URL。

整体流程

我们可以将整个任务分成以下五个步骤：

流程步骤	描述
1. 创建Maven项目	设置项目的基本结构和pom.xml
2. 添加依赖	导入Apache POI库来处理Excel文件
3. 编写生成Excel代码	实现生成Excel文件的逻辑
4. 提供下载URL	创建一个接口用于下载生成的Excel文件
5. 测试与运行	启动项目进行测试

流程图

以下是整个流程的可视化表示：

flowchart TD
    A[创建Maven项目] --> B[添加依赖]
    B --> C[编写生成Excel代码]
    C --> D[提供下载URL]
    D --> E[测试与运行]

详细步骤

1. 创建Maven项目

使用IDE（如IntelliJ IDEA或Eclipse）创建一个新的Maven项目。确保你的pom.xml文件放在项目的根目录。

2. 添加依赖

在pom.xml文件中添加Apache POI的依赖，这样我们可以生成和操作Excel文件。以下是需要添加的部分：

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>5.2.3</version> <!-- 请根据需要调整版本 -->
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>5.2.3</version>
</dependency>

3. 编写生成Excel代码

创建一个Java类用来生成Excel文件，例如ExcelGenerator.java。以下是生成Excel文件的示例代码：

import org.apache.poi.hssf.usermodel.HSSFWorkbook; // HSSFWorkbook用于创建.xls文件
import org.apache.poi.ss.usermodel.Cell; // 单元格
import org.apache.poi.ss.usermodel.Row; // 行
import org.apache.poi.ss.usermodel.Sheet; // 工作表
import java.io.FileOutputStream; // 文件输出流
import java.io.IOException; // IO异常

public class ExcelGenerator {

    public void generateExcel(String filePath) {
        // 创建一个工作簿
        HSSFWorkbook workbook = new HSSFWorkbook();
        // 创建一个工作表
        Sheet sheet = workbook.createSheet("Sample Sheet");

        // 创建一行
        Row row = sheet.createRow(0);
        // 在行中创建单元格并设置值
        Cell cell = row.createCell(0);
        cell.setCellValue("Hello, Excel!");

        try (FileOutputStream outputStream = new FileOutputStream(filePath)) {
            // 将工作簿写入输出流
            workbook.write(outputStream);
            System.out.println("Excel文件已生成: " + filePath);
        } catch (IOException e) {
            e.printStackTrace(); // 打印异常信息
        } finally {
            try {
                workbook.close(); // 关闭工作簿
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

4. 提供下载URL

接下来，我们需要提供一个接口来下载生成的Excel文件。我们将使用Spring Boot创建一个控制器，例如ExcelController.java：

import org.springframework.web.bind.annotation.GetMapping; // 处理GET请求
import org.springframework.web.bind.annotation.RestController; // REST控制器
import org.springframework.core.io.FileSystemResource; // 文件系统资源
import org.springframework.http.ResponseEntity; // 响应实体
import org.springframework.http.HttpHeaders; // HTTP头

@RestController
public class ExcelController {

    @GetMapping("/download")
    public ResponseEntity<FileSystemResource> downloadExcel() {
        String filePath = "path/to/your/excel-file.xls"; // XLS文件路径
        ExcelGenerator generator = new ExcelGenerator();
        generator.generateExcel(filePath); // 生成Excel文件

        FileSystemResource file = new FileSystemResource(filePath);
        HttpHeaders headers = new HttpHeaders();
        headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=excel-file.xls");

        return ResponseEntity.ok()
                .headers(headers)
                .body(file); // 返回文件以供下载
    }
}

5. 测试与运行

启动Spring Boot应用程序，并在浏览器中访问http://localhost:8080/download。你应该能看到生成的Excel文件可供下载。

类图

以下是代码结构的类图，展示了Excel生成器和控制器之间的关系。

classDiagram
    class ExcelGenerator {
        +generateExcel(filePath: String)
    }
    class ExcelController {
        +downloadExcel(): ResponseEntity<FileSystemResource>
    }
    
    ExcelController --> ExcelGenerator : 使用