@Validated 和 @Valid 的真正區別
概述
-
@Valid
是使用Hibernate validation
的時候使用 -
@Validated
是隻用Spring Validator
校驗機制使用
說明:java的JSR303聲明瞭
@Valid
這類介面,而Hibernate-validator
對其進行了實現
@Validation
對@Valid
進行了二次封裝,在使用上並沒有區別,但在分組、註解位置、巢狀驗證等功能上有所不同,這裡主要就這幾種情況進行說明。
註解位置
-
@Validated
:用在型別、方法和方法引數上。但不能用於成員屬性(field) -
@Valid
:可以用在方法、建構函式、方法引數和成員屬性(field)上
如:
如果@Validated
註解在成員屬性上,則會報不適用於field錯誤
分組校驗
-
@Validated
:提供分組功能,可以在引數驗證時,根據不同的分組採用不同的驗證機制 -
@Valid
:沒有分組功能
舉例:
定義分組介面:
public interface IGroupA {
}
public interface IGroupB {
}
定義需要檢驗的引數bean:
public class StudentBean implements Serializable{
@NotBlank(message = "使用者名稱不能為空")
private String name;
//只在分組為IGroupB的情況下進行驗證
@Min(value = 18, message = "年齡不能小於18歲", groups = {IGroupB.class})
private Integer age;
@Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手機號格式錯誤")
private String phoneNum;
@Email(message = "郵箱格式錯誤")
private String email;
@MyConstraint
private String className;
測試程式碼:
檢驗分組為IGroupA的情況
@RestController
public class CheckController {
@PostMapping("stu")
public String addStu(@Validated({IGroupA.class}) @RequestBody StudentBean studentBean){
return "add student success";
}
}
測試:
這裡對分組IGroupB的就沒檢驗了
如果把測試程式碼改成下面這樣,看看測試結果
@RestController
public class CheckController {
@PostMapping("stu")
public String addStu(@Validated({IGroupA.class, IGroupB.class}) @RequestBody StudentBean studentBean){
return "add student success";
}
}
說明:
1、不分 配groups,預設每次都要進行驗證
2、對一個引數需要多種驗證方式時,也可通過分配不同的組達到目的。
組序列
預設情況下 不同級別的約束驗證是無序的,但是在一些情況下,順序驗證卻是很重要。
一個組可以定義為其他組的序列,使用它進行驗證的時候必須符合該序列規定的順序。在使用組序列驗證的時候,如果序列前邊的組驗證失敗,則後面的組將不再給予驗證。
舉例:
定義組序列:
@GroupSequence({Default.class, IGroupA.class, IGroupB.class})
public interface IGroup {
}
需要校驗的Bean,分別定義IGroupA對age進行校驗,IGroupB對className進行校驗:
public class StudentBean implements Serializable{
@NotBlank(message = "使用者名稱不能為空")
private String name;
@Min(value = 18, message = "年齡不能小於18歲", groups = IGroupA.class)
private Integer age;
@Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手機號格式錯誤")
private String phoneNum;
@Email(message = "郵箱格式錯誤")
private String email;
@MyConstraint(groups = IGroupB.class)
private String className;
測試程式碼:
@RestController
public class CheckController {
@PostMapping("stu")
public String addStu(@Validated({IGroup.class}) @RequestBody StudentBean studentBean){
return "add student success";
}
}
測試發現,如果age出錯,那麼對組序列在IGroupA後的IGroupB不進行校驗,即例子中的className不進行校驗,結果如下:
巢狀校驗
一個待驗證的pojo類,其中還包含了待驗證的物件,需要在待驗證物件上註解@Valid
,才能驗證待驗證物件中的成員屬性,這裡不能使用@Validated
。
舉例:
需要約束校驗的bean:
public class TeacherBean {
@NotEmpty(message = "老師姓名不能為空")
private String teacherName;
@Min(value = 1, message = "學科型別從1開始計算")
private int type;
public class StudentBean implements Serializable{
@NotBlank(message = "使用者名稱不能為空")
private String name;
@Min(value = 18, message = "年齡不能小於18歲")
private Integer age;
@Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手機號格式錯誤")
private String phoneNum;
@Email(message = "郵箱格式錯誤")
private String email;
@MyConstraint
private String className;
@NotNull(message = "任課老師不能為空")
@Size(min = 1, message = "至少有一個老師")
private List<TeacherBean> teacherBeans;
注意:
這裡對teacherBeans
只校驗了NotNull
, 和 Size,並沒有對teacher資訊裡面的欄位進行校驗,具體測試如下:
這裡teacher中的type明顯是不符合約束要求的,但是能檢測通過,是因為在student中並沒有做 巢狀校驗
可以在teacherBeans
中加上 @Valid
,具體如下:
@Valid
@NotNull(message = "任課老師不能為空")
@Size(min = 1, message = "至少有一個老師")
private List<TeacherBean> teacherBeans;
這裡再來測試,會發現如下結果: