【springboot】【@Validated】--使用Spring Validation優雅地進行引數校驗
不知道大家平時的業務開發過程中 controller 層的引數校驗都是怎麼寫的?是否也存在下面這樣的直接判斷?
public String add(UserVO userVO) { if(userVO.getAge() == null){ return "年齡不能為空"; } if(userVO.getAge() > 120){ return "年齡不能超過120"; } if(userVO.getName().isEmpty()){ return "使用者名稱不能為空"; } // 省略一堆引數校驗... return "OK"; }
業務程式碼還沒開始寫呢,光引數校驗就寫了一堆判斷。這樣寫雖然沒什麼錯,但是給人的感覺就是:不優雅,不專業。
其實Spring框架已經給我們封裝了一套校驗元件:validation。其特點是簡單易用,自由度高。接下來課代表使用springboot-2.3.1.RELEASE搭建一個簡單的 Web 工程,給大家一步一步講解在開發過程中如何優雅地做引數校驗。
2. 搭建環境
從springboot-2.3開始,校驗包被獨立成了一個starter元件,所以需要引入如下依賴:
<!--校驗元件--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> <!--web元件--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
而springboot-2.3之前的版本只需要引入 web 依賴就可以了
3. 小試牛刀
引數校驗非常簡單,首先在待校驗欄位上增加校驗規則註解
public class UserVO { @NotNull(message = "age 不能為空") private Integer age; }
然後在controller方法中新增@Validated和用於接收錯誤資訊的BindingResult就可以了,於是有了第一版:
public String add1(@Validated UserVO userVO, BindingResult result) { List<FieldError> fieldErrors = result.getFieldErrors(); if(!fieldErrors.isEmpty()){ return fieldErrors.get(0).getDefaultMessage(); } return "OK"; }
通過工具(postman)去請求介面,如果引數不符合規則,會將相應的 message資訊返回:
age 不能為空
內建的校驗註解有很多,羅列如下:
註解 | 校驗功能 |
---|---|
@AssertFalse | 必須是false |
@AssertTrue | 必須是true |
@DecimalMax | 小於等於給定的值 |
@DecimalMin | 大於等於給定的值 |
@Digits | 可設定最大整數位數和最大小數位數 |
校驗是否符合Email格式 | |
@Future | 必須是將來的時間 |
@FutureOrPresent | 當前或將來時間 |
@Max | 最大值 |
@Min | 最小值 |
@Negative | 負數(不包括0) |
@NegativeOrZero | 負數或0 |
@NotBlank | 不為null並且包含至少一個非空白字元 |
@NotEmpty | 不為null並且不為空 |
@NotNull | 不為null |
@Null | 為null |
@Past | 必須是過去的時間 |
@PastOrPresent | 必須是過去的時間,包含現在 |
@PositiveOrZero | 正數或0 |
@Size | 校驗容器的元素個數 |
4. 規範返回值
待校驗引數多了之後我們希望一次返回所有校驗失敗資訊,方便介面呼叫方進行調整,這就需要統一返回格式,常見的就是封裝一個結果類。
public class ResultInfo<T>{ private Integer status; private String message; private T response; // 省略其他程式碼... }
改造一下controller 方法,第二版:
public ResultInfo add2(@Validated UserVO userVO, BindingResult result) { List<FieldError> fieldErrors = result.getFieldErrors(); List<String> collect = fieldErrors.stream() .map(o -> o.getDefaultMessage()) .collect(Collectors.toList()); return new ResultInfo<>().success(400,"請求引數錯誤",collect); }
請求該方法時,所有的錯誤引數就都返回了:
{ "status": 400, "message": "請求引數錯誤", "response": [ "年齡必須在[1,120]之間", "bg 欄位的整數位最多為3位,小數位最多為1位", "name 不能為空", "email 格式錯誤" ] }
5. 全域性異常處理
每個Controller方法中如果都寫一遍BindingResult資訊的處理,使用起來還是很繁瑣。可以通過全域性異常處理的方式統一處理校驗異常。
當我們寫了@validated註解,不寫BindingResult的時候,Spring 就會丟擲異常。由此,可以寫一個全域性異常處理類來統一處理這種校驗異常,從而免去重複組織異常資訊的程式碼。
全域性異常處理類只需要在類上標註@RestControllerAdvice,並在處理相應異常的方法上使用@ExceptionHandler註解,寫明處理哪個異常即可。
@RestControllerAdvice public class GlobalControllerAdvice { private static final String BAD_REQUEST_MSG = "客戶端請求引數錯誤"; // <1> 處理 form data方式呼叫介面校驗失敗丟擲的異常 @ExceptionHandler(BindException.class) public ResultInfo bindExceptionHandler(BindException e) { List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors(); List<String> collect = fieldErrors.stream() .map(o -> o.getDefaultMessage()) .collect(Collectors.toList()); return new ResultInfo().success(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect); } // <2> 處理 json 請求體呼叫介面校驗失敗丟擲的異常 @ExceptionHandler(MethodArgumentNotValidException.class) public ResultInfo methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) { List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors(); List<String> collect = fieldErrors.stream() .map(o -> o.getDefaultMessage()) .collect(Collectors.toList()); return new ResultInfo().success(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect); } // <3> 處理單個引數校驗失敗丟擲的異常 @ExceptionHandler(ConstraintViolationException.class) public ResultInfo constraintViolationExceptionHandler(ConstraintViolationException e) { Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations(); List<String> collect = constraintViolations.stream() .map(o -> o.getMessage()) .collect(Collectors.toList()); return new ResultInfo().success(HttpStatus.BAD_REQUEST.value(), BAD_REQUEST_MSG, collect); } }
事實上,在全域性異常處理類中,我們可以寫多個異常處理方法,課代表總結了三種引數校驗時可能引發的異常:
(1)使用form data方式呼叫介面,校驗異常丟擲 BindException
(2)使用 json 請求體呼叫介面,校驗異常丟擲 MethodArgumentNotValidException
(3)單個引數校驗異常丟擲ConstraintViolationException
注:單個引數校驗需要在引數上增加校驗註解,並在類上標註@Validated。
全域性異常處理類可以新增各種需要處理的異常,比如新增一個對Exception.class的異常處理,當所有ExceptionHandler都無法處理時,由其記錄異常資訊,並返回友好提示。
6. 分組校驗
如果同一個引數,需要在不同場景下應用不同的校驗規則,就需要用到分組校驗了。比如:新註冊使用者還沒起名字,我們允許name欄位為空,但是不允許將名字更新為空字元。
分組校驗有三個步驟:
(1)定義一個分組類(或介面)
public interface Update extends Default{ }
(2)在校驗註解上新增groups屬性指定分組
public class UserVO { @NotBlank(message = "name 不能為空",groups = Update.class) private String name; // 省略其他程式碼... }
(3)Controller方法的@Validated註解新增分組類
@PostMapping("update") public ResultInfo update(@Validated({Update.class}) UserVO userVO) { return new ResultInfo().success(userVO); }
細心的同學可能已經注意到,自定義的Update分組介面繼承了Default介面。校驗註解(如:@NotBlank)和@validated預設都屬於Default.class分組,這一點在javax.validation.groups.Default註釋中有說明
/** * Default Jakarta Bean Validation group. * <p> * Unless a list of groups is explicitly defined: * <ul> * <li>constraints belong to the {@code Default} group</li> * <li>validation applies to the {@code Default} group</li> * </ul> * Most structural constraints should belong to the default group. * * @author Emmanuel Bernard */ public interface Default { }
在編寫Update分組介面時,如果繼承了Default,下面兩個寫法就是等效的:
@Validated({Update.class})
@Validated({Update.class,Default.class})
請求一下/update介面可以看到,不僅校驗了name欄位,也校驗了其他預設屬於Default.class分組的欄位
{ "status": 400, "message": "客戶端請求引數錯誤", "response": [ "name 不能為空", "age 不能為空", "email 不能為空" ] }
7. 遞迴校驗
如果 UserVO 類中增加一個 OrderVO 類的屬性,而 OrderVO 中的屬性也需要校驗,就用到遞迴校驗了,只要在相應屬性上增加@Valid註解即可實現(對於集合同樣適用)
OrderVO類如下
public class OrderVO { @NotNull private Long id; @NotBlank(message = "itemName 不能為空") private String itemName; // 省略其他程式碼... }
在 UserVO 類中增加一個 OrderVO 型別的屬性
public class UserVO { @NotBlank(message = "name 不能為空",groups = Update.class) private String name; //需要遞迴校驗的OrderVO @Valid private OrderVO orderVO; // 省略其他程式碼... }
呼叫請求驗證如下:
8. 自定義校驗
Spring 的 validation 為我們提供了這麼多特性,幾乎可以滿足日常開發中絕大多數引數校驗場景了。但是,一個好的框架一定是方便擴充套件的。有了擴充套件能力,就能應對更多複雜的業務場景,畢竟在開發過程中,唯一不變的就是變化本身。
Spring Validation允許使用者自定義校驗,實現很簡單,分兩步:
(1)自定義校驗註解
(2)編寫校驗者類
程式碼也很簡單,結合註釋你一看就能懂
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER}) @Retention(RUNTIME) @Documented @Constraint(validatedBy = {HaveNoBlankValidator.class})// 標明由哪個類執行校驗邏輯 public @interface HaveNoBlank { // 校驗出錯時預設返回的訊息 String message() default "字串中不能含有空格"; Class<?>[] groups() default { }; Class<? extends Payload>[] payload() default { }; /** * 同一個元素上指定多個該註解時使用 */ @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }) @Retention(RUNTIME) @Documented public @interface List { NotBlank[] value(); } }
public class HaveNoBlankValidator implements ConstraintValidator<HaveNoBlank, String> { @Override public boolean isValid(String value, ConstraintValidatorContext context) { // null 不做檢驗 if (value == null) { return true; } if (value.contains(" ")) { // 校驗失敗 return false; } // 校驗成功 return true; } }
自定義校驗註解使用起來和內建註解無異,在需要的欄位上新增相應註解即可,同學們可以自行驗證。