【Java】EasyExcel使用方法

文章目录

• 一、 EasyExcel概述
• 二、 EasyExcel核心类简述
• • 2.1 `EasyExcel`
  • 2.2 `ExcelReaderBuilder`与`ExcelWriterBuilder`
  • • 2.2.1 `ExcelReaderBuilder`
    • 2.2.2 `ExcelWriterBuilder`
  • 2.3 `ExcelReaderSheetBuilder`与`ExcelWriterSheetBuilder`
  • • 2.3.1 `ExcelReaderSheetBuilder`
    • 2.3.2 `ExcelWriterSheetBuilder`
  • 2.4 `ExcelReader`与`ExcelWriter`
  • • 2.4.1 `ExcelReader`
    • 2.4.2 `ExcelWriter`
• 三、示例
• • 3.1 读
  • • 3.1.1 简单读取数据
    • 3.1.2 读取单元格的额外属性（超链接、批注、合并单元格信息）
    • 3.1.3 读取文件中的异常处理
    • 3.1.4 返回读取数据
  • 3.2 写
  • • 3.2.1 原数据输出
    • 3.2.2 指定字段输出
    • 3.2.3 格式化数据输出
    • 3.2.4 设置单元格样式、超链接、备注、公式
    • 3.2.5 合并单元格
    • 3.2.6 使用table输出
  • 3.3 填充
  • • 3.3.1 简单填充
    • 3.3.2 填充列表
    • 3.3.3 复杂填充

一、 EasyExcel概述

Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压缩以及解压后存储都是在内存中完成的，内存消耗依然很大。easyexcel重写了poi对07版Excel的解析，一个3M的excel用POI sax解析依然需要100M左右内存，改用easyexcel可以降低到几M，并且再大的excel也不会出现内存溢出；03版依赖POI的sax模式，在上层做了模型转换的封装，让使用者更加简单方便。

二、 EasyExcel核心类简述 2.1 EasyExcel

EasyExcel继承自EasyExcelFactory工厂类，是EasyExcel的入口类，用于构建读和写的方法，通过不同的参数可以实现不同方式读写文件。EasyFactory用于实现具体的方法。

调用EasyExcel类的静态方法read()，通过传入不同的参数实现不同方式读取数据，较为常用的是read(String pathName, Class head, ReadListener readListener)方法，参数pathName为要读取文件的文件路径，参数head为参照该实体类读取数据，参数readListener为在读取数据时所执行的监听器。返回值为ExcelReaderBuilder类。

其他读取Excel的方法：

方法	参数	返回值
read()		ExcelReaderBuilder
read(File file)	file 待读取文件	ExcelReaderBuilder
read(File file, ReadListener readListener)	file 待读取文件 readListener 监听器	ExcelReaderBuilder
read(File file, Class head, ReadListener readListener)	file 读取文件 head 按照实体类读取数据 readListener 监听器	ExcelReaderBuilder
read(String pathName)	pathName 待读取文件路径	ExcelReaderBuilder
read(String pathName, ReadListener readListener)	pathName 待读取文件路径 readListener 监听器	ExcelReaderBuilder
read(String pathName, Class head, ReadListener readListener)	pathName 待读取文件路径 head 按照实体类读取数据 readListener 监听器	ExcelReaderBuilder
read(InputStream inputStream)	inputStream 待读取文件文件流	ExcelReaderBuilder
read(InputStream inputStream, ReadListener readListener)	inputStream 待读取文件文件流 readListener 监听器	ExcelReaderBuilder
read(InputStream inputStream, Class head, ReadListener readListener)	inputStream 待读取文件文件流 head 按照实体类读取数据 readListener 监听器	ExcelReaderBuilder

---

调用EasyExcel类的静态方法write()，通过传入不同的参数实现不同方式读取数据，较为常用的是write(String pathName, Class head)方法，参数pathName为要读取文件的文件路径，参数head为参考该实体类导出数据。返回值为ExcelWriterBuilder类。

其他写Excel方法：

方法	参数	返回值
write()		ExcelWriterBuilder
write(File file)	file 待输出文件	ExcelWriterBuilder
write(File file, Class head)	file 待输出文件 head 按照实体类输出数据	ExcelWriterBuilder
write(String pathName)	pathName 待输出文件路径	ExcelWriterBuilder
write(String pathName, Class head)	pathName 待输出文件路径 head 按照实体类输出数据	ExcelWriterBuilder
write(OutputStream outputStream)	inputStream 待输出文件文件流	ExcelWriterBuilder
write(OutputStream outputStream, Class head)	inputStream 待输出文件文件流 head 按照实体类输出数据	ExcelWriterBuilder

