前言

EasyExcel使用（一）：监听器

背景

官方demo的监听器（继承AnalysisEventListener）是针对每一个导入方法做演示，没有给出公共解决方法，那这个就要自己做了。

解决方案

首先我们要建一个类去继承AnalysisEventListener。

package com.ak.common.listener;

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

/**
 * EasyExcel监听
 *
 * @author kwongting
 * @version 1.0
 * @date 2021/6/18 20:02
 * @description 分批次存储到数据库，然后清空列表，方便内存回收，在导入
 */
public class BaseDataListener<T> extends AnalysisEventListener<T> {
    @Override
    public void invoke(Object o, AnalysisContext analysisContext) {

    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {

    }
}

从invoke方法入手，在这里我们需要根据业务所需传入一个校验规则，这里用到JDK8新增的函数式接口Predicate<T>，摘录一段官方描述：

@FunctionalInterface
public interface Predicate<T>
Represents a predicate (boolean-valued function) of one argument.
This is a functional interface whose functional method is test(Object).

主要用法就是接收一个参数然后返回一个boolean值，这个正适合我们的需求。

    private final Predicate<T> predicate;

    /**
     * 每一条数据解析时操作
     *
     * @param data 已经转换成实体的excel数据
     * @param context EasyExcel上下文
     */
    @Override
    public void invoke(T data, AnalysisContext context) {

        LOGGER.info("解析到一条数据:{}", JSON.toJSONString(data));
        //符合校验规则则添加
        if (!predicate.test(data)){
        //如果不符合校验规则，就不进行操作开始解析下一条
            return;
        }
        //这里进行校验完成后的操作
        ******
    }

然后从doAfterAllAnalysed入手，当我们的数据都已经经过解析转换成需要的实体，那我们可以根据需要的业务去进行操作。这里用到JDK8新增的函数式接口Predicate<T>，摘录一段官方描述：

@FunctionalInterface
public interface Consumer<T>
Represents an operation that accepts a single input argument and returns no result. Unlike most other functional interfaces, Consumer is expected to operate via side-effects.
This is a functional interface whose functional method is accept(Object).

主要用法就是传入一个参数然后进行操作，不需要返回值。

    private final Consumer<List<T>> consumer;

     /**
     * 所有数据解析完成了 都会来调用
     *
     * @param context EasyExcel上下文
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        consumer.accept(list);
        LOGGER.info("所有数据解析完成！");
    }

还有最后的onException，对于异常的操作，需要重写这个方法，AnalysisEventListener是抛出了异常，当抛出异常的时候会停止读取剩余数据，开发场景肯定是希望忽略这条数据继续添加啦～

    /**
     * 获取转换异常
     *
     * @param exception ExcelDataConvertException
     * @param context excel上下文
     */
    @Override
    public void onException(Exception exception, AnalysisContext context) {
        // 如果是某一个单元格的转换异常 能获取到具体行号
        // 如果要获取头的信息 配合doAfterAllAnalysedHeadMap使用
        if (exception instanceof ExcelDataConvertException) {
            ExcelDataConvertException excelDataConvertException = (ExcelDataConvertException)exception;
            LOGGER.error("第{}行，第{}列解析异常", excelDataConvertException.getRowIndex()+1,
                    excelDataConvertException.getColumnIndex()+1);
        }
    }

最后我们来组成一个完整的方法，配合EasyExcel官方推荐的分批导入，再维护一个List。

    /**
     * 默认行数
     */
    private static int BATCH_COUNT = 3000;

    private final List<T> list;

    private final Consumer<List<T>> consumer;
    private final Predicate<T> predicate;

    /**
     * 每一条数据解析时操作
     *
     * @param data    已经转换成实体的excel数据
     * @param context EasyExcel上下文
     */
    @Override
    public void invoke(T data, AnalysisContext context) {

        LOGGER.info("解析到一条数据:{}", JSON.toJSONString(data));
        //符合校验规则则添加
        if (!predicate.test(data)) {
            return;
        }
        list.add(data);
        // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
        if (list.size() >= BATCH_COUNT) {
            consumer.accept(list);
            list.clear();
        }
    }

    /**
     * 所有数据解析完成了 都会来调用
     *
     * @param context EasyExcel上下文
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        if (list.size() > 0) {
            consumer.accept(list);
        }
        LOGGER.info("所有数据解析完成！");
    }

    /**
     * 获取转换异常
     *
     * @param exception ExcelDataConvertException
     * @param context   excel上下文
     */
    @Override
    public void onException(Exception exception, AnalysisContext context) {
        // 如果是某一个单元格的转换异常 能获取到具体行号
        // 如果要获取头的信息 配合doAfterAllAnalysedHeadMap使用
        if (exception instanceof ExcelDataConvertException) {
            ExcelDataConvertException excelDataConvertException = (ExcelDataConvertException) exception;
            LOGGER.error("第{}行，第{}列解析异常", excelDataConvertException.getRowIndex() + 1,
                    excelDataConvertException.getColumnIndex() + 1);
        }
    }
}

总体思路大概就是如此了，接下来再配合构造类我们就可以使用起来了。

    /**
     * 读取每一条数据进行predicate操作，
     * 读取到count行数进行consumer操作
     *
     * @param count     读取的行数
     * @param predicate 读取一条数据执行的方法。例：校验数据规则
     * @param consumer  读取规定行数后执行的方法
     */
    public BaseDataListener(int count, Predicate<T> predicate, Consumer<List<T>> consumer) {
        BATCH_COUNT = count;
        this.consumer = consumer == null ? ts -> {
        } : consumer;
        this.predicate = predicate == null ? t -> true : predicate;
        list = new ArrayList<>(BATCH_COUNT);
    }

本章介绍了公共监听器的用法，下一章就配合真实业务环境进行开发。