ARTICLE DETAIL

建站实战干货

来自一线的建站与推广经验沉淀,每一条都经过真实交付验证。

EasyExcel导入到spring项目中

2026/9/23 23:42:26 拓冰建站 浏览量
EasyExcel导入到spring项目中

可以直接用EasyExcel来导入表格

读取模式

当使用 EasyExcel 处理 Excel 文件时,我们通常面临两种读取对象的方式:确定表头和不确定表头。此外,EasyExcel 提供了两种读取模式:监听器和同步读。

读取对象的方式

1. 确定表头
  • 方式: 建立对象,与 Excel 表头形成映射关系。
  • 优势: 类型安全,通过对象的属性与表头字段建立直观的映射。
  • 使用场景: 适用于已知 Excel 表头且具有确定结构的情况。
2. 不确定表头
  • 方式: 每一行数据映射为 Map<String, Object>
  • 优势: 适用于表头不确定或动态变化的情况,对于不同结构的 Excel 文件也能够处理。
  • 使用场景: Excel 表头可能发生变化,或者需要一套通用的处理逻辑。

读取模式

1. 监听器模式
  • 特点:

    • 先创建监听器,在读取文件时将监听器绑定。
    • 单独抽离处理逻辑,代码清晰易于维护。
    • 逐行处理,适用于大规模数据的场景。
  • 使用场景: 处理大量数据,逻辑处理比较复杂的情况。

2. 同步读模式
  • 特点:

    • 无需创建监听器,一次性获取完整数据。
    • 方便简单,但在数据量大时可能会有等待时长,甚至可能引发内存溢出。
  • 使用场景: 数据量较小或者对于一次性获取所有数据有要求的情况。

补充说明

  • EasyExcel 提供了对不同读取对象方式和读取模式的支持,可以根据实际需求选择合适的方式。
  • 在确定表头时,使用对象方式更为直观和类型安全。在不确定表头时,使用 Map 方式更为灵活。
  • 监听器模式适用于大规模数据的处理,能够在读取过程中逐行处理,减少内存占用。
  • 同步读模式适用于数据量相对较小,且一次性获取全部数据的场景,代码较为简单。

具体步骤

导入pom

<!-- https://mvnrepository.com/artifact/com.alibaba/easyexcel -->  
<dependency>  <groupId>com.alibaba</groupId>  <artifactId>easyexcel</artifactId>  <version>3.2.1</version>  
</dependency>

新建excel对象

package com.castle.usercenter.easyExcel;import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;/*** 用户信息*/
@Data
public class TableUserExcel {/*** id*/@ExcelProperty("编号")private String id;/*** 用户昵称*/@ExcelProperty("昵称")private String username;
}

建立监听器

监听器可以一行行的解析数据

package com.castle.usercenter.easyExcel;import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.read.listener.ReadListener;
import lombok.extern.slf4j.Slf4j;// 有个很重要的点 DemoDataListener 不能被spring管理,要每次读取excel都要new,然后里面用到spring可以构造方法传进去
@Slf4j
public class DataListener implements ReadListener<TableUserExcel> {/*** 这个每一条数据解析都会来调用** @param data* @param context*/@Overridepublic void invoke(TableUserExcel data, AnalysisContext context) {System.out.println("导入成功");}/*** 所有数据解析完成了 都会来调用** @param context*/@Overridepublic void doAfterAllAnalysed(AnalysisContext context) {log.info("所有数据解析完成!");}
}

读取数据

package com.castle.usercenter.easyExcel;import com.alibaba.excel.EasyExcel;import java.util.List;/*** 读取Excel*/
public class ImportExcel {public static void main(String[] args) {// 写法1:JDK8+ ,不用额外写一个DemoDataListener// since: 3.0.0-beta1String fileName = "E:\\project\\partner\\partner-backend\\user-center-backend-master\\src\\main\\resources\\userInfo.xls";synchronousRead(fileName);}/*** 监听器读取*/public static void readByListener(String fileName) {// 这里 需要指定读用哪个class去读,然后读取第一个sheet 文件流会自动关闭// 这里每次会读取100条数据 然后返回过来 直接调用使用数据就行EasyExcel.read(fileName, TableUserExcel.class, new DataListener()).sheet().doRead();}/*** 同步读*/public static void synchronousRead(String fileName) {// 这里 需要指定读用哪个class去读,然后读取第一个sheet 同步读取会自动finishList<TableUserExcel> list = EasyExcel.read(fileName).head(TableUserExcel.class).sheet().doReadSync();for (TableUserExcel e : list) {System.out.println(e);}}
}