Valid相关校验-全面解决开发中遇到的各种校验问题

我们在开发的过程中难免会遇到各种用户输入的校验，当然你用【if else】能完成开发。如果你是开发几个月的初级程序员你这样写可以，但是如果你已经是一个三年开发经验的程序员老司机了【你已经是一个成熟的程序猿了，写的程序一定要能自动运行】，你还一直写【if else】那就显得你太low了，老板看到你这样写代码那升职加薪肯定把你排到最后。那怎样才能写出看出比较高级的代码呢？好了下面就带大家完成各种形式的校验，开发中一定用得到。

使用Valid校验你首先要了解什么是JSR303。

SR303是Java为Bean数据合法性校验提供给的标准框架，已经包含在 JavaEE6.0中，JSR303通过在Bean 属性中标注类似 @NotNull @Max 等标准的注解指定校验规则，并通过标准的验证接口对 Bean进行验证。

写到这里有些读者感觉到这篇文章和网上讲的那些差不多，不看了。但是你一定要继续看下去，肯定比网上讲的更深入，值得你继续看下去，你开发中一定能用的到，毕竟任何深入的问题都要从基础聊起。【就好像有的人你刚认识感觉他是很普通，但是你慢慢的往后面去了解才发现他不简单，是你喜欢的类型。哈哈哈，我是一个技术搞笑情感博主】

JSR303中含有的注解。

Null 被注释的元素必须为 null 

@NotNull 被注释的元素必须不为 null

@Size(max=, min=) 被注释的元素的大小必须在指定的范围内 

