EasyExcel

嚴華 · 2023-6-2 01:06:55

EasyExcel是一个基于Java的、快速、简洁、解决大文件内存溢出的Excel处理工具。
他能让你在不用考虑性能、内存的等因素的情况下，快速完成Excel的读、写等功能。
快速入门

导入依赖

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

复制代码

写 Excel

1.以实体类映射想要写入 Excel 的数据

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ExcelEntity {
@ExcelProperty("字符串标题")
private String string;
@ExcelProperty("日期标题")
private Date date;
@ExcelProperty("数字标题")
private Double doubleData;
@ExcelIgnore
private String ignore;
}

复制代码

注解说明

ExcelProperty：定义排版
- value：字符串标题
- index：指定数据所在列，从0起算
  1. @ExcelProperty(value = "字符串标题", index = 0)
  复制代码
- 复杂头写入
  1. @ExcelProperty({"主标题", "字符串标题"})
  复制代码
DateTimeFormat：定义时间格式
1. @DateTimeFormat("yyyy年MM月dd日HH时mm分ss秒")
2. @ExcelProperty("日期标题")
3. private Date date;
复制代码
NumberFormat：定义数字格式
1. @NumberFormat("#.##%") // 用百分比表示
2. @ExcelProperty(value = "数字标题")
3. private Double doubleData;
复制代码
ColumnWidth：列宽
ContentRowHeight：行高
HeadRowHeight：表头行高（写在类名上）
ContentLoopMerge：合并单元格
1. // 这一列每隔2行合并单元格
2. @ContentLoopMerge(eachRow = 2)
3. @ExcelProperty("字符串标题")
4. private String string;
复制代码
ExcelIgnore：忽略这个字段

2.将数据存储到实体类中

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;
}

复制代码

3.数据写入 Excel

方法1:在数据量不大的情况下可以使用（5000以内，具体也要看实际情况），数据量大参照重复多次写入

@Test
public void simpleWrite() {
// 创建一个文件的绝对路径
String fileName = "D:\\demo1.xlsx";
// write(): 参数一：文件路径参数二：要写的数据对应的实体字节码
// sheet(): excel表格名称
// doWrite(): 要写的数据，是一个集合
EasyExcel.write(fileName, ExcelEntity.class).sheet("模板").doWrite(() -> {
// 分页查询数据
return data();
});
}

复制代码

方法2：

@Test
public void simpleWrite() {
String fileName = "D:\\demo1.xlsx";
// 这里需要指定写用哪个class去写，然后写到第一个sheet，名字为模板然后文件流会自动关闭
// 如果这里想使用03 则传入excelType参数即可
EasyExcel.write(fileName, ExcelEntity.class).sheet("模板").doWrite(data());
}

复制代码

方法3：

@Test
public void simpleWrite3() {
String fileName = "D:\\demo1.xlsx";
// 这里需要指定写用哪个class去写
try (ExcelWriter excelWriter = EasyExcel.write(fileName, ExcelEntity.class).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
excelWriter.write(data(), writeSheet);
}
}

复制代码

4.忽略或指定导出

忽略

// 根据用户传入字段假设我们要忽略 date
Set<String> excludeColumnFiledNames = new HashSet<String>();
excludeColumnFiledNames.add("date");
// 这里需要指定写用哪个class去写，然后写到第一个sheet，名字为模板然后文件流会自动关闭
EasyExcel.write(fileName, ExcelEntity.class).excludeColumnFiledNames(excludeColumnFiledNames).sheet("模板")
.doWrite(data());

复制代码

指定导出

// 根据用户传入字段假设我们只要导出 date
Set<String> includeColumnFiledNames = new HashSet<String>();
includeColumnFiledNames.add("date");
// 这里需要指定写用哪个class去写，然后写到第一个sheet，名字为模板然后文件流会自动关闭
EasyExcel.write(fileName, ExcelEntity.class).includeColumnFiledNames(includeColumnFiledNames).sheet("模板")
.doWrite(data());

复制代码

5.在同一 sheet 续写

@Test
public void repeatedWrite() {
String fileName = "D:\\demo1.xlsx";
// 这里需要指定写用哪个class去写
try (ExcelWriter excelWriter = EasyExcel.write(fileName, ExcelEntity.class).build()) {
// 这里注意如果同一个sheet只要创建一次
WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
// 去调用写入,这里我调用了五次，实际使用时根据数据库分页的总的页数来
for (int i = 0; i < 5; i++) {
// 分页去数据库查询数据这里可以去数据库查询每一页的数据
List<ExcelEntity> data = data();
excelWriter.write(data, writeSheet);
}
}
}

复制代码

6.同一个对象写到不同的sheet

@Test
public void repeatedWrite() {
String fileName = "D:\\demo1.xlsx";
// 这里指定文件
try (ExcelWriter excelWriter = EasyExcel.write(fileName, ExcelEntity.class).build()) {
// 去调用写入,这里我调用了五次，实际使用时根据数据库分页的总的页数来。这里最终会写到5个sheet里面
for (int i = 0; i < 5; i++) {
// 每次都要创建writeSheet 这里注意必须指定sheetNo 而且sheetName必须不一样
WriteSheet writeSheet = EasyExcel.writerSheet(i, "模板" + i).build();
// 分页去数据库查询数据这里可以去数据库查询每一页的数据
List<ExcelEntity> data = data();
excelWriter.write(data, writeSheet);
}
}
}

复制代码

7.不同的对象写到不同的sheet

@Test
public void repeatedWrite() {
String fileName = "D:\\demo1.xlsx";
// 这里指定文件
try (ExcelWriter excelWriter = EasyExcel.write(fileName).build()) {
// 去调用写入,这里我调用了五次，实际使用时根据数据库分页的总的页数来。这里最终会写到5个sheet里面
for (int i = 0; i < 5; i++) {
// 每次都要创建writeSheet 这里注意必须指定sheetNo 而且sheetName必须不一样。这里注意DemoData.class 可以每次都变，我这里为了方便所以用的同一个class
// 实际上可以一直变
WriteSheet writeSheet = EasyExcel.writerSheet(i, "模板" + i).head(ExcelEntity.class).build();
// 分页去数据库查询数据这里可以去数据库查询每一页的数据
List<ExcelEntity> data = data();
excelWriter.write(data, writeSheet);
}
}
}

复制代码

读 Excel

1.以实体类映射想要读取的 Excel 数据

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ExcelEntity {
private String string;
private Date date;
private Double doubleData;
}

复制代码

2.持久层

/**
* 假设这个是你的DAO存储。当然还要这个类让spring管理，当然你不用需要存储，也不需要这个类。
**/
public class ExcelDAO {
public void save(List<ExcelEntity> list) {
// 如果是mybatis,尽量别直接调用多次insert,自己写一个mapper里面新增一个方法batchInsert,所有数据一次性插入
}
}

复制代码

3.监听器

// 有个很重要的点 ExcelEntityListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去
public class ExcelEntityListener implements ReadListener<ExcelEntity> {
/**
* 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收
*/
private static final int BATCH_COUNT = 100;
/**
* 缓存的数据
*/
private List<ExcelEntity> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
/**
* 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
*/
private ExcelDAO excelDAO;
public ExcelEntityListener() {
// 这里是demo，所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
excelDAO = new ExcelDAO();
}
/**
* 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
*
* @param excelDAO
*/
public ExcelEntityListener(ExcelDAO excelDAO) {
this.excelDAO = excelDAO;
}
/**
* 这个每一条数据解析都会来调用
*
* @param data one row value. Is is same as {@link AnalysisContext#readRowHolder()}
* @param context
*/
@Override
public void invoke(ExcelEntity data, AnalysisContext context) {
cachedDataList.add(data);
// 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
if (cachedDataList.size() >= BATCH_COUNT) {
saveData();
// 存储完成清理 list
cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
}
}
/**
* 所有数据解析完成了都会来调用
*
* @param context
*/
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
// 这里也要保存数据，确保最后遗留的数据也存储到数据库
saveData();
}
/**
* 加上存储数据库
*/
private void saveData() {
excelDAO.save(cachedDataList);
}
}

复制代码

4.读取 Excel 数据

@Test
public void simpleRead() {
// 写法1：JDK8+ ,不用额外写一个DemoDataListener
// since: 3.0.0-beta1
String fileName = "D:\\damo1.xlsx";
// 这里默认每次会读取100条数据然后返回过来直接调用使用数据就行
// 具体需要返回多少行可以在`PageReadListener`的构造函数设置
EasyExcel.read(fileName, ExcelEntity.class, new PageReadListener<ExcelEntity>(dataList -> {
for (ExcelEntity demoData : dataList) {
log.info("读取到一条数据{}", JSON.toJSONString(demoData));
}
})).sheet().doRead();
// 写法2：
// 匿名内部类不用额外写一个DemoDataListener
fileName = "D:\\damo1.xlsx";
// 这里需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
EasyExcel.read(fileName, ExcelEntity.class, new ReadListener<ExcelEntity>() {
/**
* 单次缓存的数据量
*/
public static final int BATCH_COUNT = 100;
/**
*临时存储
*/
private List<ExcelEntity> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
@Override
public void invoke(ExcelEntity 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() {
log.info("{}条数据，开始存储数据库！", cachedDataList.size());
log.info("存储数据库成功！");
}
}).sheet().doRead();
// 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去
// 写法3：
fileName = "D:\\damo1.xlsx";
// 这里需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
EasyExcel.read(fileName, ExcelEntity.class, new ExcelEntityListener()).sheet().doRead();
// 写法4
fileName = "D:\\damo1.xlsx";
// 一个文件一个reader
try (ExcelReader excelReader = EasyExcel.read(fileName, ExcelEntity.class, new ExcelEntityListener()).build()) {
// 构建一个sheet 这里可以指定名字或者no
ReadSheet readSheet = EasyExcel.readSheet(0).build();
// 读取一个sheet
excelReader.read(readSheet);
}
}
}

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

		自动登录	找回密码
密码			立即注册

EasyExcel

0 个回复

快速回复

楼主热帖

标签云