easyexcel 结合javax.validation实现excel导入校验

最新推荐文章于 2025-11-12 10:21:46 发布
原创 最新推荐文章于 2025-11-12 10:21:46 发布 · 7.1k 阅读 · 15 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #easyexcel # javax.validation

本文介绍了一种在使用EasyExcel读取Excel文件时，对数据进行校验的方法。通过使用String类型接收单元格值，结合javax.validation注解，实现对整个Excel文件中所有错误数据的检测，包括使用自定义异常处理和数据验证。

在使用easyexcel时发现是没有对单元格值校验的方式，我个人只发现了一个转换异常类ExcelDataConvertException，当单元格中的值转换不成实体类中改值所对应的属性类型时，会抛出改异常，onException中可以处理。但如果需要把一行中的所有错误的值都找到的话，就不能触发onException，官方文档原话如下：

在转换异常 获取其他异常下会调用本接口。抛出异常则停止读取。如果这里不抛出异常则 继续读取下一行

即如果触发了onException且不抛出异常，直接开始读取下一行数据

@Override
public void onException(Exception exception, AnalysisContext context){
    if(exception instanceof ExcelDataConvertException){
        ExcelDataConvertException e = (ExcelDataConvertException)exception;
        
    }
}

因为我们是要校验整个excel中所有错误数据，显然不能触发onException，所以我的做法是通过使用String类型接收所有单元格值，然后通过javax.validation注解的方式对值进行校验。在invoke中获取到data数据，然后对data进行校验，propertyNameMap是中的key是field的name，通过javax.validation中获取到的name从propertyNameMap中得到该属性在excel中的行号，列号等信息，用于最后的错误提示信息的封装

@ExcelProperty("地区")
@NotBlank(message = "区不能为空")
private String area;
public void invoke(E data, AnalysisContext analysisContext) {
    Map<String, ExcelCellBo> propertyNameMap = getPropertyNameMap(true,analysisContext);
    if (validate(data,propertyNameMap)) {
        dataList.add(data);
    }
}
 boolean validate(E e, Map<String, ExcelCellBo> propertyNameMap) {
    boolean validateResult = true;
    Set<ConstraintViolation<E>> validateSet = Validation.buildDefaultValidatorFactory().getValidator().validate(e, Default.class);
    if (validateSet != null && !validateSet.isEmpty()) {
        validateResult = false;
        ExcelErrorDTO errorDTO;
        for (ConstraintViolation<E> constraint : validateSet) {
            Path propertyPath = constraint.getPropertyPath();
            String propertyName = propertyPath.toString();
            ExcelCellBo bo = propertyNameMap.get(propertyName);
            errorDTO = new ExcelErrorDTO();
            errorDTO.setHeadName(bo.getHeadName());
            Object invalidValue = constraint.getInvalidValue();
            if (invalidValue != null) {
                errorDTO.setValue(invalidValue.toString());
            }else {
                errorDTO.setValue(null);
            }
            errorDTO.setColumnIndex(bo.getColumnIndex()+1);
            errorDTO.setRowIndex(bo.getRowIndex()+1);                  errorDTO.setErrMsg("第"+errorDTO.getRowIndex()+"第"+errorDTO.getColumnIndex()+"列,"+constraint.getMessage());
            errorList.add(errorDTO);
        }
    }
    return validateResult;
}

 

 Map<String, ExcelCellBo> getPropertyNameMap(boolean isSingleHeader, AnalysisContext analysisContext){
    Map<String, ExcelCellBo> propertyNameMap = new HashMap<>(16);
    ReadRowHolder readRowHolder = analysisContext.readRowHolder();
    Integer rowIndex = readRowHolder.getRowIndex();
    ReadHolder readHolder = analysisContext.currentReadHolder();
    ExcelReadHeadProperty excelReadHeadProperty = readHolder.excelReadHeadProperty();
    Collection<ExcelContentProperty> values;
    if (isSingleHeader){
        Map<Integer, ExcelContentProperty> contentPropertyMap = excelReadHeadProperty.getContentPropertyMap();
        values = contentPropertyMap.values();
    }else {
        //也适用于单行表头
        Map<String, ExcelContentProperty> fieldNameContentPropertyMap = excelReadHeadProperty.getFieldNameContentPropertyMap();
        values = fieldNameContentPropertyMap.values();
    }
    ExcelCellBo bo;
    for (ExcelContentProperty contentProperty : values) {
        bo = new ExcelCellBo();
        bo.setRowIndex(rowIndex);
        bo.setColumnIndex(contentProperty.getHead().getColumnIndex());
        bo.setFieldName(contentProperty.getHead().getFieldName());
        //多行表头
        bo.setHeadName(String.join(",",contentProperty.getHead().getHeadNameList()));
        bo.setField(contentProperty.getField());
        propertyNameMap.put(contentProperty.getHead().getFieldName(),bo);
    }
    return propertyNameMap;
}
@Data
public class ExcelCellBo {
    private Field field;
    private String fieldName;
    private String headName;
    private Integer columnIndex;
    private Integer rowIndex;
}