@Digits (integer, fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内。 

@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式 @URL(message = "logo必须是一个合法的url地址"）

更多注解请参考这个包（javax.validation.constraints）下面的所有的注解类，请看上面的注解还允许写上正则表达式。

好了讲了不少大道理，然后带着大家用代码展示怎样运用。Talk is cheap, Show me the code【至理英文英文名言，看文章还能学英语】。

首先你要有校验的对象，也就是一个自己建的实体类如下，仔细看每个字段的注解都很有代表性，开发中应该也常用。

/**
 * 给的属性都是很有代表性的。
 */
@Data
public class UserDTO {
    @NotBlank(message = "姓名不能为空")
    private String name ; // 姓名
    @Pattern(regexp = "^\\w+$",message = "密码只能输入英文，数字和下划线")
    @NotBlank(message = "密码不能为空")
    private String password ; // 密码
    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp = "^(?:(?:\\+|00)86)?1[3-9]\\d{9}$",message = "请输入正确的手机号")
    private String mobilePhone ; // 手机号
    @NotBlank(message = "邮箱不能为空")
    @Email(message = "请输入正确邮箱")
    private String email ; // 邮箱
    @NotBlank(message = "日期不能为空")
    @Pattern(regexp = "^(([0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]{1}|[0-9]{1}[1-9][0-9]{2}|[1-9][0-9]{3})-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|11)-(0[1-9]|[12][0-9]|30))|(02-(0[1-9]|[1][0-9]|2[0-8]))))" +
            "|((([0-9]{2})(0[48]|[2468][048]|[13579][26])|((0[48]|[2468][048]|[3579][26])00))-02-29)$",message = "请输入正确的日期")
    private String startDate ; // 开始时间
    @Digits(integer = 10,fraction = 2,message = "存款不正确")
    @NotNull(message = "存款不能为空")
    private BigDecimal totalAmount ; // 存款
    private String  sex ; //男或者女。

好了有了对象那校验怎么生效呢？我们都是在Controller层接收对象，请看如下代码（不讲大道理，只聊代码，我是一个码农）。

/**
    * 解释一下校验怎么才能生效。
    * 1：要校验的对象前加@Valid注解。
    *  2：要校验的对象后加  BindingResult bindingResult
    *  然后校验就生效了，不必写那种if else 了。
    *  下面我打印出来了错误信息。具体错误怎么显示大家看看这个BindingResult对象的API很简单
    *   因为开发中各个需求要求的错误信息展示不同。
    */
    @PostMapping("/insert")
    public  void insertUser(@RequestBody @Valid UserDTO user, BindingResult bindingResult){
         if (bindingResult.hasErrors()){
             List<ObjectError> allErrors = bindingResult.getAllErrors();
             FieldError fieldError = bindingResult.getFieldError();
             for (ObjectError erros:allErrors) {
                 System.out.println("错误信息："+erros.getDefaultMessage());
             }
         }
    }

然后我使用postman测试一下：

打印的错误信息如下，完全符合我们的验证。

看完上面的你感觉很简单，这些我都会啊，没啥看的有没有点新鲜的，比如某些字段的校验是没有注解可支持的，能不能写一个自定义的注解，这样开发的时候可扩展性就强了。嘿，小子你说到我心坎里了，后面我刚好要讲。【咱俩心心相惜，交个朋友吧，呸这种话千万别信】。

下面就写一个自定义的注解，我的原则就是不讲那些大道理直接上代码。

@Documented
// 所有自定义注解的规则校验都在SexValueConstraintValidator类中
@Constraint(validatedBy = { SexValueConstraintValidator.class})
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
// 自定义的注解
public @interface SexValueValid {

    String message() default "";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}
public class SexValueConstraintValidator implements 
ConstraintValidator<SexValueValid,String> {
    
    /**
    * 校验规则就在这个实现类中，我的逻辑是 sex字段只能是 男或者女。
    *  其他任何值都不行。代码逻辑很简单，应该都能看懂。
    *  你开发的时候的校验逻辑也都写在这里就行。
    */
    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if (StrUtil.isBlank(s)){
            return  false ;
        }
        // 只能是 男或者女。
        if (StrUtil.equalsAny(s,"男","女")){
            return  true ;
        }
        return false;
    }
}

好了后面直接使用这个注解就行如下：

然后我们测试一下：

报错信息如下：

完美的完成了校验，有了自定义注解应该就能弥补系统给我们提供的那些注解的不足了，能解决我们开发中遇到的大多数的问题了。文章看到这里我没骗你吧，没白看吧，我说过我是不会骗你的【呸，这是渣男喜欢说的话】。

写到这里我也很高兴了，但是这个时候又有小伙伴提出问题了，前端传给后台的不一定只是一个单独的对象，如果前端传给后端的是一个集合对象呢？你目前写的就不支持了吧。哈哈哈，你提问的好，这个问题是需要解决的，开发中传集合的还是有不少呢，满足你，帮你解决这个难题。我就不演示那些错误的验证集合的代码了直接上正确的代码。

// 1:首先创建如下的类
@Data
public class ValidList<E> implements List<E> {
    @Valid
    private List<E> list = new ArrayList<>();//这里看需要实例化需要的List类型

    @Override
    public int size() {
        return list.size();
    }

    @Override
    public boolean isEmpty() {
        return list.isEmpty();
    }

    @Override
    public boolean contains(Object o) {
        return list.contains(o);
    }

    @Override
    public Iterator<E> iterator() {
        return list.iterator();
    }

    @Override
    public Object[] toArray() {
        return list.toArray();
    }

    @Override
    public <T> T[] toArray(T[] a) {
        return list.toArray(a);
    }

    @Override
    public boolean add(E e) {
        return list.add(e);
    }

    @Override
    public boolean remove(Object o) {
        return list.remove(o);
    }

    @Override
    public boolean containsAll(Collection<?> c) {
        return list.containsAll(c);
    }

    @Override
    public boolean addAll(Collection<? extends E> c) {
        return list.addAll(c);
    }

    @Override
    public boolean addAll(int index, Collection<? extends E> c) {
        return list.addAll(index, c);
    }

    @Override
    public boolean removeAll(Collection<?> c) {
        return list.removeAll(c);
    }

    @Override
    public boolean retainAll(Collection<?> c) {
        return list.retainAll(c);
    }

    @Override
    public void clear() {
        list.clear();
    }

    @Override
    public E get(int index) {
        return list.get(index);
    }

    @Override
    public E set(int index, E element) {
        return list.set(index, element);
    }

    @Override
    public void add(int index, E element) {
        list.add(index, element);
    }

    @Override
    public E remove(int index) {
        return list.remove(index);
    }

    @Override
    public int indexOf(Object o) {
        return list.indexOf(o);
    }

    @Override
    public int lastIndexOf(Object o) {
        return list.lastIndexOf(o);
    }

    @Override
    public ListIterator<E> listIterator() {
        return list.listIterator();
    }

    @Override
    public ListIterator<E> listIterator(int index) {
        return list.listIterator(index);
    }

    @Override
    public List<E> subList(int fromIndex, int toIndex) {
        return list.subList(fromIndex, toIndex);
    }
}
// 2:Controller接收参数这样写：
    @PostMapping("/batchInsert")
    public  void batchInsertUser(@RequestBody @Validated ValidList<UserDTO> users,BindingResult bindingResult){
        if (bindingResult.hasErrors()){
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            List<FieldError> fieldErrors = bindingResult.getFieldErrors();
            for (FieldError fieldError:fieldErrors) {
                System.out.println("错误的字段："+ fieldError.getField());  ;
                System.out.println("错误信息："+fieldError.getDefaultMessage());
            }
            
        }
    }
    // 好了没有了上面2个步骤就可以了,错误信息我打印出来了，开发中你按照
    // 你们的需求对错误信息进行灵活展示就行。

测试如下：

报错信息如下：

 好了通过上面3个例子开发中的验证需求应该基本满足了，小伙伴这下应该也没啥疑问了吧，赶紧分享给你的小伙伴，开发中遇到这种验证的需求，拿出文章按照例子据举芦画瓢就可以了，当你领导看到你验证的代码有进步时候说不定升职加薪就到你了。当然有些大神可能看到这篇文章比较简单也请你多多包涵，但是有的粉丝有可能是刚开始做开发的小白他们应该十分需要看这样的文章。如果你感觉文章不错，欢迎分享给你的朋友啊，也十分欢迎你给我提出意见只要说的有道理我都会虚心接受的。