Examples with ReadListener com.alibaba.excel.read.listener.ReadListener used on opensource projects

Example 1 with ReadListener

use of com.alibaba.excel.read.listener.ReadListener in project diboot by dibo-software.

the class ReadExcelListener method onException.

/**
 * <h3>异常处理</h3>
 * 修补数据，回写错误
 */
@Override
public void onException(Exception exception, AnalysisContext context) throws Exception {
    // 数据类型转化异常
    if (exception instanceof ExcelDataConvertException) {
        ExcelDataConvertException dataConvertException = (ExcelDataConvertException) exception;
        Map<Integer, ReadCellData<?>> cellMap = new HashMap<>((Map) context.readRowHolder().getCellMap());
        Map<String, String> errorDataMap = new HashMap<>();
        Map<String, String> errorMsgMap = new HashMap<>();
        Consumer<ExcelDataConvertException> addErrorData = e -> {
            Integer columnIndex = e.getColumnIndex();
            String key = fieldNameMap.get(columnIndex);
            errorDataMap.put(key, cellMap.remove(columnIndex).getStringValue());
            errorMsgMap.put(key, "数据格式转换异常，非期望的数据类型[" + e.getExcelContentProperty().getField().getType().getSimpleName() + "]");
        };
        addErrorData.accept(dataConvertException);
        ReadListener<?> readListener = context.readWorkbookHolder().getReadListenerList().get(0);
        if (readListener instanceof ModelBuildEventListener) {
            while (true) {
                try {
                    ((ModelBuildEventListener) readListener).invoke(cellMap, context);
                    break;
                } catch (ExcelDataConvertException convertException) {
                    addErrorData.accept(convertException);
                }
            }
        } else {
            log.error("数据转换异常", exception);
            StringBuilder errorMsg = new StringBuilder().append("第 ").append(context.readRowHolder().getRowIndex() + 1).append(" 行，");
            errorMsgMap.forEach((fieldName, msg) -> errorMsg.append(fieldHeadMap.get(fieldName)).append("：").append(msg));
            addExceptionMsg(errorMsg.toString());
            return;
        }
        T currentRowAnalysisResult = (T) context.readRowHolder().getCurrentRowAnalysisResult();
        currentRowAnalysisResult.setRowIndex(context.readRowHolder().getRowIndex());
        errorDataMap.forEach(currentRowAnalysisResult::addInvalidValue);
        errorMsgMap.forEach(currentRowAnalysisResult::addComment);
        // 校验异常
        Set<ConstraintViolation<T>> constraintViolations = V.validateBean(currentRowAnalysisResult);
        if (V.notEmpty(constraintViolations)) {
            for (ConstraintViolation<T> violation : constraintViolations) {
                String propertyName = violation.getPropertyPath().toString();
                // 剔除解析识别的数据校验
                if (!errorDataMap.containsKey(propertyName)) {
                    currentRowAnalysisResult.addComment(propertyName, violation.getMessage());
                }
            }
        }
        this.cachedData(currentRowAnalysisResult);
    } else {
        log.error("出现未预知的异常：", exception);
        addExceptionMsg("第 " + (context.readRowHolder().getRowIndex() + 1) + " 行，解析异常: " + exception.getMessage());
    }
}

Example 2 with ReadListener

use of com.alibaba.excel.read.listener.ReadListener in project easyexcel by alibaba.

the class DefaultAnalysisEventProcessor method dealData.