示例：

抽象父类代码：

package com.tzxx.common.domain.logic.excel;

import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.alibaba.excel.exception.ExcelDataConvertException;
import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.metadata.property.ExcelContentProperty;
import com.alibaba.excel.read.metadata.holder.ReadHolder;
import com.alibaba.excel.read.metadata.holder.ReadRowHolder;
import com.alibaba.excel.read.metadata.property.ExcelReadHeadProperty;
import com.tzxx.common.exception.BusinessException;
import lombok.Data;

import javax.validation.ConstraintViolation;
import javax.validation.Path;
import javax.validation.Validation;
import javax.validation.groups.Default;
import java.lang.reflect.Field;
import java.util.*;
import java.util.stream.Collectors;

/**
 * @author zhangliang
 * @date 2019/12/17.
 */
@Data
public abstract class AbstractDataListener<E> extends AnalysisEventListener<E>{
    protected List<E> dataList = new ArrayList<>();
    protected List<ExcelErrorDTO> errorList = new ArrayList<>();
    protected boolean success = true;
    protected ImportExcelResult<E, ExcelErrorDTO> result = new ImportExcelResult<>();
    protected List<String> headList = new ArrayList<>();
    protected boolean validate;


    protected Set<String> excelHeadNames = new HashSet<>();

    AbstractDataListener(List<String> headList,boolean validate){
        this.headList = headList;
        this.validate = validate;
    }

    AbstractDataListener(Class<E> c,boolean validate){
        Field[] declaredFields = c.getDeclaredFields();
        for (Field declaredField : declaredFields) {
            ExcelProperty annotation = declaredField.getAnnotation(ExcelProperty.class);
            if (annotation != null) {
                String[] value = annotation.value();
                headList.addAll(Arrays.asList(value));
            }
        }
        this.validate = validate;
    }

    @Override
    public void invokeHead(Map<Integer, CellData> headMap, AnalysisContext context) {
        Collection<CellData> head = headMap.values();
        excelHeadNames.addAll(head.stream().map(CellData::getStringValue).collect(Collectors.toList()));
        if (validate && !headList.containsAll(excelHeadNames)) {
            throw new BusinessException("导入的excel表头有误");
        }
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        result.setData(getDataList());
        result.setError(getErrorList());
        result.setSuccess(getErrorList().isEmpty());
        if (getErrorList().isEmpty() && getDataList().isEmpty()){
            result.setSuccess(false);
            ExcelErrorDTO errorDTO = new ExcelErrorDTO();
            errorDTO.setErrMsg("excel无数据");
            errorList.add(errorDTO);
        }
    }

    @Override
    public void onException(Exception exception, AnalysisContext context){
        if(exception instanceof ExcelDataConvertException){
            ExcelDataConvertException e = (ExcelDataConvertException)exception;
            handleExcelDataConvertException(e);
        }else {
            throw new BusinessException(exception.getMessage());
        }
    }

    /**使用javax validate校验
     * @param e 需要校验的对象
     * @param propertyNameMap 对象excel数据
     * @return true
     */
     boolean validate(E e, Map<String, ExcelCellBo> propertyNameMap) {
        boolean validateResult = true;
        Set<ConstraintViolation<E>> validateSet = Validation.buildDefaultValidatorFactory().getValidator().validate(e, Default.class);
        if (validateSet != null && !validateSet.isEmpty()) {
            validateResult = false;
            ExcelErrorDTO errorDTO;
            List<ExcelErrorDTO> list  = new ArrayList<>();
            for (ConstraintViolation<E> constraint : validateSet) {
                Path propertyPath = constraint.getPropertyPath();
                String propertyName = propertyPath.toString();
                ExcelCellBo bo = propertyNameMap.get(propertyName);
                errorDTO = new ExcelErrorDTO();
                errorDTO.setHeadName(bo.getHeadName());
                Object invalidValue = constraint.getInvalidValue();
                if (invalidValue != null) {
                    errorDTO.setValue(invalidValue.toString());
                }else {
                    errorDTO.setValue(null);
                }
                errorDTO.setColumnIndex(bo.getColumnIndex()+1);
                errorDTO.setRowIndex(bo.getRowIndex()+1);
                errorDTO.setErrMsg("第"+errorDTO.getRowIndex()+"行第"+errorDTO.getColumnIndex()+"列,"+constraint.getMessage());
                list.add(errorDTO);
            }
            Collections.sort(list);
            errorList.addAll(list);
        }
        return validateResult;
    }

