SpringBoot -開(kāi)發(fā)中常用約束注解

在springboot后端開(kāi)發(fā)中常需要對(duì)前端傳參進(jìn)行校驗(yàn)惕艳,如果全部放在Controller或者Service中虽抄,會(huì)讓代碼看起來(lái)非常的冗余鹰霍,這個(gè)時(shí)候直接在傳參上加上約束注解就很方便實(shí)用豹休,簡(jiǎn)單總結(jié)了一下常用的注解及其實(shí)用的場(chǎng)景镜沽。

  • 空檢查
    @Null: 驗(yàn)證對(duì)象是否為null
    @NotNull: 驗(yàn)證對(duì)象是否不為null, 無(wú)法查檢長(zhǎng)度為0的字符串 (用于 Integer敏晤、Bigdecimal、LocalDateTime缅茉、LocalDate嘴脾、實(shí)體類(lèi))
    @NotBlank: 檢查約束字符串是不是Null還有被Trim的長(zhǎng)度是否大于0,只對(duì)字符串,且會(huì)去掉前- 后空格。(用于 String)
    --------驗(yàn)證注解的元素值不為空(不為null蔬墩、去除首位空格后長(zhǎng)度為0)译打,不同于@NotEmpty,@NotBlank只應(yīng)用于字符串且在比較時(shí)會(huì)去除字符串的空格
    @NotEmpty: 檢查約束元素是否為NULL或者是EMPTY. (字符串長(zhǎng)度不為0拇颅、集合大小不為0 用于 List

  • Booelan檢查
    @AssertTrue: 驗(yàn)證 Boolean 對(duì)象是否為 true (限制必須為true)
    @AssertFalse: 驗(yàn)證 Boolean 對(duì)象是否為 false (限制必須為false)

  • 長(zhǎng)度檢查
    @Size(min=1, max=10): 驗(yàn)證對(duì)象(Array,Collection,Map,String)長(zhǎng)度是否在給定的范圍之內(nèi) 限制字符串奏司、數(shù)組、集合長(zhǎng)度范圍必須在min到max之間
    @Length(min=1, max=10) 驗(yàn)證注解的元素值長(zhǎng)度在min和max區(qū)間內(nèi)樟插,只能用于字符串

  • 日期檢查
    @Past: 驗(yàn)證 Date 和 Calendar 對(duì)象是否在當(dāng)前時(shí)間之前 (限制必須是一個(gè)過(guò)去的日期用于 過(guò)去時(shí)間韵洋,LocalDateTime竿刁、LocalDate)
    @Future: 驗(yàn)證 Date 和 Calendar 對(duì)象是否在當(dāng)前時(shí)間之后 (限制必須是一個(gè)將來(lái)的日期用于 未來(lái)時(shí)間,LocalDateTime搪缨、LocalDate)
    @Pattern(regexp="reg"): 驗(yàn)證 String 對(duì)象是否符合正則表達(dá)式的規(guī)則 (限制必須符合指定的正則表達(dá)式)

  • 數(shù)值檢查 (建議使用在Stirng,Integer類(lèi)型)
    @Min(value):限制必須為一個(gè)不小于指定值的數(shù)字
    @Max(value):限制必須為一個(gè)不大于指定值的數(shù)字
    @DecimalMin(value):限制必須為一個(gè)不小于指定值的數(shù)字
    @DecimalMax(value):限制必須為一個(gè)不大于指定值的數(shù)字
    @Digits:驗(yàn)證是否為數(shù)字
    @Digits(integer, fraction):限制必須為一個(gè)小數(shù)食拜,且整數(shù)部分的位數(shù)不能超過(guò)integer,小數(shù)部分的位數(shù)不能超過(guò)fraction
    @Range(min=long1,max=long2):檢查數(shù)字是否在范圍min到max之間

  • 其他驗(yàn)證
    @Vaild:遞歸驗(yàn)證勉吻,用于對(duì)象、數(shù)組和集合旅赢,會(huì)對(duì)對(duì)象的元素齿桃、數(shù)組的元素進(jìn)行一一校驗(yàn)
    @Email:用于驗(yàn)證一個(gè)字符串是否是一個(gè)合法的郵箱地址,空字符串或null算驗(yàn)證通過(guò)
    @URL(protocol=協(xié)議,host=主機(jī),port=端口號(hào),regexp=正則表達(dá)式,flags=標(biāo)識(shí)):用于校驗(yàn)一個(gè)字符串是否是合法URL

  • 使用示例
    @NotBlank(message = "新密碼不能為空")
    @Pattern(regexp = RegularUtilS.REG_PASSWORD, message = "新密碼6-15個(gè)字符,只能數(shù)字煮盼、標(biāo)點(diǎn)符號(hào)短纵、字母")
    private String newPassword;

    @Email(message="郵箱格式錯(cuò)誤")
    private String email;

    @Future(message = "開(kāi)始時(shí)間必須是將來(lái)時(shí)間")
    @NotNull(message = "開(kāi)始時(shí)間不能為空")
    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 = "最大購(gòu)票數(shù)必填")
    @Min(value = 0, message = "最小購(gòu)票數(shù)為0")
    @Max(value = 100, message = "最大購(gòu)票數(shù)為100")
    @ApiModelProperty(value = "最大購(gòu)票數(shù)", example = "48")
    private Short maxTickets;

    @Size(max = 10, message = "請(qǐng)輸入10個(gè)字符以?xún)?nèi)")
    @ApiModelProperty(value = "聯(lián)系人", example = "張三")
    private String primaryContact;

    @Email(message = "郵箱格式不正確")
    @Size(max = 50, message = "郵箱長(zhǎng)度不能超過(guò)50個(gè)字符")
    @ApiModelProperty(value = "郵箱", example = "admin@139.com")
    private String email;