ExcelReaderBuilder提供读取Excel文件数据的读取方式以及一些工作簿属性的设置。

2.2 ExcelReaderBuilder与ExcelWriterBuilder

ExcelReaderBuilder与ExcelWriterBuilder用于创建ReadWorkbook与WriteWorkbook，可以理解为用于构建Excel的文件。

2.2.1 ExcelReaderBuilder

• 设置ReadWorkbook属性

方法	参数	返回值	描述
ExcelReaderBuilder()	/	/	ExcelReaderBuilder类的构造方法，同时创建ReadWorkbook的实体类
excelType(ExcelTypeEnum excelType)	excelType Excel类型(枚举类型)	ExcelReaderBuilder	设置Excel的文件类型，明确读取的是xls、xlsx还是cvs文件
autoCloseStream(Boolean autoCloseStream)	autoCloseStream 是否自动关闭流(布尔类型)	ExcelReaderBuilder	设置读取完毕后是否自动关闭流，默认为自动关闭
ignoreEmptyRow(Boolean ignoreEmptyRow)	ignoreEmptyRow 是否忽略空行(布尔类型)	ExcelReaderBuilder	设置是否忽略空行，默认自动忽略
extraRead(CellExtraTypeEnum extraType)	extraType 单元格属性类型(枚举类型)	ExcelReaderBuilder	读取单元格的批注、超链接和合并单元格属性

---

• 创建ExcelReader

ExcelReader作为EasyExcel的核心实现类，用于实现文件的读取，调用build()方法会返回一个ExcelReader对象，并传入设置好的readWorkbook属性。

public ExcelReader build() {
	return new ExcelReader(readWorkbook);
}

---

• 创建ExcelReaderSheetBuilder

如果是指定读取某个工作簿的内容，可以先调用sheet()方法设置当前需要读取的是第几个工作簿或指定工作簿的名称。不指定参数则获取所有工作簿的内容。在调用ExcelReaderSheetBuilder类的doRead()和doReadSync()方法读取数据。

方法	参数	返回值
sheet()	/	ExcelReaderSheetBuilder
sheet(Integer sheetNo)	sheetNo 工作簿序号(从0开始)	ExcelReaderSheetBuilder
sheet(String sheetName)	sheetName 工作簿名称	ExcelReaderSheetBuilder
sheet(Integer sheetNo, String sheetName)	sheetNo 工作簿序号(从0开始) sheetName 工作簿名称	ExcelReaderSheetBuilder

---

• 读取数据

若需要读取全部工作簿的数据，可以直接调用doReadAll()方法。

public void doReadAll() {
    ExcelReader excelReader = build();
    excelReader.readAll();
    excelReader.finish();
}

如果需要将结果拿出来再处理，可以调用doReadAllSync()方法，可以返回List对应的泛型集合。

public  List doReadAllSync() {
    SyncReadListener syncReadListener = new SyncReadListener();
    registerReadListener(syncReadListener);
    ExcelReader excelReader = build();
    excelReader.readAll();
    excelReader.finish();
    return (List)syncReadListener.getList();
}

2.2.2 ExcelWriterBuilder

• 设置WriteWorkbook属性

方法	参数	返回值	描述
ExcelWriterBuilder()	/	/	ExcelWriterBuilder类的构造方法，同时创建WriteWorkbook的实体类
excelType(ExcelTypeEnum excelType)	excelType Excel类型(枚举类型)	ExcelWriterBuilder	设置Excel的文件类型，明确读取的是xls、xlsx还是cvs文件
autoCloseStream(Boolean autoCloseStream)	autoCloseStream 是否自动关闭流(布尔类型)	ExcelWriterBuilder	设置读取完毕后是否自动关闭流，默认为自动关闭
inMemory(Boolean inMemory)	inMemory 是否在内存中运行	ExcelWriterBuilder	设置是否将数据读取到内存中，默认为false

---

• 创建ExcelWriter

ExcalWriter作为EasyExcel写文件的核心类，用于实现输出Excel，可以调用ExcelWriterBuilder类的build()方法创建ExcalWriter类，并将设置好的writeWorkbook。示例：

public ExcelWriter build() {
    return new ExcelWriter(writeWorkbook);
}

---

• 创建ExcelWriterSheetBuilder

