EasyExcel学习笔记

一、EasyExcel简介

1.1Excel导入导出的应用场景

1、数据导入：减轻录入工作量；
2、数据导出：统计信息归档；
3、数据传输：异构系统之间数据传输；

1.2EasyExcel特点

Java领域解析、生成Excel比较有名的框架有Apache poi、jxl等。但他们都存在一个严重的问题就是非常的耗内存。如果你的系统并发量不大的话可能还行，但是一旦并发上来后一定会OOM或者JVM频繁的full gc。
EasyExcel是阿里巴巴开源的一个excel处理框架，以使用简单、节省内存著称。EasyExcel能大大减少占用内存的主要原因是在解析Excel时没有将文件数据一次性全部加载到内存中，而是从磁盘上一行行读取数据，逐个解析。
EasyExcel采用一行一行的解析模式，并将一行的解析结果以观察者的模式通知处理（AnalysisEventListener）。

二、EasyExcel的写操作–导出

2.1引入依赖

<dependencies>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>easyexcel</artifactId>
        <version>2.1.1</version>
    </dependency>
</dependencies>

2.2创建实体类，和Excel数据对应

@Data
@ContentRowHeight(15)//easyExcel注解设置内容的行高
@HeadRowHeight(25)//easyExcel注解设置表头的行高
@ColumnWidth(12)//easyExcel注解设置列宽
public class DemoData {

    //设置Excel表头名称
    @ExcelProperty(value = "学生编号",index = 0)
    private Integer sno;

    @ExcelProperty(value = "学生姓名",index = 1)
    private String sname;
}

2.3实现导出

public static void main(String[] args) {
        //==================写操作=====================
        //实现Excel写的操作
        //设置写入文件夹的地址和Excel文件名称
        String filename = "D:\\1.xlsx";

        //这里需要指定写用哪个写 然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        EasyExcel.write(filename,DemoData.class).sheet("学生列表").doWrite(data());
    }

    public static List<DemoData> data(){
        List<DemoData> list = new ArrayList<>();
        for (int i = 1; i < 11; i++) {
            DemoData demoData = new DemoData();
            demoData.setSno(i);
            demoData.setSname("我今天吃了"+i+"个包子");
            list.add(demoData);
        }
        return list;
    }

三、EasyExcel的读操作–导入

3.1创建对应的实体类,标记对应列关系

@Data
@ContentRowHeight(15)//easyExcel注解设置内容的行高
@HeadRowHeight(25)//easyExcel注解设置表头的行高
@ColumnWidth(12)//easyExcel注解设置列宽
public class DemoData {

    //设置Excel表头名称
    @ExcelProperty(value = "学生编号",index = 0)
    private Integer sno;

    @ExcelProperty(value = "学生姓名",index = 1)
    private String sname;
}

3.2创建监听进行Excel文件读取

public class ExcelListener extends AnalysisEventListener<DemoData> {

    /**
     * @Description:    一行一行的读取
     * @Author:         ZhaoLiangLiang
     * @date            2019/9/11 17:01
     **/
    @Override
    public void invoke(DemoData demoData, AnalysisContext analysisContext) {
        System.out.println("****"+demoData);
    }

    /**
     * @Description:    读取表头内容
     * @Author:         ZhaoLiangLiang
     * @date            2021/9/11 17:02
     **/
    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        System.out.println("表头:"+headMap);
    }

    /**
     * @Description:    读取完成之后
     * @Author:         ZhaoLiangLiang
     * @date            2019/9/11 17:01
     **/
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        System.out.println();
    }
}

3.3最终调用

String filename = "D:\\1.xlsx";
EasyExcel.read(filename,DemoData.class,new ExcelListener()).sheet().doRead();

四、写人的案例

4.1整体解读

4.2代码解读

4.3Listener代码解读

五、EasyExcel导入，并校验导入的数据不能为空

5.1excel模板对象相应属性添加注解

@ExcelProperty("*本人联系电话")
@ExcelValid(message = "本人联系电话不能为空")
private String phone;

5.2编写字段校验类

ExceptionCustom为继承RuntimeException 的自定义异常类

package com.cm.company.listener;

import com.cm.company.utils.exception.ExceptionCustom;
import java.lang.reflect.Field;
import java.util.Objects;

public class ExcelImportValid {
    /**
     * Excel导入字段校验
     *
     * @param object 校验的JavaBean 其属性须有自定义注解
     */
    public static void valid(Object object) throws ExceptionCustom{
        Field[] fields = object.getClass().getDeclaredFields();
        for (Field field : fields) {
            //设置可访问
            field.setAccessible(true);
            //属性的值
            Object fieldValue = null;
            try {
                fieldValue = field.get(object);
            } catch (IllegalAccessException e) {
                throw new ExceptionCustom("IMPORT_PARAM_CHECK_FAIL", "导入参数检查失败");
            }
            //是否包含必填校验注解
            boolean isExcelValid = field.isAnnotationPresent(ExcelValid.class);
            if (isExcelValid && Objects.isNull(fieldValue)) {
                System.out.println(field.getAnnotation(ExcelValid.class).message());
                throw new ExceptionCustom("NULL", field.getAnnotation(ExcelValid.class).message());
            }

        }
    }
}

5.3ExceptionCustom

@Data
public class ExceptionCustom extends RuntimeException{

    private String messageType;

    private String message;

    public ExceptionCustom(String messageType,String message) {
        this.message = message;
        this.messageType = messageType;
    }
}

5.4ExcelValid

声明不能为空校验注解

package com.cm.company.listener;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Excel导入必填校验注解
 */
@Target({ElementType.FIELD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ExcelValid {
    String message() default "导入有未填入的字段";
}

5.5Listener监听器的invoke

@Override
public void invoke(Person data, AnalysisContext context) {
    try{
        ExcelImportValid.valid(data);
        list.add(data);//存入list中
    }catch (ExceptionCustom e){
        result.setMessage(e.getMessage());//将报错信息存入result中
    }
}