Spring Boot使用EasyExcel轻松搞定Excel导入导出

2023-01-06 18:38:54

导入依赖

在开始之前，需确保项目中已包含EasyExcel的相关依赖。对于Maven项目，在pom.xml文件内加入以下依赖：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>2.2.10</version>
</dependency>

创建实体类

以用户数据为例，创建一个与Excel表头映射的Java对象。例如：

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class User {
    
    @ExcelProperty("姓名")
    private String name;
    
    @ExcelProperty("年龄")
    private int age;
}

导入数据

导入操作分为读取文件和处理Excel内容两步。首先，利用EasyExcel的API来读取Excel文件。

示例代码

import com.alibaba.excel.EasyExcel;

public class ImportData {
    
    public void importUser(String fileName) {
        EasyExcel.read(fileName, User.class, new UserListener()).sheet().doRead();
    }
}

// 使用监听器处理读入的数据，可以用于数据库操作等。
class UserListener extends AnalysisEventListener<User> {

    @Override
    public void invoke(User user, AnalysisContext context) {
        // 这里进行数据的处理或保存至数据库
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 所有数据解析完成后的操作，如关闭数据库连接等。
    }
}

导出数据

导出Excel文件需创建一个写入器，并定义文件头信息。

示例代码

import com.alibaba.excel.EasyExcel;

public class ExportData {

    public void exportUser(String fileName, List<User> userList) {
        EasyExcel.write(fileName, User.class).sheet("用户表").doWrite(userList);
    }
}

处理空数据和异常情况

在实际使用过程中，可能遇到空值或Excel格式错误等情况。可以通过EasyExcel提供的校验机制来处理这些问题。

示例代码

import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.write.metadata.WriteSheet;

public void exportUserWithValidation(String fileName, List<User> userList) {
    WriteSheet writeSheet = EasyExcel.writer(fileName).sheet("用户表");
    writeSheet.registerWriteHandler(new EmptyValueStrategy(CellData::isBlank));
    EasyExcel.write(fileName, User.class).registerWriteHandler(writeSheet.getWriteHandlers()).doWrite(userList);
}