调用ExcelWriterBuilder类的sheet()方法，用于设置将该数据流写入文件的那个工作簿，并设置工作簿的名称

方法	参数	返回值
sheet()	/	ExcelWriterSheetBuilder
sheet(Integer sheetNo)	sheetNo 工作簿序号(从0开始)	ExcelWriterSheetBuilder
sheet(String sheetName)	sheetName 工作簿名称	ExcelWriterSheetBuilder
sheet(Integer sheetNo, String sheetName)	sheetNo 工作簿序号(从0开始) sheetName 工作簿名称	ExcelWriterSheetBuilder

如果不设置工作簿名称，则输出在第一个工作簿并且工作簿名称为0

• 输出文件

调用ExcelWriter类的write(Collection data, WriteSheet writeSheet, WriteTable writeTable)方法，参数data为需要输出的数据集合，参数writeSheet为需要写入的工作簿信息，参数writeTable为写入的table（若不同的几组数据写入同一个工作簿可以创建多个WriteTable，可以为空）。

public ExcelWriter write(Collection data, WriteSheet writeSheet, WriteTable writeTable) {
    excelBuilder.addContent(data, writeSheet, writeTable);
    return this;
}

2.3 ExcelReaderSheetBuilder与ExcelWriterSheetBuilder

ExcelReaderSheetBuilder与ExcelWriterSheetBuilder用于创建ExcelReader和ExcelWriter类，可以理解为创建Excel的工作表。

2.3.1 ExcelReaderSheetBuilder

• 设置ReadSheet属性

方法	参数	返回值	描述
ExcelReaderSheetBuilder()			构造函数，用于创建ReadSheet
ExcelReaderSheetBuilder(ExcelReader excelReader)	ExcelReader excelReader		构造函数，用于创建ReadSheet和ExcelReader
sheetNo(Integer sheetNo)	Integer sheetNo 工作表序号，从0开始	ExcelReaderSheetBuilder	用于设置读取哪个工作表
sheetName(String sheetName)	String sheetName 工作表名称	ExcelReaderSheetBuilder	用于设置读取哪个工作表

---

• 获取ReadSheet对象

调用build()方法，可以返回ReadSheet属性。

public ReadSheet build() {
    return readSheet;
}

---

• 读取文件

public void doRead() {
    if (excelReader == null) {
        throw new ExcelGenerateException("Must use 'EasyExcelFactory.read().sheet()' to call this method");
    }
    excelReader.read(build());
    excelReader.finish();
}


public  List doReadSync() {
    if (excelReader == null) {
        throw new ExcelAnalysisException("Must use 'EasyExcelFactory.read().sheet()' to call this method");
    }
    SyncReadListener syncReadListener = new SyncReadListener();
    registerReadListener(syncReadListener);
    excelReader.read(build());
    excelReader.finish();
    return (List)syncReadListener.getList();
}

2.3.2 ExcelWriterSheetBuilder

• 设置WriteSheet属性

方法	参数	返回值	描述
ExcelWriterSheetBuilder()			构造函数，用于创建WriteSheet
ExcelWriterSheetBuilder(ExcelWriter excelWriter)	ExcelWriter excelWriter		构造函数，用于创建WriteSheet和ExcelWriter
sheetNo(Integer sheetNo)	Integer sheetNo 工作表序号	ExcelWriterSheetBuilder	设置工作表
sheetName(String sheetName)	String sheetName 工作表名称	ExcelWriterSheetBuilder	设置工作表

• 创建WriteSheet对象

调用build()方法，可以返回WriteSheet属性。

public WriteSheet build() {
    return writeSheet;
}

• 创建文件

使用doWrite()方法可以向文件直接填充数据

public void doWrite(Collection data) {
    if (excelWriter == null) {
        throw new ExcelGenerateException("Must use 'EasyExcelFactory.write().sheet()' to call this method");
    }
    excelWriter.write(data, build());
    excelWriter.finish();
}

public void doWrite(Supplier> supplier) {
    doWrite(supplier.get());
}

使用doFill()方法可以根据模板向文件填充数据

public void doFill(Object data) {
    doFill(data, null);
}

public void doFill(Object data, FillConfig fillConfig) {
    if (excelWriter == null) {
        throw new ExcelGenerateException("Must use 'EasyExcelFactory.write().sheet()' to call this method");
    }
    excelWriter.fill(data, fillConfig, build());
    excelWriter.finish();
}

public void doFill(Supplier