Spring 之 javax.validation

深藏阁楼爱情的钟 2024-04-01 18:02 53阅读 0赞

> 作用：对 Controller 层接口的入参做校验

### 常用注解 ###

<table> 
 <thead> 
  <tr> 
   <th>验证注解</th> 
   <th>验证的数据类型</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@AssertFalse</td> 
   <td>Boolean,boolean</td> 
   <td>验证注解的元素值是false</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td>Boolean,boolean</td> 
   <td>验证注解的元素值是true</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>任意类型</td> 
   <td>验证注解的元素值不是null</td> 
  </tr> 
  <tr> 
   <td>@Null</td> 
   <td>任意类型</td> 
   <td>验证注解的元素值是null</td> 
  </tr> 
  <tr> 
   <td>@Min(value=值)</td> 
   <td>BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型</td> 
   <td>验证注解的元素值大于等于@Min指定的value值</td> 
  </tr> 
  <tr> 
   <td>@Max（value=值）</td> 
   <td>和@Min要求一样</td> 
   <td>验证注解的元素值小于等于@Max指定的value值</td> 
  </tr> 
  <tr> 
   <td>@DecimalMin(value=值)</td> 
   <td>和@Min要求一样</td> 
   <td>验证注解的元素值大于等于@ DecimalMin指定的value值</td> 
  </tr> 
  <tr> 
   <td>@DecimalMax(value=值)</td> 
   <td>和@Min要求一样</td> 
   <td>验证注解的元素值小于等于@ DecimalMax指定的value值</td> 
  </tr> 
  <tr> 
   <td>@Digits(integer=整数位数, fraction=小数位数)</td> 
   <td>和@Min要求一样</td> 
   <td>验证注解的元素值的整数位数和小数位数上限</td> 
  </tr> 
  <tr> 
   <td>@Size(min=下限, max=上限)</td> 
   <td>字符串、Collection、Map、数组等</td> 
   <td>验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>java.util.Date,java.util.Calendar;Joda Time类库的日期类型</td> 
   <td>验证注解的元素值（日期类型）比当前时间早</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td>与@Past要求一样</td> 
   <td>验证注解的元素值（日期类型）比当前时间晚</td> 
  </tr> 
  <tr> 
   <td>@NotBlank</td> 
   <td>CharSequence子类型</td> 
   <td>验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格</td> 
  </tr> 
  <tr> 
   <td>@Length(min=下限, max=上限)</td> 
   <td>CharSequence子类型</td> 
   <td>验证注解的元素值长度在min和max区间内</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td>CharSequence子类型、Collection、Map、数组</td> 
   <td>验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）</td> 
  </tr> 
  <tr> 
   <td>@Range(min=最小值, max=最大值)</td> 
   <td>BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型</td> 
   <td>验证注解的元素值在最小值和最大值之间</td> 
  </tr> 
  <tr> 
   <td>@Email(regexp=正则表达式,flag=标志的模式)</td> 
   <td>CharSequence子类型（如String）</td> 
   <td>验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式</td> 
  </tr> 
  <tr> 
   <td>@Pattern(regexp=正则表达式,flag=标志的模式)</td> 
   <td>String，任何CharSequence的子类型</td> 
   <td>验证注解的元素值与指定的正则表达式匹配</td> 
  </tr> 
  <tr> 
   <td>@Valid</td> 
   <td>任何非原子类型</td> 
   <td>指定递归验证关联的对象如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证</td> 
  </tr> 
 </tbody> 
</table>

### 注解使用示例 ###

@Data
    public class User {
    
        @NotNull(message = "任意类型，验证注解的元素值不是null")
        // BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型，验证注解的元素值大于等于@Min指定的value值
        @Max(message = "ID不能大于1000",value = 1000)
        // 和@Min要求一样，验证注解的元素值小于等于@Max指定的value值
        @Min(message = "ID不能小于10", value = 10)
        private Long id;
    
        // BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型
        @Range(message = "验证注解的元素值在最小值和最大值之间", min = 0, max = 150)
        private Integer age;
    
    
        // CharSequence子类型，验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
        @NotBlank(message = "名称不能为空")
        // CharSequence子类型，验证注解的元素值长度在min和max区间内
        @Length(message = "名称长度限制在 6 到 15 个字符之间", min = 6, max = 15)
        private String name;
    
    
        // 和@Min要求一样，验证注解的元素值大于等于@ DecimalMin指定的value值
        @DecimalMin(message = "最小金额为 10.00 元", value = "10.00")
        // 和@Min要求一样，验证注解的元素值小于等于@ DecimalMax指定的value值
        @DecimalMax(message = "金额上限为 99.99 元", value = "99.99")
        // 和@Min要求一样。验证注解的元素值的整数位数和小数位数上限
        @Digits(message = "两位小数",integer = 2,fraction = 2)
        private BigDecimal money;
    
    
        // CharSequence子类型、Collection、Map、数组。验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
        @NotEmpty(message = "拥有角色编码不能为空")
        // 字符串、Collection、Map、数组等.验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
        @Size(message = "角色拥有的权限在 2 到 10 个之间", min = 1, max = 10)
        List<String> hasCode;
    
    
        // CharSequence子类型（如String）.验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
        @Email(message = "邮箱格式不正确", regexp = "")
        private String email;
    
    
        // java.util.Date,java.util.Calendar;Joda Time类库的日期类型.验证注解的元素值（日期类型）比当前时间晚
        @Future(message = "创建必须大于现在")
    //    @Past(message = "创建事件必须小于当前")
        private LocalDateTime createTime;
    }

### Controller 接口 ###

@PostMapping("/hello")
    public String hello(@RequestBody @Validated User user){
        return "hello";
    }

### @Valid和@Validated 区别 ###

查看源码：

@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Validated {
        Class<?>[] value() default {};
    }

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Valid {
    }

@Valid：没有分组的功能。

@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上

@Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制

@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上

两者是否能用于成员属性（字段）上直接影响能否提供嵌套验证的功能