非文章,spring boot個(gè)人筆記 謝謝僵控。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末香到,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子报破,更是在濱河造成了極大的恐慌悠就,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,013評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件充易,死亡現(xiàn)場(chǎng)離奇詭異梗脾,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)盹靴,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,205評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門(mén)炸茧,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人稿静,你說(shuō)我怎么就攤上這事梭冠。” “怎么了改备?”我有些...
    開(kāi)封第一講書(shū)人閱讀 152,370評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵控漠,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我悬钳,道長(zhǎng)润脸,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,168評(píng)論 1 278
  • 正文 為了忘掉前任他去,我火速辦了婚禮毙驯,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘灾测。我一直安慰自己爆价,他們只是感情好垦巴,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,153評(píng)論 5 371
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著铭段,像睡著了一般骤宣。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上序愚,一...
    開(kāi)封第一講書(shū)人閱讀 48,954評(píng)論 1 283
  • 那天憔披,我揣著相機(jī)與錄音,去河邊找鬼爸吮。 笑死芬膝,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的形娇。 我是一名探鬼主播锰霜,決...
    沈念sama閱讀 38,271評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼桐早!你這毒婦竟也來(lái)了癣缅?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 36,916評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤哄酝,失蹤者是張志新(化名)和其女友劉穎友存,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體陶衅,經(jīng)...
    沈念sama閱讀 43,382評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡爬立,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,877評(píng)論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了万哪。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片侠驯。...
    茶點(diǎn)故事閱讀 37,989評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖奕巍,靈堂內(nèi)的尸體忽然破棺而出吟策,到底是詐尸還是另有隱情,我是刑警寧澤的止,帶...
    沈念sama閱讀 33,624評(píng)論 4 322
  • 正文 年R本政府宣布檩坚,位于F島的核電站,受9級(jí)特大地震影響诅福,放射性物質(zhì)發(fā)生泄漏匾委。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,209評(píng)論 3 307
  • 文/蒙蒙 一氓润、第九天 我趴在偏房一處隱蔽的房頂上張望赂乐。 院中可真熱鬧,春花似錦咖气、人聲如沸挨措。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,199評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)浅役。三九已至斩松,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間觉既,已是汗流浹背惧盹。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,418評(píng)論 1 260
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留瞪讼,地道東北人钧椰。 一個(gè)月前我還...
    沈念sama閱讀 45,401評(píng)論 2 352
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像尝艘,于是被迫代替她去往敵國(guó)和親演侯。 傳聞我的和親對(duì)象是個(gè)殘疾皇子姿染,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,700評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容