在springboot后端開發(fā)中常需要對前端傳參進(jìn)行校驗(yàn),如果全部放在Controller或者Service中,會讓代碼看起來非常的冗余,這個時候直接在傳參上加上約束注解就很方便實(shí)用,簡單總結(jié)了一下常用的注解及其實(shí)用的場景。
空檢查
@Null: 驗(yàn)證對象是否為null
@NotNull: 驗(yàn)證對象是否不為null, 無法查檢長度為0的字符串 (用于 Integer、Bigdecimal、LocalDateTime、LocalDate、實(shí)體類)
@NotBlank: 檢查約束字符串是不是Null還有被Trim的長度是否大于0,只對字符串,且會去掉前- 后空格。(用于 String)
--------驗(yàn)證注解的元素值不為空(不為null、去除首位空格后長度為0),不同于@NotEmpty,@NotBlank只應(yīng)用于字符串且在比較時會去除字符串的空格
@NotEmpty: 檢查約束元素是否為NULL或者是EMPTY. (字符串長度不為0、集合大小不為0用于 List)Booelan檢查
@AssertTrue: 驗(yàn)證 Boolean 對象是否為 true (限制必須為true)
@AssertFalse: 驗(yàn)證 Boolean 對象是否為 false (限制必須為false)長度檢查
@Size(min=1, max=10): 驗(yàn)證對象(Array,Collection,Map,String)長度是否在給定的范圍之內(nèi) 限制字符串、數(shù)組、集合長度范圍必須在min到max之間
@Length(min=1, max=10) 驗(yàn)證注解的元素值長度在min和max區(qū)間內(nèi),只能用于字符串日期檢查
@Past: 驗(yàn)證 Date 和 Calendar 對象是否在當(dāng)前時間之前 (限制必須是一個過去的日期用于 過去時間,LocalDateTime、LocalDate)
@Future: 驗(yàn)證 Date 和 Calendar 對象是否在當(dāng)前時間之后 (限制必須是一個將來的日期用于 未來時間,LocalDateTime、LocalDate)
@Pattern(regexp="reg"): 驗(yàn)證 String 對象是否符合正則表達(dá)式的規(guī)則 (限制必須符合指定的正則表達(dá)式)數(shù)值檢查 (建議使用在Stirng,Integer類型)
@Min(value):限制必須為一個不小于指定值的數(shù)字
@Max(value):限制必須為一個不大于指定值的數(shù)字
@DecimalMin(value):限制必須為一個不小于指定值的數(shù)字
@DecimalMax(value):限制必須為一個不大于指定值的數(shù)字
@Digits:驗(yàn)證是否為數(shù)字
@Digits(integer, fraction):限制必須為一個小數(shù),且整數(shù)部分的位數(shù)不能超過integer,小數(shù)部分的位數(shù)不能超過fraction
@Range(min=long1,max=long2):檢查數(shù)字是否在范圍min到max之間其他驗(yàn)證
@Vaild:遞歸驗(yàn)證,用于對象、數(shù)組和集合,會對對象的元素、數(shù)組的元素進(jìn)行一一校驗(yàn)
@Email:用于驗(yàn)證一個字符串是否是一個合法的郵箱地址,空字符串或null算驗(yàn)證通過
@URL(protocol=協(xié)議,host=主機(jī),port=端口號,regexp=正則表達(dá)式,flags=標(biāo)識):用于校驗(yàn)一個字符串是否是合法URL
- 使用示例:
@NotBlank(message = "新密碼不能為空")
@Pattern(regexp = RegularUtilS.REG_PASSWORD, message = "新密碼6-15個字符,只能數(shù)字、標(biāo)點(diǎn)符號、字母")
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 = "最大購票數(shù)必填")
@Min(value = 0, message = "最小購票數(shù)為0")
@Max(value = 100, message = "最大購票數(shù)為100")
@ApiModelProperty(value = "最大購票數(shù)", example = "48")
private Short maxTickets;
@Size(max = 10, message = "請輸入10個字符以內(nèi)")
@ApiModelProperty(value = "聯(lián)系人", example = "張三")
private String primaryContact;
@Email(message = "郵箱格式不正確")
@Size(max = 50, message = "郵箱長度不能超過50個字符")
@ApiModelProperty(value = "郵箱", example = "admin@139.com")
private String email;
非文章,spring boot個人筆記 謝謝。