SpringBoot -开发中常用约束注解

在springboot后端开发中常需要对前端传参进行校验,如果全部放在Controller或者Service中,会让代码看起来非常的冗余,这个时候直接在传参上加上约束注解就很方便实用,简单总结了一下常用的注解及其实用的场景。

  • 空检查
    @Null: 验证对象是否为null
    @NotNull: 验证对象是否不为null, 无法查检长度为0的字符串 (用于 Integer、Bigdecimal、LocalDateTime、LocalDate、实体类)
    @NotBlank: 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前- 后空格。(用于 String)
    --------验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
    @NotEmpty: 检查约束元素是否为NULL或者是EMPTY. (字符串长度不为0、集合大小不为0 用于 List

  • Booelan检查
    @AssertTrue: 验证 Boolean 对象是否为 true (限制必须为true)
    @AssertFalse: 验证 Boolean 对象是否为 false (限制必须为false)

  • 长度检查
    @Size(min=1, max=10): 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内 限制字符串、数组、集合长度范围必须在min到max之间
    @Length(min=1, max=10) 验证注解的元素值长度在min和max区间内,只能用于字符串

  • 日期检查
    @Past: 验证 Date 和 Calendar 对象是否在当前时间之前 (限制必须是一个过去的日期用于 过去时间,LocalDateTime、LocalDate)
    @Future: 验证 Date 和 Calendar 对象是否在当前时间之后 (限制必须是一个将来的日期用于 未来时间,LocalDateTime、LocalDate)
    @Pattern(regexp="reg"): 验证 String 对象是否符合正则表达式的规则 (限制必须符合指定的正则表达式)

  • 数值检查 (建议使用在Stirng,Integer类型)
    @Min(value):限制必须为一个不小于指定值的数字
    @Max(value):限制必须为一个不大于指定值的数字
    @DecimalMin(value):限制必须为一个不小于指定值的数字
    @DecimalMax(value):限制必须为一个不大于指定值的数字
    @Digits:验证是否为数字
    @Digits(integer, fraction):限制必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction
    @Range(min=long1,max=long2):检查数字是否在范围min到max之间

  • 其他验证
    @Vaild:递归验证,用于对象、数组和集合,会对对象的元素、数组的元素进行一一校验
    @Email:用于验证一个字符串是否是一个合法的邮箱地址,空字符串或null算验证通过
    @URL(protocol=协议,host=主机,port=端口号,regexp=正则表达式,flags=标识):用于校验一个字符串是否是合法URL

  • 使用示例
    @NotBlank(message = "新密码不能为空")
    @Pattern(regexp = RegularUtilS.REG_PASSWORD, message = "新密码6-15个字符,只能数字、标点符号、字母")
    private String newPassword;

    @Email(message="邮箱格式错误")
    private String email;

    @Future(message = "开始时间必须是将来时间")
    @NotNull(message = "开始时间不能为空")
    private LocalDateTime startTime;
    
    @NotNull(message = "余额升不能为空")
    @DecimalMin(value = "0.01", message = "余额升最小为0.01")
    @DecimalMax(value = "100", message = "余额升最大为100")
    @ApiModelProperty(value = "余额升", example = "10")
    private BigDecimal balance;

    @NotNull(message = "最大购票数必填")
    @Min(value = 0, message = "最小购票数为0")
    @Max(value = 100, message = "最大购票数为100")
    @ApiModelProperty(value = "最大购票数", example = "48")
    private Short maxTickets;

    @Size(max = 10, message = "请输入10个字符以内")
    @ApiModelProperty(value = "联系人", example = "张三")
    private String primaryContact;

    @Email(message = "邮箱格式不正确")
    @Size(max = 50, message = "邮箱长度不能超过50个字符")
    @ApiModelProperty(value = "邮箱", example = "admin@139.com")
    private String email;

非文章,spring boot个人笔记 谢谢。

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

推荐阅读更多精彩内容