使用easyExcel完成简单的读写操作

前言

基于easyExcel完成简单的读写操作。官方文档可参考 https://www.yuque.com/easyexcel/doc/easyexcel

1. 导入jar包

<dependencies>
    <!-- https://mvnrepository.com/artifact/com.alibaba/easyexcel -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>easyexcel</artifactId>
        <version>2.1.6</version>
    </dependency>
    <!--lombok用来简化实体类：需要安装lombok插件(非必须)-->
    <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.12</version>
    </dependency>

</dependencies>

2. 实现写操作

[1] 编写数据实体类 DemoData.java

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

//@Data表示生成相应的get,set等方法
@Data
public class DemoData {

    //设置excel表头名称
    @ExcelProperty(value = "学生编号")
    private Integer sno;
    @ExcelProperty(value = "学生姓名")
    private String sname;
}

[2] 使用EasyExcel的write方法完成写入操作
EasyExcel.write().sheet().doWrite()

import com.alibaba.excel.EasyExcel;

import java.util.ArrayList;
import java.util.List;

public class TestEasyExcel {

    public static void main(String[] args) {
        testWrite();
    }

    //1.实现写操作
    public static void  testWrite(){
        //1.设置写入文件地址和excel文件名称
        String filename = "F:/write.xlsx";
        //2.使用write(文件名称,实体类名称)
        EasyExcel.write(filename,DemoData.class).sheet("学生列表").doWrite(getData());
    }
    //写入的数据
    public static List<DemoData> getData(){
        List<DemoData> list = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
        	//设置相应的数据
            DemoData data = new DemoData();
            data.setSno(i);
            data.setSname("Lucy " + i);
            list.add(data);
        }
        return list;
    }
}

运行后：

3.实现读操作

[1] 在实体类中需要加入index表示列的序号

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class DemoData {

    //设置excel表头名称
    @ExcelProperty(value = "学生编号",index = 0)
    private Integer sno;
    @ExcelProperty(value = "学生姓名",index = 1)
    private String sname;
}

[2] 由于EasyExcel是一行一行数据读取，所以需要编写一个监听类，这个类需要继承 AnalysisEventListener
AnalysisEventListener这个类中有个invokeHeadMap()是实现读取表头的作用(默认是不用重写该方法)，我们可以自行加上这个方法。

自己实现的监听类:
ExcelListener.class
<1> invoke() ： 一行一行地读取表格内容
<2> invokeHeadMap()： 读取表头内容
<3> doAfterAllAnalysed()： 读取之后的操作

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;

import java.util.Map;

public class ExcelListener extends AnalysisEventListener<DemoData> {

    //一行一行读取excel内容
    @Override
    public void invoke(DemoData demoData, AnalysisContext analysisContext) {
        System.out.println("***"+demoData);
    }

    //读取表头内容
    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        System.out.println("表头: "+headMap);
    }

    //读取完之后的操作
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {

    }
}

[3] 编写测试类
EasyExcel.read().sheet().doRead()

import com.alibaba.excel.EasyExcel;

import java.util.ArrayList;
import java.util.List;

public class TestEasyExcel {

    public static void main(String[] args) {
        testRead();
    }

    //2.实现读操作
    public static void testRead(){
        //1.设置要读取的文件名称
        String filename = "F:/write.xlsx";
        //2.read(文件名,数据实体,监听类)
        EasyExcel.read(filename,DemoData.class,new ExcelListener()).sheet().doRead();
    }

}