SpringBoot使用数据库数据导出Excel文件

SpringBoot使用数据库数据导出Excel文件

在许多应用程序中，将数据库中的数据导出为Excel文件是一项常见的需求。Spring Boot 提供了便捷的方式来实现这一功能，结合Apache POI库可以轻松地生成Excel文件。在本文中，我们将详细介绍如何使用Spring Boot来导出数据库数据到Excel文件。

Maven依赖

首先，我们需要在项目的pom.xml文件中添加所需的Maven依赖项。这些依赖项包括Spring Boot Starter Web用于构建Web应用程序，以及Apache POI用于操作Excel文件。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Apache POI -->
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi</artifactId>
        <version>5.2.4</version> <!-- 根据需要调整版本号 -->
    </dependency>
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml</artifactId>
        <version>5.2.4</version> <!-- 根据需要调整版本号 -->
    </dependency>
</dependencies>

导出流程

1. 定义实体类： 首先，我们需要定义一个实体类来表示数据库中的数据。
2. 编写Service层： 在Service层中编写方法来从数据库中获取数据。
3. 编写Controller层： 在Controller层中编写方法来处理导出Excel文件的请求。
4. 使用Apache POI生成Excel文件： 在Controller层的方法中，使用Apache POI库将数据写入Excel文件并提供下载。

代码示例

实体类定义

假设我们有一个名为User的实体类，表示数据库中的用户数据。

public class User {
    private Long id;
    private String username;
    private String email;

    // 省略getter和setter方法
}

Service层

假设我们有一个UserService，其中有一个方法用于从数据库中获取用户数据。

import java.util.List;

@Service
public class UserService {
    
    // 假设这里注入了一个UserRepository来处理数据库操作
    
    public List<User> getAllUsers() {
        return userRepository.findAll();
    }
}

Controller层

编写一个UserController，其中有一个方法用于处理导出Excel文件的请求。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {
    
    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @GetMapping("/export-excel")
    public void exportExcel(HttpServletResponse response) throws IOException {
        // 设置响应头
        response.setContentType("application/vnd.ms-excel");
        response.setHeader("Content-Disposition", "attachment; filename=users.xlsx");
        
        // 使用Apache POI生成Excel文件
        Workbook workbook = userService.generateExcel();
        
        // 将Excel文件写入响应输出流
        OutputStream outputStream = response.getOutputStream();
        workbook.write(outputStream);
        outputStream.close();
        
        workbook.close();
    }
}

Excel生成方法

在UserService中编写一个方法来生成Excel文件。

import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.springframework.stereotype.Service;

import java.io.IOException;
import java.util.List;

@Service
public class UserService {
    
    // 假设这里注入了一个UserRepository来处理数据库操作
    
    public Workbook generateExcel() {
        List<User> users = userRepository.findAll();
        
        // 创建Excel工作簿
        Workbook workbook = new XSSFWorkbook();
        Sheet sheet = workbook.createSheet("Users");
        
        // 创建标题行
        Row headerRow = sheet.createRow(0);
        headerRow.createCell(0).setCellValue("ID");
        headerRow.createCell(1).setCellValue("Username");
        headerRow.createCell(2).setCellValue("Email");
        
        // 填充数据
        int rowNum = 1;
        for (User user : users) {
            Row row = sheet.createRow(rowNum++);
            row.createCell(0).setCellValue(user.getId());
            row.createCell(1).setCellValue(user.getUsername());
            row.createCell(2).setCellValue(user.getEmail());
        }
        
        return workbook;
    }
}

测试导出

启动Spring Boot应用程序，并访问/export-excel端点，应该会下载名为users.xlsx的Excel文件，其中包含从数据库中获取的用户数据。

结论

在本文中，我们学习了如何使用Spring Boot和Apache POI库来实现将数据库数据导出为Excel文件的功能。通过定义实体类，编写Service和Controller层，以及使用Apache POI库生成Excel文件，我们可以轻松地实现这一功能。