    /**处理ExcelDataConvertException
     * @param e 字段转换异常
     */
     private void handleExcelDataConvertException(ExcelDataConvertException e){
        ExcelErrorDTO errorDTO = new ExcelErrorDTO();
        errorDTO.setHeadName(e.getExcelContentProperty().getHead().getHeadNameList().get(0));
        errorDTO.setValue(e.getCellData().getStringValue());
        errorDTO.setColumnIndex(e.getColumnIndex()+1);
        errorDTO.setRowIndex(e.getRowIndex()+1);
        errorDTO.setErrMsg("第"+errorDTO.getRowIndex()+"行第"+errorDTO.getColumnIndex()+"列,"+errorDTO.getHeadName()+"值格式错误");
        errorList.add(errorDTO);
    }

    /**获取excel PropertyNameMap
     * @param isSingleHeader 是否单表头
     * @param analysisContext AnalysisContext
     * @return Map
     */
     Map<String, ExcelCellBo> getPropertyNameMap(boolean isSingleHeader, AnalysisContext analysisContext){
        Map<String, ExcelCellBo> propertyNameMap = new HashMap<>(16);
        ReadRowHolder readRowHolder = analysisContext.readRowHolder();
        Integer rowIndex = readRowHolder.getRowIndex();
        ReadHolder readHolder = analysisContext.currentReadHolder();
        ExcelReadHeadProperty excelReadHeadProperty = readHolder.excelReadHeadProperty();
         Map<String, ExcelContentProperty> fieldNameContentPropertyMap = excelReadHeadProperty.getFieldNameContentPropertyMap();
         Collection<ExcelContentProperty> values = fieldNameContentPropertyMap.values();
        ExcelCellBo bo;
        for (ExcelContentProperty contentProperty : values) {
            bo = new ExcelCellBo();
            bo.setRowIndex(rowIndex);
            bo.setColumnIndex(contentProperty.getHead().getColumnIndex());
            bo.setFieldName(contentProperty.getHead().getFieldName());
            bo.setHeadName(contentProperty.getHead().getHeadNameList().get(0));
            bo.setField(contentProperty.getField());
            propertyNameMap.put(contentProperty.getHead().getFieldName(),bo);
        }
        return propertyNameMap;
    }
}

@Data
public class ImportExcelResult<T,E> {
    boolean success;
    List<T> data;
    List<E> error;
}

 使用：

@Slf4j
public class SimpleDataListener<E> extends AbstractDataListener<E>{


    public SimpleDataListener(List<String> headList){
        super(headList,true);
    }

    public SimpleDataListener(Class<E> c){
       super(c,true);
    }

    @Override
    public void invoke(E data, AnalysisContext analysisContext) {
        Map<String, ExcelCellBo> propertyNameMap = getPropertyNameMap(true,analysisContext);
        if (validate(data,propertyNameMap)) {
            dataList.add(data);
        }
    }
}

 

