当前位置：首页 > article >正文

【使用EasyExcel快速实现数据下载到Excel功能】

article 2025/1/17 20:49:05

使用EasyExcel快速实现数据下载到Excel功能

EasyExcel官方文档

1. 引言

在Web应用开发中，数据导出为Excel文件是一个常见的需求。本文将介绍如何使用EasyExcel库快速实现数据的下载功能。我们将通过一个具体的例子来展示如何设置响应头、获取数据并将其写入Excel文件。

2. 添加依赖

首先，在项目的pom.xml文件中添加EasyExcel的最新版本依赖：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>最新版本</version>
</dependency>

3. 数据模型类

确保有一个与Excel数据结构匹配的数据模型类，例如ExcelData。这个类应该包含所有需要导出到Excel的字段，并且可以通过@ExcelProperty("列名")等注解进行字段映射（如果需要），@ExcelIgnore 可以忽略不想展示的字段。

@Data
public class ExcelData{
    @ExcelProperty("列名")  //设置在excel中的列名
    private String field1;
    @ExcelIgnore   //不展示该字段
    private String field2;
    // 其他字段...
}

4. 设置响应头

为了确保浏览器能够正确识别并处理下载请求，我们需要设置HTTP响应头。以下代码展示了如何设置响应头以生成一个Excel文件：

public void setResHeader(String name, HttpServletResponse res) {
    StringBuffer value = new StringBuffer();
    value.append(name);
    Calendar now = Calendar.getInstance();
    SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMddHHmmss");
    String formatDate = sdf.format(now.getTime());
    value.append(formatDate);
    String fileName = value.toString();
    
    try {
        // 处理文件名编码问题
        fileName = new String(fileName.getBytes("gb2312"), "ISO-8859-1");
        
        res.reset();
        String charsetStr = "UTF-8";
        res.setContentType("application/vnd.ms-excel;charset=" + charsetStr);
        res.setHeader("Content-Disposition", "attachment;filename=" + fileName + ".xlsx");
    } catch (UnsupportedEncodingException e1) {
        e1.printStackTrace();
    } catch (Exception ex) {
        ex.printStackTrace();
    }
}

5. 实现下载接口

接下来，我们定义一个下载接口，该接口会调用上述方法设置响应头，并使用EasyExcel将数据写入Excel文件：

@GetMapping("/download/excel")
public void download(HttpServletResponse response) throws IOException {
    setResHeader("fileName", response);
    
    // 获取数据
    List<Data> dataList= excelService.getExcelData();
    
    // 写入Excel文件
    EasyExcel.write(response.getOutputStream(), FacebookAdExcelData.class)
            .excelType(ExcelTypeEnum.XLSX)
            .sheet("sheet1")
            .doWrite(dataList);
}