六虎

使用 EasyExcel 在 Android 应用中实现高效的 Excel 文件操作

作者：

码农清风

在

在 Android 应用开发中，操作 Excel 文件是一项常见的需求。为了简化开发进程并供给更强壮的功用，咱们能够运用第三方库来处理 Excel 文件。运用 EasyExcel 完结 Excel 文件操作。

Apache POI：

Apache POI 是一个流行的 Java 库，供给了强壮的功用来读取、写入和操作 Microsoft Office 格式的文件，包含 Excel 文件。能够经过以下办法将 Apache POI 库引进您的项目：

implementation 'org.apache.poi:poi:5.0.0'
implementation 'org.apache.poi:poi-ooxml:5.0.0'

EasyExcel：

EasyExcel 是一个基于 Apache POI 封装的易用的 Excel 文件处理库，供给了简洁的 API，使得操作 Excel 文件愈加简略和高效。

implementation 'com.alibaba:easyexcel:2.4.3'

读取 Excel 文件

// 读取 Excel 文件
String filePath = "path/to/excel/file.xlsx";
ExcelReader excelReader = EasyExcel.read(filePath).build();
List<MyData> dataList = excelReader.readAll(MyData.class, new AnalysisEventListener<MyData>() {
    @Override
    public void invoke(MyData data, AnalysisContext context) {
        // 处理每一行的数据
    }
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 数据读取完结
    }
});
excelReader.finish();

写入 Excel 文件

// 写入 Excel 文件
String filePath = "path/to/save/excel/file.xlsx";
EasyExcel.write(filePath, MyData.class).sheet("Sheet1").doWrite(dataList);

写入杂乱数据结构：

EasyExcel 支撑将杂乱的数据结构写入到 Excel 文件中，例如嵌套的目标、Map、List 等。您能够运用 @ExcelProperty 注解来指定每个字段对应的 Excel 列，运用 @ExcelIgnore 注解来疏忽某些字段。

public class MyData {
    @ExcelProperty("名字")
    private String name;
    @ExcelProperty("年纪")
    private int age;
    // 结构函数、getter 和 setter 办法省掉
}
List<MyData> dataList = new ArrayList<>();
// 增加数据到 dataList
String filePath = "path/to/save/excel/file.xlsx";
EasyExcel.write(filePath, MyData.class).sheet("Sheet1").doWrite(dataList);

数据转换和校验：

EasyExcel 供给了数据转换和校验的功用，您能够运用 @ExcelProperty 注解的 converter 特点来指定数据转换器，运用 @ExcelProperty 注解的 validator 特点来指定数据校验器。

public class AgeConverter implements Converter<Integer> {
    @Override
    public Integer convertToExcelData(Integer value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
        // 将年纪转换为 Excel 数据
    }
    @Override
    public Integer convertToJavaData(String value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
        // 将 Excel 数据转换为年纪
    }
}
public class MyData {
    @ExcelProperty(value = "年纪", converter = AgeConverter.class)
    private int age;
    // 结构函数、getter 和 setter 办法省掉
}

大数据量写入和读取：

EasyExcel 支撑大数据量的写入和读取，经过运用 excelWriter 和 excelReader 的 finish 办法，能够完结分批次写入和读取数据，避免占用过多内存。

ExcelWriter excelWriter = EasyExcel.write("path/to/save/excel/file.xlsx").build();
WriteSheet writeSheet = EasyExcel.writerSheet("Sheet1").build();
// 分批次写入数据
for (int i = 0; i < totalDataSize; i += batchSize) {
    List<MyData> dataList = fetchData(i, batchSize); // 模拟获取数据的办法
    excelWriter.write(dataList, writeSheet);
}
excelWriter.finish();
ExcelReader excelReader = EasyExcel.read("path/to/excel/file.xlsx").build();
ReadSheet readSheet = EasyExcel.readSheet(0).build();
// 分批次读取数据
List<MyData> dataList = new ArrayList<>();
excelReader.read(readSheet, new AnalysisEventListener<MyData>() {
    @Override
    public void invoke(MyData data, AnalysisContext context) {
        dataList.add(data);
        if (dataList.size() >= batchSize) {
            processData(dataList); // 处理数据
的办法
            dataList.clear();
        }
    }
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        processData(dataList); // 处理最终一批数据
    }
});
excelReader.finish();

