SpringBoot 与注解 @Validated 结合对数据进行验证

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

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

对象中添加对应功能注解

@Validated 相关作用注解标签需要加在 bean 实体的属性上

import javax.validation.constraints.NotNull;
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) {
 ...
}

如果在注解上不加groups, 默认每次都会进行验证
可以在一个注解上添加多个分组, 只要在 controller中存在一个就可以验证
只要理解了其实很通用的, 这里就以文字加以描述了
@Validated({Save.class, Update.class})

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

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

没有遇到过, 就不举例了

分组接口类 - @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方法改下即可

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

附上部分标签含义

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

参考文章

@Valid和@Validated的总结区分
springboot中使用@Validated注解对数据进行校验

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,050评论 4 370
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,538评论 1 306
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 111,673评论 0 254
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,622评论 0 218
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,047评论 3 295
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,974评论 1 224
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,129评论 2 317
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,893评论 0 209
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,654评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,828评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,297评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,619评论 3 262
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,326评论 3 243
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,176评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,975评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,118评论 2 285
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,909评论 2 278

推荐阅读更多精彩内容