在实际开发中,难免遇到对一个实体类的一些属性,不同的请求会有不同的校验规则的场景,比如:用户注册时,User 类的 id 需校验为空,因为 User 的 id 肯定是由系统生成并维护而不是让用户自己填写的。但是在修改用户密码时,又需要传入 Id 来作为 where 语句的条件去更新,此时分组校验就派上用场了。
先上代码:
/*
* 一个普通的实体类
* 在我们常用的校验注解中,有一个groups参数,用于标注校验注解属于哪一种情况才进行校验,可以指定多种情况
* groups = {AddGroup.class,UpdateGroup.class}
*/
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌id
*/
@NotNull(message = "修改必须指定品牌id",groups = {UpdateGroup.class})
@Null(message = "新增不能指定id",groups = {AddGroup.class})
@TableId
private Long brandId;
/**
* 品牌名
*/
@NotBlank(message = "品牌名必须提交",groups = {AddGroup.class,UpdateGroup.class})
private String name;
/**
* 品牌logo地址
*/
@NotBlank(groups = {AddGroup.class})
@URL(message = "logo必须是一个合法的url地址",groups={AddGroup.class,UpdateGroup.class})
private String logo;
/**
* 介绍
*/
private String descript;
/**
* 显示状态[0-不显示;1-显示]
*/
@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
@ListValue(vals={0,1},groups = {AddGroup.class, UpdateStatusGroup.class})
private Integer showStatus;
/**
* 检索首字母
*/
@NotEmpty(groups={AddGroup.class})
@Pattern(regexp="^[a-zA-Z]$",message = "检索首字母必须是一个字母",groups={AddGroup.class,UpdateGroup.class})
private String firstLetter;
/**
* 排序
*/
@NotNull(groups={AddGroup.class})
@Min(value = 0,message = "排序必须大于等于0",groups={AddGroup.class,UpdateGroup.class})
private Integer sort;
}
上面我们定义了AddGroup.class
,UpdateGroup.class
我们需要创建它们,它们以接口的形式存在,空接口就行了
/*
* 格式如下
*/
public interface AddGroup {
}
具体需要实现分组校验功能,我们需要在controller
做些修改
我们不能使用普通的@Valid
注解,它不具备实现分组校验的功能,我们需要换成@Validated
注解,它可以指定一个或多个分组
/**
* 保存
* 返回结果R的实现去看我的 SpringBoot全局异常处理 文章
*/
@RequestMapping("/save")
public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand){
brandService.save(brand);
return R.ok();
}
使用注意事项:
当你启用了分组校验功能时@Validated({AddGroup.class})
,但你的实体类中某个字段却没用指定分组,这种情况下,是不会对字段进行任何校验的
相反,当你没用启用分组校验时@Validated
,只有没用标注分组校验的字段才会生效