经过分批次处理数据，能够进步功能和内存利用率。

设置表头款式：

能够运用TableStyle类来设置表头的款式，包含字体、背景色、边框等。示例代码：

// 创立表头款式
TableStyle tableStyle = new TableStyle();
Font font = new Font();
font.setBold(true);
tableStyle.setTableHeadFont(font);
tableStyle.setTableHeadBackgroundColor(IndexedColors.GREY_25_PERCENT.getIndex());
tableStyle.setTableHeadBorderStyle(BorderStyle.THIN);
String filePath = "path/to/save/excel/file.xlsx";
EasyExcel.write(filePath, MyData.class)
        .registerWriteHandler(new TableStyleWriteHandler(tableStyle))
        .sheet("Sheet1")
        .doWrite(dataList);

咱们创立了一个TableStyle目标，并设置了表头字体为粗体、背景色为灰色、边框为细线。然后，咱们经过registerWriteHandler()办法将这个款式应用于写入操作，完结了表头款式的设置。

自定义监听器：

EasyExcel 供给了监听器接口，答应在读取和写入 Excel 文件时处理特定事件。能够完结AnalysisEventListener接口或WriteHandler接口，并重写相应的办法来完结自定义监听器。

// 自定义读取监听器
public class MyReadListener extends AnalysisEventListener<MyData> {
    @Override
    public void invoke(MyData data, AnalysisContext context) {
        // 处理每一行的数据
    }
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 数据读取完结
    }
}
// 自定义写入监听器
public class MyWriteListener extends WriteHandlerAdapter {
    @Override
    public void sheet(int sheetNo, Sheet sheet) {
        // 在写入每个作业表之前的处理
    }
    @Override
    public void row(int rowNum, Row row) {
        // 在写入每一行之前的处理
    }
    @Override
    public void cell(int cellNum, Cell cell) {
        // 在写入每个单元格之前的处理
    }
}
// 运用自定义监听器进行读取和写入操作
String filePath = "path/to/excel/file.xlsx";
ExcelReader excelReader = EasyExcel.read(filePath, MyData.class, new MyReadListener()).build();
excelReader.read();
String filePath = "path/to/save/excel/file.xlsx";
ExcelWriter excelWriter = EasyExcel.write(filePath, MyData.class)
        .registerWriteHandler(new MyWriteListener())
        .build();
excelWriter.write(dataList);
excelWriter.finish();

创立了MyReadListener和MyWriteListener，别离继承自AnalysisEventListener和WriteHandlerAdapter。经过在读取和写入操作中传入自定义监听器，能够完结对读取和写入进程的定制化处理。

处理空白单元格：

EasyExcel 默许会跳过空白单元格，不进行读取或写入操作。假如想要处理空白单元格，能够运用@ExcelProperty注解的defaultValue特点来设置默许值。

public class MyData {
    @ExcelProperty(value = "名字", defaultValue = "不知道")
    private String name;
    @ExcelProperty(value = "年纪", defaultValue = "0")
    private int age;
    // 结构函数、getter 和 setter 办法省掉
}
// 读取 Excel 文件
String filePath = "path/to/excel/file.xlsx";
ExcelReader excelReader = EasyExcel.read(filePath).build();
List<MyData> dataList = excelReader.readAll(MyData.class);
excelReader.finish();
// 写入 Excel 文件
String filePath = "path/to/save/excel/file.xlsx";
EasyExcel.write(filePath, MyData.class).sheet("Sheet1").doWrite(dataList);

经过在@ExcelProperty注解中设置defaultValue特点，为名字和年纪字段指定了默许值。这样，在读取进程中，假如某个单元格为空，将会运用指定的默许值进行填充；在写入进程中，假如某个字段的值为默许值，则会将默许值写入到对应的单元格中。

更多文章