private void dealData(AnalysisContext analysisContext) {
    ReadRowHolder readRowHolder = analysisContext.readRowHolder();
    Map<Integer, ReadCellData<?>> cellDataMap = (Map) readRowHolder.getCellMap();
    readRowHolder.setCurrentRowAnalysisResult(cellDataMap);
    int rowIndex = readRowHolder.getRowIndex();
    int currentHeadRowNumber = analysisContext.readSheetHolder().getHeadRowNumber();
    boolean isData = rowIndex >= currentHeadRowNumber;
    // Last head column
    if (!isData && currentHeadRowNumber == rowIndex + 1) {
        buildHead(analysisContext, cellDataMap);
    }
    // Now is data
    for (ReadListener readListener : analysisContext.currentReadHolder().readListenerList()) {
        try {
            if (isData) {
                readListener.invoke(readRowHolder.getCurrentRowAnalysisResult(), analysisContext);
            } else {
                readListener.invokeHead(cellDataMap, analysisContext);
            }
        } catch (Exception e) {
            onException(analysisContext, e);
            break;
        }
        if (!readListener.hasNext(analysisContext)) {
            throw new ExcelAnalysisStopException();
        }
    }
}

Example 3 with ReadListener

use of com.alibaba.excel.read.listener.ReadListener in project easyexcel by alibaba.

the class ReadTest method simpleRead.

/**
 * 最简单的读
 * <p>
 * 1. 创建excel对应的实体对象 参照{@link DemoData}
 * <p>
 * 2. 由于默认一行行的读取excel，所以需要创建excel一行一行的回调监听器，参照{@link DemoDataListener}
 * <p>
 * 3. 直接读即可
 */
@Test
public void simpleRead() {
    // 写法1：JDK8+ ,不用额外写一个DemoDataListener
    // since: 3.0.0-beta1
    String fileName = TestFileUtil.getPath() + "demo" + File.separator + "demo.xlsx";
    // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
    // 这里每次会读取3000条数据 然后返回过来 直接调用使用数据就行
    EasyExcel.read(fileName, DemoData.class, new PageReadListener<DemoData>(dataList -> {
        for (DemoData demoData : dataList) {
            log.info("读取到一条数据{}", JSON.toJSONString(demoData));
        }
    })).sheet().doRead();
    // 写法2：
    // 匿名内部类 不用额外写一个DemoDataListener
    fileName = TestFileUtil.getPath() + "demo" + File.separator + "demo.xlsx";
    // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
    EasyExcel.read(fileName, DemoData.class, new ReadListener<DemoData>() {

        /**
         * 单次缓存的数据量
         */
        public static final int BATCH_COUNT = 100;

        /**
         *临时存储
         */
        private List<DemoData> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);

        @Override
        public void invoke(DemoData data, AnalysisContext context) {
            cachedDataList.add(data);
            if (cachedDataList.size() >= BATCH_COUNT) {
                saveData();
                // 存储完成清理 list
                cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
            }
        }

        @Override
        public void doAfterAllAnalysed(AnalysisContext context) {
            saveData();
        }

        /**
         * 加上存储数据库
         */
        private void saveData() {
            log.info("{}条数据，开始存储数据库！", cachedDataList.size());
            log.info("存储数据库成功！");
        }
    }).sheet().doRead();
    // 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去
    // 写法3：
    fileName = TestFileUtil.getPath() + "demo" + File.separator + "demo.xlsx";
    // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
    EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
    // 写法4： 使用 try-with-resources @since 3.1.0
    fileName = TestFileUtil.getPath() + "demo" + File.separator + "demo.xlsx";
    // 一个文件一个reader
    try (ExcelReader excelReader = EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).build()) {
        // 构建一个sheet 这里可以指定名字或者no
        ReadSheet readSheet = EasyExcel.readSheet(0).build();
        // 读取一个sheet
        excelReader.read(readSheet);
    }
    // 写法5： 不使用 try-with-resources
    fileName = TestFileUtil.getPath() + "demo" + File.separator + "demo.xlsx";
    // 一个文件一个reader
    ExcelReader excelReader = null;
    try {
        excelReader = EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).build();
        // 构建一个sheet 这里可以指定名字或者no
        ReadSheet readSheet = EasyExcel.readSheet(0).build();
        // 读取一个sheet
        excelReader.read(readSheet);
    } finally {
        if (excelReader != null) {
            // 这里千万别忘记关闭，读的时候会创建临时文件，到时磁盘会崩的
            excelReader.close();
        }
    }
}