一、EasyExcel介绍
1.1 介绍
EasyExcel 是一个基于 Java 的简单易用的 Excel 文件读写工具，它提供了一种简单而又高效的方式来读取、写入和操作 Excel 文件。EasyExcel 是阿里巴巴开源的项目，它旨在简化开发人员处理 Excel 文件的流程，使得操作 Excel 文件变得更加容易和高效。具体介绍和说明可以看官网：EasyExcel官方文档 - 基于Java的Excel处理工具 | Easy Excel
1.2 EasyExcel 特点
① 简单易用：EasyExcel 提供了简洁明了的 API，使得开发人员可以轻松地进行 Excel 文件的读写操作，不需要过多的代码即可完成复杂的 Excel 文件处理任务。
② 高性能：EasyExcel 在设计上充分考虑了性能优化，底层采用了流式读写的方式，能够高效处理大型 Excel 文件，提高处理速度。
③ 支持多种数据格式：EasyExcel 支持读取和写入多种数据格式，包括基本数据类型、集合、对象等，同时支持复杂的表格结构和样式设置。
④ 丰富的功能：EasyExcel 提供了丰富的功能，包括对单元格样式、图表、公式等的支持，可以满足各种复杂的 Excel 文件处理需求。
⑤ 灵活可扩展：EasyExcel 的设计灵活可扩展，可以通过自定义监听器来实现特定的业务逻辑，同时支持插件机制，方便开发人员根据需求进行功能扩展和定制化开发。
二、Java使用EasyExcel
2.1 添加pom依赖
<!-- EasyExcel -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.3.3</version>
</dependency>
<!-- json 转换 -->
<dependency>
<groupId>com.alibaba.fastjson2</groupId>
<artifactId>fastjson2</artifactId>
<version>2.0.29</version>
</dependency>
<!-- lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>2.2 读Excel 数据
- 读取的表格数据
- 读取代码示例
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import java.util.Date;
/**
* 基础数据类
**/
@Getter
@Setter
@EqualsAndHashCode
public class DemoData {
@ExcelProperty("字符串标题")
private String string;
@ExcelProperty("日期标题")
private Date date;
@ExcelProperty("数字标题")
private Double doubleData;
/**
* 忽略这个字段
*/
@ExcelIgnore
private String ignore;
}
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.read.listener.PageReadListener;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.util.ListUtils;
import com.alibaba.fastjson2.JSON;
import com.zhuimengren.easyexcel.entity.DemoData;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import java.util.List;
@Slf4j
public class ReadTest {
/**
* 写法1：JDK8+ ,不用额外写一个DemoDataListener
* since: 3.0.0-beta1
*/
@Test
public void simpleRead1() {
String fileName = "src/main/resources/demo/demo.xlsx";
// 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
// 这里默认每次会读取100条数据 然后返回过来 直接调用使用数据就行
// 具体需要返回多少行可以在`PageReadListener`的构造函数设置
EasyExcel.read(fileName, DemoData.class, new PageReadListener<DemoData>(dataList -> {
for (DemoData demoData : dataList) {
log.info("读取到一条数据{}", JSON.toJSONString(demoData));
}
})).sheet().doRead();
}
/**
* 写法2：
* 匿名内部类 不用额外写一个DemoDataListener
*/
@Test
public void simpleRead2() {
String fileName = "src/main/resources/demo/demo.xlsx";
// 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
EasyExcel.read(fileName, DemoData.class, new ReadListener<DemoData>() {
/**
* 单次缓存的数据量
*/
public static final int BATCH_COUNT = 100;
/**
*临时存储
*/
private List<DemoData> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
@Override
public void invoke(DemoData data, AnalysisContext context) {
cachedDataList.add(data);
if (cachedDataList.size() >= BATCH_COUNT) {
saveData();
// 存储完成清理 list
cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
}
}
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
saveData();
}
/**
* 加上存储数据库
*/
private void saveData() {
for (DemoData demoData : cachedDataList) {
log.info("读取到一条数据{}", JSON.toJSONString(demoData));
}
}
}).sheet().doRead();
}
}
- 执行结果
2.3 写Excel数据
- 写入数据的Excel模版
- 写入代码示例
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import java.util.Date;
/**
* 基础数据类
**/
@Getter
@Setter
@EqualsAndHashCode
public class DemoData {
@ExcelProperty("字符串标题")
private String string;
@ExcelProperty("日期标题")
private Date date;
@ExcelProperty("数字标题")
private Double doubleData;
/**
* 忽略这个字段
*/
@ExcelIgnore
private String ignore;
}
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.util.ListUtils;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.zhuimengren.easyexcel.entity.DemoData;
import org.junit.jupiter.api.Test;
import java.util.Date;
import java.util.List;
public class WriteTest {
/**
* 写法1 JDK8+
* since: 3.0.0-beta1
*/
@Test
public void simpleWrite1() {
// 注意 simpleWrite在数据量不大的情况下可以使用（5000以内，具体也要看实际情况），数据量大参照 重复多次写入
String fileName = "src/main/resources/demo/write-demo.xlsx";
// 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
// 如果这里想使用03 则 传入excelType参数即可
EasyExcel.write(fileName, DemoData.class)
.sheet("模板")
.doWrite(() -> {
// 分页查询数据
return data();
});
}
/**
* 写法2
*/
@Test
public void simpleWrite2() {
String fileName = "src/main/resources/demo/write-demo.xlsx";
// 这里 需要指定写用哪个class去写
try (ExcelWriter excelWriter = EasyExcel.write(fileName, DemoData.class).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
excelWriter.write(data(), writeSheet);
}
}
private List<DemoData> data() {
List<DemoData> list = ListUtils.newArrayList();
for (int i = 0; i < 10; i++) {
DemoData data = new DemoData();
data.setString("字符串" + i);
data.setDate(new Date());
data.setDoubleData(0.56);
list.add(data);
}
return list;
}
}
说明：
上述代码示例是最基础的读和写的demo，复杂操作请看官网示例代码。关于Easyexcel | Easy Excel
