SpringMVC、SpingBoot的参数校验之@Validated，体验分组校验的优雅之处

深碍√TFBOYSˉ_ 2024-04-18 18:01 53阅读 0赞

**VO类里面可以使用JSR-303校验注解，在Controller的请求参数里面也可以使用，但是只建议少量简单参数，此时的@Validated注解需要加到类上面，还有一个和该注解类似的@Valid，但是Spring提供的更加强大，提供分组的功能**

在检验 Controller 的入参是否符合规范时, 使用 @Validated 来校验传入数据, 如果数据异常则会统一抛出异常，方便异常中心统一处理

测试工具可以使用 `Postman` 个人感觉还是很不错的

#### 对象中添加对应功能注解 ####

注解标签需要加在 bean 实体的属性上

import javax.validation.constraints.Past; import java.util.Date;  /** * @ClassName: StudentVO * @Description: 学生实体 * @Author mac * @Date 2019/6/11 上午10:26 **/ @Data public class StudentVO {  /** * 姓名 */ @NotNull(message = "学生姓名不能为空") private String name;  /** * 身高 */ @NotNull(message = "学生身高不能为空") private Integer stature;  /** * 体重 */ @NotNull(message = "学生体重不能为空") private Integer weight;  /** * 出生日期 */ @Past private Date birth;

#### 嵌套验证 ####

对于正常业务逻辑中的属性校验, 一个验证注解很可能不能够满足需求

比如：在新增学生信息时, 身高信息不能为空, 同时也为了防止录入人员随便写身高值, 这个时候就需要嵌套验证

* 身高 * 限制条件 字段值不可为空 * 学生身高最大值不可超过299 * 别杠说为什么最大不能超过299 me 愿意 */ @Max(299) @NotNull(message = "学生身高不能为空") private Integer stature;

#### 在controller中开启验证 ####

在接受参数前面加上 `@Validated` 注解, 对象中的 `@NotNull、@Max` 等注解才会生效, 不加的话是无效的

@PostMapping(value = "save") public void save(@Validated @RequestBody StudentVO studentVO) { ... }

#### @Validated 高级用法 ####

##### 分组 - groups #####

举个例子, 刚才你在student类中将姓名设置为了不可为空对吧, 如果修改的时候采用同样的方式来进行验证入参你怎么办？ 强制给别人改个名或者把原值传进来么, 其实有更优雅的方式来解决这个问题

分组接口类

/** * @ClassName: Save * @Description: 验证分组 * @Author mac * @Date 2019/6/11 下午5:30 **/ public interface Save {

实体类

/** * 姓名 */ @NotNull(message = "学生姓名不能为空", groups = { Save.class}) private String name;

controller

> 因为只有姓名字段加入了Save这个分组, 如果现在发起save请求, 只会验证姓名

@PostMapping(value = "save") public void save(@Validated({ Save.class}) @RequestBody StudentVO studentVO) { ... }

> ps：如果在注解上不加groups, 默认每次都会进行验证
> 
> 可以在一个注解上添加多个分组, 只要在 controller中存在一个就可以验证
> 
> 只要理解了其实很通用的, 这里就以文字加以描述了
> 
>     /** ** 姓名 **/ @NotNull(message = "学生姓名不能为空", groups = { Save.class, Update.class}) private String name;
> 
> `@Validated({Save.class, Update.class})`

##### 分组排序 #####

默认情况下, 不同组之间是没有顺序可言的, 但是在一些特殊场景下是需要进行验证依赖的

> ps：没有遇到过, 就不举例了

分组接口类 - @GroupSequence

/** * @ClassName: Save * @Description: 验证分组 * @Author mac * @Date 2019/6/11 下午5:30 **/ public interface Save {  }

/** * @ClassName: Update * @Description: 验证分组 * @Author mac * @Date 2019/6/11 下午5:47 **/ public interface Update {

import javax.validation.GroupSequence; /** * @ClassName: Group * @Description: 分组排序 * @Author mac * @Date 2019/6/11 下午6:01 **/ @GroupSequence({Save.class, Update.class}) public interface Group { }

对象中的注解以及 `groups` 不变, 将 controller中save方法改下即可

public void save(@Validated({ Group.class}) @RequestBody StudentVO studentVO) { ... }

#### 附上部分标签含义 ####

<table> 
 <thead> 
  <tr> 
   <th>限制</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Null</td> 
   <td>限制只能为null</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>限制必须不为null</td> 
  </tr> 
  <tr> 
   <td>@AssertFalse</td> 
   <td>限制必须为false</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td>限制必须为true</td> 
  </tr> 
  <tr> 
   <td>@DecimalMax(value)</td> 
   <td>限制必须为一个不大于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@DecimalMin(value)</td> 
   <td>限制必须为一个不小于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@Digits(integer,fraction)</td> 
   <td>限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td>限制必须是一个将来的日期</td> 
  </tr> 
  <tr> 
   <td>@Max(value)</td> 
   <td>限制必须为一个不大于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@Min(value)</td> 
   <td>限制必须为一个不小于指定值的数字</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>限制必须是一个过去的日期</td> 
  </tr> 
  <tr> 
   <td>@Pattern(value)</td> 
   <td>限制必须符合指定的正则表达式</td> 
  </tr> 
  <tr> 
   <td>@Size(max,min)</td> 
   <td>限制字符长度必须在min到max之间</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>验证注解的元素值（日期类型）比当前时间早</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td>验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）</td> 
  </tr> 
  <tr> 
   <td>@NotBlank</td> 
   <td>验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格</td> 
  </tr> 
  <tr> 
   <td>@Email</td> 
   <td>验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式</td> 
  </tr> 
 </tbody> 
</table>

#### 参考文章 ####

[https://blog.csdn.net/gaojp008/article/details/80583301][https_blog.csdn.net_gaojp008_article_details_80583301]

[https://blog.csdn.net/u012693530/article/details/80831408][https_blog.csdn.net_u012693530_article_details_80831408]

[https_blog.csdn.net_gaojp008_article_details_80583301]: https://links.jianshu.com/go?to=https%3A%2F%2Fblog.csdn.net%2Fgaojp008%2Farticle%2Fdetails%2F80583301
[https_blog.csdn.net_u012693530_article_details_80831408]: https://links.jianshu.com/go?to=https%3A%2F%2Fblog.csdn.net%2Fu012693530%2Farticle%2Fdetails%2F80831408