前言：
在實際項目中，我們通常會有大量需要對前端傳參校驗的需求，若對每個字段、每種規則都使用if...else...來判斷會造成代碼臃腫，冗餘度高。若想解決該問題，不妨來看看下面的兩個註解：@Valid和@Validated。
一、對比
相同點：均爲校驗註解，用於簡化在代碼中對業務字段校驗時的大量if...else...操作。
不同點：
|
維度 |
@Valid |
@Validated |
|
所屬包 |
javax.validation |
spring下的org.springframework.validation.annotation |
|
嵌套校驗（Bean中包含Bean） |
支持 |
不支持 |
|
分組校驗（不同場景需要校驗組合不同） |
不支持 |
支持 |
二、代碼示例
1. 嵌套校驗：
在子Bean變量-- sourceDTO 上添加 @Valid 註解 （加@Validated註解會報錯）
- 測試註解實體：
/**
* <h3>demo</h3>
* <p>學生類</p>
*
* @author yingKang
* @date 2020-04-09 16:00
*/
@Data
@ToString
public class StudentDTO {
@NotBlank(message = "學號不可爲空")
private String id;
@Size(max = 5, message = "姓名長度不可超過5")
private String name;
@Max(value = 20, message = "年齡不可超過20歲")
private Integer age;
@Valid
private SourceDTO sourceDTO;
}
/**
* <h3>demo</h3>
* <p>課程類</p>
*
* @author yingKang
* @date 2020-04-09 17:01
*/
@Data
@ToString
public class SourceDTO {
@NotBlank(message = "課程號不可爲空")
private String id;
@Size(max = 5, message = "課程名稱長度不可超過5")
private String name;
}
- 執行測試代碼：
@Controller
@RequestMapping("/test")
public class HelloWorldController {
@ResponseBody
@RequestMapping("/hello")
public String hello(@RequestBody @Valid StudentDTO student){
return student.toString();
}
}
- 效果：成功校驗子Bean中的屬性 （工具使用的PostMan）
2. 分組校驗：
1.校驗註解指定 groups，指定的Class必須是接口類型
2.啓動校驗時@Validated指定需要校驗的group，此時只會對group包含在其內的校驗註解進行校驗
注：未顯示指定groups的校驗註解也不會被執行
- 測試註解實體：
/**
* <h3>demo</h3>
* <p>學生類</p>
*
* @author yingKang
* @date 2020-04-09 16:00
*/
@Data
@ToString
public class StudentDTO {
@NotBlank(message = "學號不可爲空")
private String id;
@Size(max = 5, message = "姓名長度不可超過5", groups = {ValidatedGroupOne.class})
private String name;
@Max(value = 20, message = "年齡不可超過20歲", groups = {ValidatedGroupTwo.class})
private Integer age;
@Valid
private SourceDTO sourceDTO;
}
/**
* <h3>demo</h3>
* <p>課程類</p>
*
* @author yingKang
* @date 2020-04-09 17:01
*/
@Data
@ToString
public class SourceDTO {
@NotBlank(message = "課程號不可爲空")
private String id;
@Size(max = 5, message = "課程名稱長度不可超過5")
private String name;
}
- 測試分組定義：
/**
* <h3>demo</h3>
* <p>分組校驗-分組一</p>
*
* @author yingKang
* @date 2020-04-09 17:28
*/
public interface ValidatedGroupOne {
}
/**
* <h3>demo</h3>
* <p>分組校驗-分組二</p>
*
* @author yingKang
* @date 2020-04-09 17:28
*/
public interface ValidatedGroupTwo {
}
- 執行測試代碼：只校驗ValidatedGroupOne的校驗註解
/**
* @author yingKang
*/
@Controller
@RequestMapping("/test")
public class HelloWorldController {
@ResponseBody
@RequestMapping("/hello")
public String hello(@RequestBody @Validated(ValidatedGroupOne.class) StudentDTO student){
return student.toString();
}
}
- 結果：
三、常用校驗規則註解說明
空檢查 @Null 驗證對象是否爲null @NotNull 驗證對象是否不爲null, 無法查檢長度爲0的字符串 @NotBlank 檢查約束字符串是不是Null還有被Trim的長度是否大於0,只對字符串,且會去掉前後空格. @NotEmpty 檢查約束元素是否爲NULL或者是EMPTY. Booelan檢查 @AssertTrue 驗證 Boolean 對象是否爲 true @AssertFalse 驗證 Boolean 對象是否爲 false 長度檢查 @Size(min=, max=) 驗證對象（Array,Collection,Map,String）長度是否在給定的範圍之內 @Length(min=, max=) 驗證字符串的長度是否在給定的範圍之內，包含兩端 日期檢查 @Past 驗證 Date 和 Calendar 對象是否在當前時間之前 @Future 驗證 Date 和 Calendar 對象是否在當前時間之後 @Pattern 驗證 String 對象是否符合正則表達式的規則 數值檢查：建議使用在Stirng,Integer類型，不建議使用在int類型上，因爲表單值爲“”時無法轉換爲int，但可以轉換爲Stirng爲"",Integer爲null @Min 驗證 Number 和 String 對象是否大等於指定的值 @Max 驗證 Number 和 String 對象是否小等於指定的值 @DecimalMax 被標註的值必須不大於約束中指定的最大值. 這個約束的參數是一個通過BigDecimal定義的最大值的字符串表示.小數存在精度 @DecimalMin 被標註的值必須不小於約束中指定的最小值. 這個約束的參數是一個通過BigDecimal定義的最小值的字符串表示.小數存在精度 @Digits 驗證 Number 和 String 的構成是否合法 @Digits(integer=,fraction=) 驗證字符串是否是符合指定格式的數字，interger指定整數精度，fraction指定小數精度。 @Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum. @Range(min=10000,max=50000,message="range.bean.wage") private BigDecimal wage; @Valid遞歸的對關聯對象進行校驗, 如果關聯對象是個集合或者數組,那麼對其中的元素進行遞歸校驗,如果是一個map,則對其中的值部分進行校驗.(是否進行遞歸驗證) @CreditCardNumber信用卡驗證 @Email 驗證是否是郵件地址，如果爲null,不進行驗證，算通過驗證。 @ScriptAssert(lang= ,script=, alias=) @URL(protocol=,host=, port=,regexp=, flags=)