背景介绍

Excel数据导入是很常见的功能，可很多时候客户导入的数据未必能入库，比如字段超长，类型错误……等。在产品经理提出要做数据校验的时候你难道要一个字段一个字段去校验？而且系统有几十张表都需要类似的功能，更何况客户导入的数据成千上万条数据，如果每次提示某个字段错误肯定是不友好的。要求是提示excel某行某些字段发生了什么错误。

网络上找了许久没有找到能方便灵活控制错误信息，和我们系统符合的工具，索性自己写一个用吧。废话不多说，利用注解完成相应数据校验。

1.注解类

import java.lang.annotation.*;

/**
 * @author 郏高阳
 * @date 2020/9/2
 * @jdk.version 1.8
 * @desc javaBean校验注解
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Verify {

    /**
     * 字段名称
     * @return
     */
    String name() default "";

    /**
     * 最大长度 0不校验大于0才生效
     * @return
     */
    int maxLength() default 0;

    /**
     * 必填
     * @return
     */
    boolean required() default false;

    /**
     * 是否包含特殊字符
     * @return
     */
    boolean specialCharacters() default false;

    /**
     * 数字验证
     * @return
     */
    boolean number() default false;

    /**
     * 正则
     * @return
     */
    Regexp regexp() default @Regexp();
}

/**
 * @author 郏高阳
 * @date 2020/9/2
 * @jdk.version 1.8
 * @desc 用于校验正则注解类
 */
public @interface Regexp {
    String regexp() default "";
    String message() default "";
}

2.校验工具类

import cn.hutool.core.util.NumberUtil;
import cn.hutool.core.util.ReUtil;
import cn.hutool.core.util.ReflectUtil;
import org.apache.commons.lang3.StringUtils;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

/**
 * @author 郏高阳
 * @Type VerifyUtils.java
 * @date 2020/9/2
 * @jdk.version 1.8
 * @desc javaBean校验工具类
 */

//@Verify(maxLength = 10, required = true, number = true)
//private String f32;
//@Verify(regexp = @Regexp(regexp = "\\w+[\u4E00-\u9FFF]+\\d+", message = "正则不匹配"), specialCharacters = true)
//private String f33;

public class VerifyUtils {

    /**
     * 校验对象
     *
     * @param obj 对象
     * @return 错误信息
     */
    public static List<String> verify(Object obj) {
        List<String> stringList = new ArrayList<>();
        Field[] fields = obj.getClass().getDeclaredFields();
        for (Field f : fields) {
            if (f.isAnnotationPresent(Verify.class)) {
                StringBuilder stringBuilder = new StringBuilder();
                Verify verify = f.getAnnotation(Verify.class);
                Object object = ReflectUtil.getFieldValue(obj, f.getName());
                String value = null;
                if (object != null) value = object.toString();

                if (verify.required()) {
                    if (StringUtils.isBlank(value)) {
                        stringBuilder.append("字段不能为空|");
                    }
                }

                if (StringUtils.isNotBlank(value)) {
                    if (verify.specialCharacters()) {
                        if (value.contains("|") || value.contains("'") || value.indexOf('"') > -1) {
                            stringBuilder.append("包含非法字符|");
                        }
                        if (value.length() != value.trim().length()) {
                            stringBuilder.append("前后不能包含空格|");
                        }
                    }
                    if (verify.maxLength() > 0) {
                        if (value.length() > verify.maxLength()) {
                            stringBuilder.append("内容长度超长|");
                        }
                    }
                    if (verify.number()) {
                        if (!NumberUtil.isNumber(value)) {
                            stringBuilder.append("不是数字类型|");
                        }
                    }
                    Regexp regexp = verify.regexp();
                    if (StringUtils.isNotBlank(regexp.regexp())) {
                        boolean isMatch = ReUtil.isMatch(regexp.regexp(), value);
                        if (!isMatch) {
                            stringBuilder.append(regexp.message()).append("|");
                        }
                    }
                }
                if (StringUtils.isNotBlank(stringBuilder.toString())) {
                    String name = verify.name();
                    if (StringUtils.isBlank(name)) {
                        name = f.getName();
                    }
                    String message = name + "：" + stringBuilder.substring(0, stringBuilder.toString().length() - 1);
                    stringList.add(message);
                }
            }
        }
        return stringList;
    }
}