EasyExcel使用(二):公共监听器

本文涉及:JDK8新特性

目录

EasyExcel目录

前言

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);
    }

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

后记

EasyExcel使用(三):完善监听器

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,335评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,895评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,766评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,918评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,042评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,169评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,219评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,976评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,393评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,711评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,876评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,562评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,193评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,903评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,699评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,764评论 2 351

推荐阅读更多精彩内容