EasyExcel + Validation实现bean校验
adminstritor的博客
04-13 914
业务中可能存在多种导入需求，我们可以创建一个通用listener，就不用一个导入excel需求就创建一个独立的listener了。的invoke方法来进行逐行读取的, 所以我们可自定义listener来重写Invoke方法，将bean校验逻辑放入即可。Easyexcel是通过。1.通用listener。2.Bean校验工具类。
SpringBoot集成阿里easyexcel（二）Excel监听以及常用工具类
her_he的博客
06-15 4691
通过excel监听类，实现对数据解析时的监听，主要包括对表头、每行数据的校验并返回错误信息。在表格解析发生严重错误时，通过监听类拦截与处理并返回提示信息
easyexcel+validation excel导入导出下载
01-19
使用esayexcel作为excel导入导出工具代码 validation 作为excel内容校验 可运行，内置模板文件
ExcelJS终极指南：如何用JavaScript轻松处理复杂电子表格数据
最新发布
gitblog_00189的博客
11-12 534
在当今数据驱动的商业环境中，ExcelJS作为一款强大的JavaScript电子表格处理库，正在重新定义开发者处理Excel文件的方式。无论你是需要批量生成财务报告、处理大量数据导出，还是构建复杂的数据分析工具，ExcelJS都能为你提供完整的解决方案。 ## 为什么选择ExcelJS？ 传统的Excel处理方案往往面临性能瓶颈和功能限制，而ExcelJS通过纯JavaScript实现，提供了
EasyExcel校验数据抛异常需要使用ExcelAnalysisException
Mr1ght的博客
02-10 5214
使用Excel导入数据的时候，避免不了校验数据这个过程，在使用EasyExcel进行数据校验的时候，在AnalysisEventListener中抛异常要使用ExcelAnalysisException而不是自己定义的运行时异常，EasyExcel会捕捉所有的非ExcelAnalysisException异常并封装成ExcelAnalysisException抛出，如下。 private void onException(AnalysisContext analysisContext, Except
EasyExcel+Validator简单实践
u011706563的博客
01-19 1999
目录前言一、EasyExcel二、使用步骤1.引入库2.代码示例总结 前言 使用 阿里巴巴开源 easyExcel+Validator数据校验的一个简单实践，后续可根据自己需要进行模块化封装 一、EasyExcel EasyExcel 是阿里巴巴开源的操作Excel的jar包，可以简单快速的实现excel的上传下载模板导入等等....... 二、使用步骤 1.引入库 代码如下（示例）： <!-- easyExcel工具包 --> <dependency> <gr
EasyExcel导入数据校验（hibernate-validator）
xiajw的博客
09-16 5103
最近做项目，在使用EasyExcel做数据导入的时候，没有找到什么好的数据校验方法，很多博客都是直接写代码进行校验，感觉很麻烦，因此思考能不能有什么简便的方法。大家都知道web项目，在controller层的方法上加@Validated注解，调用接口的时候会自动进行参数校验，于是思考能不能通过同样的方法对EasyExcel导入的数据进行校验。
Java程序设计：spring boot（14）——数据校验 - Validation
茜茜西西的博客
10-31 473
⽇常项⽬开发中，对于前端提交的表单，后台接⼝接收到表单数据后，为了程序的严谨性，通常后端 会加⼊业务参数的合法校验操作来避免程序的⾮技术性 bug，这⾥对于客户端提交的数据校验， SpringBoot 通过 spring-boot-starter-validation 模块包含了数据校验的⼯作。这⾥主要介绍 Spring Boot 中对请求数据进⾏校验，相关概念如下。
easyexcel导入导出包含 自定义列宽，下拉框，日期校验，批量导入入库完整开发流程
qq_30072161的博客
10-26 3255
1. 引入maven依赖 <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.2.7</version> </dependency> 2. 创建工具类 2.1 ExcelUtil.java(设置头背景，浅绿，宋体，对齐方式) import com.alibab
EasyExcel实现excel导入(模版上传)
程序猿学社的博客
02-19 934
easyExcel实现excel导入，如果有错误返回错误excel
EasyExcel+线程池+批量插入实现百万级数据导入：从原理到实战的完整指南
longgelaile的博客
09-09 532
本文介绍了一种高效处理百万级数据导入的优化方案，通过结合EasyExcel流式读取、线程池并发处理和JDBC批量插入技术，将传统单线程逐条插入方式从小时级优化到分钟级。方案采用生产者-消费者模式，使用阻塞队列作为数据缓冲区，通过线程池实现并行处理，并采用批量插入方式减少数据库交互次数。文中详细展示了核心实现代码，包括数据实体类、导入服务类、Controller层实现及数据库优化配置，并提供了性能测试数据（100万条数据从4500秒优化到195秒）。同时针对常见问题（内存溢出、连接池耗尽、数据重复等）给出了解
EasyExcel 并发读取文件字段并进行校验，数据写入到新文件，批量插入数据到数据库
09-29
EasyExcel 并发读取文件字段并进行校验，数据写入到新文件，批量插入数据到数据库 demo
eaasyexcel批量导入+校验
12-13
EasyExcel重写了POI对07Excel的解析，解决一部分了内存消耗特大的问题03版本任依赖POI的SAX模式 EasyExcel特点 1.数据模型层面进行了封装，使用简单 2.重写了07版本的Excel解析代码，减低内存消耗，可以有效避免OOM 3.只能操作Excel 4.不能读取图片 5.读写Excel，数据在excel文件，程序两个载体之间 互相流转
excel通过配置实现导入导出和校验
02-02
excel通过配置实现导入导出和校验，只要写配置文件就可以定义导出样式和导入的校验规则，可以直接到项目中使用
批量导入Excel数据到数据库,带数据校验/事务回滚
06-02
批量导入Excel数据到数据库，.NET开发，带数据校验、事务回滚、Excel预览、日志功能的完整开发实例
EasyValidate优雅地校验提交数据完整性
08-26
主要介绍了EasyValidate优雅地校验提交数据完整性，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
EasyExcel使用Validator进行读取校验,批量处理数据,返回处理异常的行以及列
Memory_loss的博客
03-12 2279
使用EasyExcel读取Excel文件.使用Validator进行数据校验,并批量处理数据,以及返回处理错误行数
easypoi实战：（一）应用hibernate-validation来验证excel的导入数据合法性
热水钟博客
06-13 3287
一、hibernate-validation验证框架常见注解 @Null被注释的元素必须为 null @NotNull被注释的元素必须不为 null @AssertTrue被注释的元素必须为 true @AssertFalse被注释的元素必须为 false @Min(value)被注释的元素必须是...
【EasyExcel】提供工具类检查表头是否匹配
欢迎来到 程序猿 的博客
02-24 5464
代码已出：easyexcel 检查表头是否匹配 封装了easyExcel的工具类，包含字段校验功能，可使用validate校验
java使用easyexcel导入数据校验数据格式
08-29
在 Java 中使用 EasyExcel 导入数据时进行数据格式校验可以通过以下几种常见的方法实现： ### 自定义监听器校验 可以自定义一个监听器类，继承 `AnalysisEventListener`，在监听器中对读取的数据进行格式校验。以下是示例代码： ```java import com.alibaba.excel.context.AnalysisContext; import com.alibaba.excel.event.AnalysisEventListener; import java.util.ArrayList; import java.util.List; // 假设这是数据实体类 class DemoData { private String name; private Integer age; // Getters and Setters public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } } // 自定义监听器 class DemoDataListener extends AnalysisEventListener<DemoData> { private List<DemoData> validDataList = new ArrayList<>(); private List<String> errorMessages = new ArrayList<>(); @Override public void invoke(DemoData data, AnalysisContext context) { // 进行数据格式校验 if (data.getName() == null || data.getName().isEmpty()) { errorMessages.add("姓名不能为空，当前行数据：" + data.toString()); return; } if (data.getAge() == null || data.getAge() < 0) { errorMessages.add("年龄必须为正整数，当前行数据：" + data.toString()); return; } validDataList.add(data); } @Override public void doAfterAllAnalysed(AnalysisContext context) { // 处理校验完成后的逻辑，如输出错误信息或保存有效数据 if (!errorMessages.isEmpty()) { for (String error : errorMessages) { System.err.println(error); } } } public List<DemoData> getValidDataList() { return validDataList; } } ``` 使用示例： ```java import com.alibaba.excel.EasyExcel; import java.io.File; public class Main { public static void main(String[] args) { String filePath = "your_excel_file.xlsx"; DemoDataListener listener = new DemoDataListener(); EasyExcel.read(new File(filePath), DemoData.class, listener).sheet().doRead(); List<DemoData> validData = listener.getValidDataList(); // 处理有效数据 } } ``` ### 使用注解校验 可以在实体类的属性上使用注解进行校验，结合 Hibernate Validator 等校验框架。首先需要添加 Hibernate Validator 的依赖： ```xml <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <version>6.2.0.Final</version> </dependency> ``` 然后在实体类上添加注解： ```java import javax.validation.constraints.NotBlank; import javax.validation.constraints.Positive; class DemoData { @NotBlank(message = "姓名不能为空") private String name; @Positive(message = "年龄必须为正整数") private Integer age; // Getters and Setters public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } } ``` 在监听器中进行校验： ```java import com.alibaba.excel.context.AnalysisContext; import com.alibaba.excel.event.AnalysisEventListener; import javax.validation.ConstraintViolation; import javax.validation.Validation; import javax.validation.Validator; import java.util.ArrayList; import java.util.List; import java.util.Set; class DemoDataListener extends AnalysisEventListener<DemoData> { private List<DemoData> validDataList = new ArrayList<>(); private List<String> errorMessages = new ArrayList<>(); private Validator validator = Validation.buildDefaultValidatorFactory().getValidator(); @Override public void invoke(DemoData data, AnalysisContext context) { Set<ConstraintViolation<DemoData>> violations = validator.validate(data); if (!violations.isEmpty()) { for (ConstraintViolation<DemoData> violation : violations) { errorMessages.add(violation.getMessage() + "，当前行数据：" + data.toString()); } return; } validDataList.add(data); } @Override public void doAfterAllAnalysed(AnalysisContext context) { if (!errorMessages.isEmpty()) { for (String error : errorMessages) { System.err.println(error); } } } public List<DemoData> getValidDataList() { return validDataList; } } ```
评论 5
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值