SpringMVC中使用@Valid和@Validate俩个注解进行进行参数校验

太过爱你忘了你带给我的痛 2022-12-27 01:29 169阅读 0赞

下面是一些常用的验证注解

空检查
    
    @Null                            验证对象是否为null
    
    @NotNull                         验证对象是否不为null, 无法查检长度为0的字符串
    
    @NotBlank                        检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
    
    @NotEmpty                        检查约束元素是否为NULL或者是EMPTY.
    
    Booelan检查
    
    @AssertTrue                      验证 Boolean 对象是否为 true 
    
    @AssertFalse                     验证 Boolean 对象是否为 false 
    
    长度检查
    
    @Size(min=, max=)                验证对象（Array,Collection,Map,String）长度是否在给定的范围之内 
    
    @Length(min=, max=)              验证注解的元素值长度在min和max区间内
    
    日期检查
    
    @Past                            验证 Date 和 Calendar 对象是否在当前时间之前 
    
    @Future                          验证 Date 和 Calendar 对象是否在当前时间之后 
    
    @Pattern                         验证 String 对象是否符合正则表达式的规则
    
    数值检查，建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null
    
    @Min                             验证 Number 和 String 对象是否大等于指定的值 
    
    @Max                             验证 Number 和 String 对象是否小等于指定的值 
    
    @DecimalMax                      被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
    
    @DecimalMin                      被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
    
    @Digits                          验证 Number 和 String 的构成是否合法 
    
    @Digits(integer=,fraction=)      验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
    
    @Range(min=, max=)               验证注解的元素值在最小值和最大值之间
    
    
    @Valid                           递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
    
    @CreditCardNumber                信用卡验证--目前貌似只支持国外的
    
    @Email                           验证是否是邮件地址，如果为null,不进行验证，算通过验证。
    
    @ScriptAssert(lang= ,script=, alias=)
    
    @URL(protocol=,host=, port=,regexp=, flags=)

@Valid和@Validated的区别：  
  1. `@Valid` 是javax包下的一个注解，`@Validated`是spring包下的一个注解。  
  2. `@Valid` 不支持分组校验，`@Validated`支持分组校验  
  3. `@Valid` 可以作用在成员变量上，`@Validated`不能作用在成员变量上，所以想要进行嵌套验证，可以使用在成员变量上使用`@Valid`注解，在方法的参数上使用@Validated注解

> 详情可以参考 [https://blog.csdn.net/wangjiangongchn/article/details/86477386][https_blog.csdn.net_wangjiangongchn_article_details_86477386]

## 演示 ##

person对象

@Data
    public class Person {
    
        @NotEmpty(message = "姓名不能为空")
        private String name;
    
        @Min(value = 18,message = "年龄必须要大于18")
        private Integer age;
    
        @Valid //用来进行嵌套验证
        @NotNull(message = "兴趣爱好不能为空")
        private Hobby hobby;
    }

hobby对象

@Data
    public class Hobby {
    
        @NotEmpty(message = "兴趣爱好名称不能为空")
        private String name;
    
    }

@PostMapping("/test")
     //BindingResult 是用来处理绑定结果的，可以通过这个对象来获取参数绑定过程中是否发生错误
        public String test(@RequestBody @Validated Person a , BindingResult bindingResult){
            if (bindingResult.hasErrors()) {
                bindingResult.getAllErrors().forEach(objectError -> {
                    System.out.println(objectError.getDefaultMessage());
                });
            return "error";
            }
            return "success";
        }

当我传入的参数对象为：

{
        "name": "老王"
    }

控制台打印：

兴趣爱好不能为空

这里觉得比较有问题的是，在Person对象中的age属性上明明加上`@Min`注解，但是没有传age也能通过校验，这需要在age上加上`@NotNull`注解来控制

## 总结 ##

[@Valid][Valid] 和Validated在接受参数校验上还是比较好用的，在也不用通过`if-else`去判断校验来，此外，除了上述的常用校验注解以外还可以自定义校验注解来满足个别需要特殊校验规则的参数

[https_blog.csdn.net_wangjiangongchn_article_details_86477386]: https://blog.csdn.net/wangjiangongchn/article/details/86477386
[Valid]: https://my.oschina.net/u/3652407