简化excel校验提高开发效率

业务背景：上传excel文件进行基础数据校验，然而东西太多写着写着就...自然成了测试的KPI了

解决思路：使用现有的注解处理，原理使用@validate注解原理

直接上干货，一行代码搞定校验：

ValidateUtils.validate(List.of(fieldReq));

目录

工具类

测试实体

---

工具类

import jakarta.annotation.Resource;
import jakarta.validation.ConstraintViolation;
import jakarta.validation.Validator;
import org.springframework.stereotype.Component;

import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * date:2025/4/23 22:56
 * author: haohaounique@163.com
 */
@Component
public class ValidateUtils {

    public static final String TIP = "第%s行数据异常,%s,请检查";
    //注意jdk版本不同引入的包不同
    //import jakarta.validation.Validator;
    //import javax.validation.Validator;
    private static Validator validator;

    public Validator getValidator() {
        return validator;
    }

    @Resource
    public void setValidator(Validator validator) {
        ValidateUtils.validator = validator;
    }


    //默认从第1行开始 index=1
    public static <T> void validate(List<T> list) {
        if (Objects.isNull(list) || list.isEmpty()) {
            return;
        }
        AtomicInteger atomicInteger = new AtomicInteger(0);
        for (T t : list) {
            int lineNo = atomicInteger.addAndGet(1);
            Set<ConstraintViolation<T>> validate = validator.validate(t);
            if (!validate.isEmpty()) {
                //可自定义
                throw new IllegalArgumentException(String.format(TIP,lineNo,validate.iterator().next().getMessage()));
            }
        }
    }
    //指定起始行号
    public static <T> void validate(List<T> list,Integer startIndex) {
        if (Objects.isNull(list) || list.isEmpty()) {
            return;
        }
        if (startIndex==null || startIndex<0) {
            startIndex = 0;
        }
        AtomicInteger atomicInteger = new AtomicInteger(startIndex);
        for (T t : list) {
            int lineNo = atomicInteger.addAndGet(1);
            Set<ConstraintViolation<T>> validate = validator.validate(t);
            if (!validate.isEmpty()) {
                //可自定义
                throw new IllegalArgumentException(String.format(TIP,lineNo,validate.iterator().next().getMessage()));
            }
        }
    }
}

测试实体

import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import lombok.Data;

/**
 * date:2025/3/16 9:33
 * author: haohaounique@163.com
 */
@Data
@Schema(description = "规则配置添加请求")
public class RuleConfigAddReq {
    /**
     * 规则KEY
     */
    @Schema(description = "规则KEY",requiredMode = Schema.RequiredMode.REQUIRED)
    @NotBlank(message = "规则KEY不能为空")
    private String ruleKey;

    /**
     * 字段名称
     */
    @Schema(description = "字段名称")
    @NotBlank(message = "字段名称不能为空")
    private String fieldName;

    /**
     * 字段描述
     */
    @Schema(description = "字段描述")
    @NotBlank(message = "字段描述不能为空")
    private String fieldDescription;

    /**
     * 类名
     */
    @Schema(description = "类名")
    @NotBlank(message = "类名不能为空")
    private String className;

    /**
     * 类描述
     */
    @Schema(description = "类描述")
    @NotBlank(message = "类描述不能为空")
    private String classDescription;

    /**
     * 表达式
     */
    @Schema(description = "表达式")
    @NotBlank(message = "表达式不能为空")
    private String expression;

    /**
     * 顺序
     */
    @Schema(description = "顺序")
    @NotNull(message = "顺序不能为空")
    private Integer ruleOrder;

    /**
     * 提示信息
     */
    @Schema(description = "提示信息")
    @NotBlank(message = "提示信息编码不能为空")
    private String tipCode;

    /**
     * 提示信息
     */
    @Schema(description = "提示信息")
    @NotBlank(message = "提示信息不能为空")
    private String tipMessage;
}

仿上传之后用easyexcel解析后生成的实体对象进行测试【此处省略上传解析，工具类待后续文章补充】

    @RequestMapping("/validate")
    public void validate() {
        RuleConfigAddReq ruleConfigAddReq = new RuleConfigAddReq();
        ruleConfigAddReq.setRuleKey("ruleKey");
        ruleConfigAddReq.setFieldName("fieldName");
        ruleConfigAddReq.setFieldDescription("fieldDescription");
        ruleConfigAddReq.setClassName("className");
        ruleConfigAddReq.setClassDescription("classDescription");
        ruleConfigAddReq.setExpression("expression");
        ruleConfigAddReq.setRuleOrder(1);
        FieldReq fieldReq = new FieldReq();
        //
        ValidateUtils.validate(List.of(fieldReq));
    }