add 新增导入支持开启Validator数据验证，支持开启导入异常行继续读取，支持返回导入回执

zhujie

2021-11-26 c3bb4d2a6181e27b58cca56def0f392d6df7d7a1

add 新增导入支持开启Validator数据验证，支持开启导入异常行继续读取，支持返回导入回执

 ruoyi-common/src/main/java/com/ruoyi/common/utils/poi/ExcelListener.java

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,116 @@
package com.ruoyi.common.utils.poi;

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.util.StrUtil;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.alibaba.excel.exception.ExcelAnalysisException;
import com.alibaba.excel.exception.ExcelDataConvertException;
import com.alibaba.fastjson.JSON;
import com.ruoyi.common.utils.ValidatorUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.validation.*;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * å…¬å…±excel监听类
 * @param <T>
 */
public class ExcelListener<T> extends AnalysisEventListener<T> {

    private static final Logger LOGGER = LoggerFactory.getLogger(ExcelListener.class);
    /** æ•°æ®å¯¹è±¡list */
    private final List<T> list = new ArrayList<>();
    /** é”™è¯¯ä¿¡æ¯åˆ—表 */
    private final List<String> errorList = new ArrayList<>();
    /** é‡åˆ°å¼‚常是否跳出导入，默认为是 */
    private Boolean skipException = Boolean.TRUE;
    /** æ˜¯å¦Validator检验，默认为是 */
    private Boolean isValidate = Boolean.TRUE;
    /**
     * å¯¼å…¥å›žæ‰§
     */
    private final ExcelResult<T> excelResult = new ExcelResult<>();

    public ExcelListener() {

    }

    public ExcelListener(boolean isValidate, boolean skipException) {
        this.isValidate = isValidate;
        this.skipException = skipException;
    }

    /**
     * å¤„理异常
     *
     * @param exception ExcelDataConvertException
     * @param context excel上下文
     */
    @Override
    public void onException(Exception exception, AnalysisContext context) throws Exception {
        // å¦‚果是某一个单元格的转换异常 èƒ½èŽ·å–到具体行号
        // å¦‚果要获取头的信息 é…åˆdoAfterAllAnalysedHeadMap使用
        String errMsg = null;
        if (exception instanceof ExcelDataConvertException) {
            ExcelDataConvertException excelDataConvertException = (ExcelDataConvertException)exception;
            errMsg = StrUtil.format("第{}行-第{}列解析异常<br/>", excelDataConvertException.getRowIndex() + 1,
                    excelDataConvertException.getColumnIndex() + 1);
            LOGGER.error(errMsg);
        }
        if (exception instanceof ConstraintViolationException) {
            ConstraintViolationException constraintViolationException = (ConstraintViolationException)exception;
            Set<ConstraintViolation<?>> constraintViolations = constraintViolationException.getConstraintViolations();
            String constraintViolationsMsg= CollUtil.join(constraintViolations
                    .stream()
                    .map(ConstraintViolation::getMessage)
                    .collect(Collectors.toList()),
                ",");
            errMsg = StrUtil.format("第{}行数据校验异常:{}", context.readRowHolder().getRowIndex() + 1,
                constraintViolationsMsg);
            LOGGER.error(errMsg);
        }
        errorList.add(errMsg);
        if (!skipException){
            throw new ExcelAnalysisException(errMsg);
        }
    }

    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        LOGGER.debug("解析到一条头数据:{}", JSON.toJSONString(headMap));
    }

    @Override
    public void invoke(T data, AnalysisContext context) {
        if (isValidate) {
            ValidatorUtils.validate(data);
        }
        list.add(data);
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        excelResult.setList(list);
        excelResult.setErrorList(errorList);
        LOGGER.debug("所有数据解析完成！");
    }

    /**
     * èŽ·å–导入数据
     * @return å¯¼å…¥æ•°æ®
     */
    public List<T> getList() {
        return list;
    }

    public ExcelResult<T> getExcelResult() {
        return excelResult;
    }

}

 ruoyi-common/src/main/java/com/ruoyi/common/utils/poi/ExcelResult.java

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,40 @@
package com.ruoyi.common.utils.poi;

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.util.StrUtil;
import lombok.Data;

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

@Data
public class ExcelResult<T> {

    /** æ•°æ®å¯¹è±¡list
     */
    private List<T> list;
    /** é”™è¯¯ä¿¡æ¯åˆ—表 */
    private List<String> errorList;

    /**
     * èŽ·å–导入回执
     * @return å¯¼å…¥å›žæ‰§
     */
    public String getAnalysis() {
        int successCount = list.size();
        int errorCount = errorList.size();
        if (successCount == 0) {
            return "读取失败，未解析到数据";
        } else {
            if (errorList.size() == 0) {
                return StrUtil.format("恭喜您，全部读取成功！共{}条", successCount);
            } else {
                return StrUtil.format("部分读取成功，其中成功{}条，失败{}条，错误信息如下：<br/>{}",
                    successCount,
                    errorCount,
                    CollUtil.join(errorList, "<br/>"));
            }

        }
    }
}

 ruoyi-common/src/main/java/com/ruoyi/common/utils/poi/ExcelUtil.java

@@ -6,6 +6,7 @@
import com.ruoyi.common.convert.ExcelBigNumberConvert;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.common.utils.file.FileUtils;
import org.apache.poi.ss.formula.functions.T;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
@@ -30,6 +31,19 @@
        return EasyExcel.read(is).head(clazz).autoCloseStream(false).sheet().doReadSync();
    }


    /**
     * å¯¹excel表单默认第一个索引名转换成list（EasyExcel）
     *
     * @param is è¾“入流
     * @return è½¬æ¢åŽé›†åˆ
     */
    public static <T> ExcelResult<T> importExcel(InputStream is, Class<T> clazz, boolean isValidate, boolean skipException) {
        ExcelListener<T> listener = new ExcelListener<>(isValidate, skipException);
        EasyExcel.read(is, clazz, listener).sheet().doRead();
        return listener.getExcelResult();
    }

    /**
     * å¯¹list数据源将其里面的数据导入到excel表单（EasyExcel）
     *