Java?Validated?分組校驗的使用
前言:
開發(fā)中我們會遇到多個接口公用一個請求對象的情況,如果需求變更,勢必會破壞已有代碼的邏輯,不符合開閉原則,對參數(shù)校驗修修補補,不如一開始就劃分明確,所以在這里記錄下分組校驗注解@Validated的使用。
測試過程:
1.新建SpringBoot項目
新建一個SpringBoot
項目,新建module -> 引入依賴 -> 編寫主啟動類 -> 編寫配置文件 -> 新建各種包
2.新建組
Validated
有自己默認的組 Default.class
我們要建的組,就是不同業(yè)務(wù)使用字段分成的組,舉例的業(yè)務(wù)是一個用戶對象,用戶有不同的角色,不同的接口會用到這個用戶對象的不同字段。比如學(xué)生(Student)
,老師(Teacher):
Student
public interface Student { }
Teacher
public interface Teacher { }
3.新建請求對象
我們的業(yè)務(wù)是多個接口共用一個請求對象,所以不同接口用到這個對象里的字段一定不同。所以在這里對不同的字段作了分組,比如:
- 老師肯定會有手機號、手下也一定有幾個學(xué)生,所以被劃分到Teacher組;
- 學(xué)生一定要有幾本書,所以被劃分到
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 = "學(xué)生不能沒有書") ? ? @Size(min = 2, message = "學(xué)生必須有兩本書", groups = Student.class) ? ? private List<String> bookNames; ? ? @NotEmpty ? ? @Size(min = 1, message = "老師不能沒有學(xué)生", groups = Teacher.class) ? ? private List<String> studentNames; }
4.接口測試
對這個對象的不同業(yè)務(wù)劃分出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.結(jié)論
其它接口例子我就不多說了,因為沒有顯式分組的默認都是Default組,所以,測試接口里面有Default組的測試,就是默認沒有分組的屬性都歸Default管理;
測試用例中的only這兩個組,就是在沒有Default的情況下,只對Student和Teacher 組的字段進行校驗;
要注意平常我們寫@Validated
注解的時候,默認就是@Validated(group = {Default.class}),
也就是默認所有字段都是Default
組的,顯式分組之后,剩下的那些沒有被劃分到自建組的字段都是Default組;
因為這種機制的出現(xiàn)所以我們可以很靈活的使用對象里面的某些字段,比如可以新建一個Master組,可以將Student和Teacher組的字段都劃分到Master組,以實現(xiàn)類似于高權(quán)限等級的參數(shù)傳遞校驗等等操作!
到此這篇關(guān)于Java Validated 分組校驗的使用的文章就介紹到這了,更多相關(guān)Java Validated 分組校驗內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
idea配置檢查XML中SQL語法及書寫sql語句智能提示的方法
idea連接了數(shù)據(jù)庫,也可以執(zhí)行SQL查到數(shù)據(jù),但是無法識別sql語句中的表導(dǎo)致沒有提示,下面這篇文章主要給大家介紹了關(guān)于idea配置檢查XML中SQL語法及書寫sql語句智能提示的相關(guān)資料,需要的朋友可以參考下2023-03-03MyBatis入門實例教程之創(chuàng)建一個簡單的程序
這篇文章主要介紹了MyBatis入門創(chuàng)建一個簡單的程序,在?MySQL?中創(chuàng)建數(shù)據(jù)庫?mybatisdemo,編碼為?utf8,本文通過實例代碼給大家介紹的非常詳細,需要的朋友可以參考下2022-02-02Spring線程池ThreadPoolTaskExecutor配置詳情
本篇文章主要介紹了Spring線程池ThreadPoolTaskExecutor配置詳情,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-03-03