Java?Validated?分組校驗的使用

更新時間：2022年02月14日 15:47:10 作者：干凈又衛(wèi)生

這篇文章主要介紹了Java?Validated?分組校驗的使用,文章記錄所以在這里記錄下分組校驗注解@Validated的使用，具有一定的參考價值，需要的朋友可以參考一下

1.新建SpringBoot項目

新建一個SpringBoot項目，新建module -> 引入依賴 -> 編寫主啟動類 -> 編寫配置文件 -> 新建各種包

2.新建組

Validated有自己默認的組 Default.class

我們要建的組，就是不同業(yè)務使用字段分成的組，舉例的業(yè)務是一個用戶對象，用戶有不同的角色，不同的接口會用到這個用戶對象的不同字段。比如學生(Student)，老師(Teacher):

Student

public interface Student {
}

Teacher

public interface Teacher {
}

3.新建請求對象

我們的業(yè)務是多個接口共用一個請求對象，所以不同接口用到這個對象里的字段一定不同。所以在這里對不同的字段作了分組，比如：

老師肯定會有手機號、手下也一定有幾個學生,所以被劃分到Teacher組；
學生一定要有幾本書，所以被劃分到Student組；
沒有被分組的字段默認是Default組；
給所有字段用校驗注解添加校驗，以便測試是否分組生效。

UserDTO

@Data
public class UserDTO {

? ? @NotBlank(message = "id必傳")
? ? private String id;

? ? @NotBlank(message = "不能沒有名稱")
? ? private String name;

? ? @NotBlank(message = "老師不能沒有手機號", groups = Teacher.class)
? ? private String phone;

? ? @NotNull(message = "age必傳")
? ? private Integer age;

? ? @NotBlank(message = "不能沒有idCard")
? ? private String idCard;

? ? @NotEmpty(message = "學生不能沒有書")
? ? @Size(min = 2, message = "學生必須有兩本書", groups = Student.class)
? ? private List<String> bookNames;

? ? @NotEmpty
? ? @Size(min = 1, message = "老師不能沒有學生", groups = Teacher.class)
? ? private List<String> studentNames;
}

4.接口測試

對這個對象的不同業(yè)務劃分出5個接口，測試下字段分組之后的必傳情況：這樣看的清楚些

Controller

@RestController
public class ValidatedController {
? ??
? ? /**
? ? ?* 測試 分組校驗 student
? ? ?*
? ? ?* @date 2022/2/11 15:47:14
? ? ?*/
? ? @PostMapping("student")
? ? public UserDTO validatedStudent(@Validated(value = {Student.class, Default.class}) @RequestBody UserDTO userDTO) {
? ? ? ? return userDTO;
? ? }

? ? /**
? ? ?* 測試 分組校驗 ?teacher
? ? ?*
? ? ?* @date 2022/2/11 15:47:14
? ? ?*/
? ? @PostMapping("teacher")
? ? public UserDTO validatedTeacher(@Validated(value = {Teacher.class, Default.class}) @RequestBody UserDTO userDTO) {
? ? ? ? return userDTO;
? ? }

? ? /**
? ? ?* 測試 分組校驗 ?default
? ? ?*
? ? ?* @date 2022/2/11 15:47:14
? ? ?*/
? ? @PostMapping("default")
? ? public UserDTO validatedDefault(@Validated(value = {Default.class}) @RequestBody UserDTO userDTO) {
? ? ? ? return userDTO;
? ? }

? ? /**
? ? ?* 測試 分組校驗 onlyStudent
? ? ?*
? ? ?* @date 2022/2/11 15:47:14
? ? ?*/
? ? @PostMapping("onlyStudent")
? ? public UserDTO validatedOnlyStudent(@Validated(value = {Student.class}) @RequestBody UserDTO userDTO) {
? ? ? ? return userDTO;
? ? }

? ? /**
? ? ?* 測試 分組校驗 onlyTeacher
? ? ?*
? ? ?* @date 2022/2/11 15:47:14
? ? ?*/
? ? @PostMapping("onlyTeacher")
? ? public UserDTO validatedOnlyTeacher(@Validated(value = {Teacher.class}) @RequestBody UserDTO userDTO) {
? ? ? ? return userDTO;
? ? }

}

對 Student、Teacher、Default、OnlyStudent、OnlyTeacher 進行測試

不需要列舉所有情況，這里就用Student接口做測試。這個接口如果不傳遞Student組的bookNames字段或者bookNames字段長度不足 2 就會拋出異常，但是因為分組的緣故，即使不傳遞Teacher Group的字段也不會受到影響。

不傳bookNames

只傳遞一個bookNames

5.結論

其它接口例子我就不多說了，因為沒有顯式分組的默認都是Default組，所以，測試接口里面有Default組的測試，就是默認沒有分組的屬性都歸Default管理;
測試用例中的only這兩個組，就是在沒有Default的情況下，只對Student和Teacher 組的字段進行校驗;
要注意平常我們寫@Validated注解的時候，默認就是@Validated(group = {Default.class}),也就是默認所有字段都是Default組的，顯式分組之后，剩下的那些沒有被劃分到自建組的字段都是Default組;
因為這種機制的出現所以我們可以很靈活的使用對象里面的某些字段，比如可以新建一個Master組，可以將Student和Teacher組的字段都劃分到Master組，以實現類似于高權限等級的參數傳遞校驗等等操作！

到此這篇關于Java Validated 分組校驗的使用的文章就介紹到這了,更多相關Java Validated 分組校驗內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: