前言

後臺開發中對引數的校驗是不可缺少的一個環節，為了解決如何優雅的對引數進行校驗？

  • JSR303（Java Specification Requests）應運而生，JSR303 是JavaBean引數校驗的標準。
  • Bean Validation 為 JavaBean 驗證定義了相應的元資料模型和 API。
  • Hibernate validator 5 是 Bean Validation 1.1的實現。

常見註解

  • Bean Validation中定義的註解：
註解 詳細資訊
@Null 被註釋的元素必須為 null
@NotNull 被註釋的元素必須不為 null
@AssertTrue 被註釋的元素必須為 true
@AssertFalse 被註釋的元素必須為 false
@Min(value) 被註釋的元素必須是一個數字，其值必須大於等於指定的最小值
@Max(value) 被註釋的元素必須是一個數字，其值必須小於等於指定的最大值
@DecimalMin(value) 被註釋的元素必須是一個數字，其值必須大於等於指定的最小值
@DecimalMax(value) 被註釋的元素必須是一個數字，其值必須小於等於指定的最大值
@Size(max, min) 被註釋的元素的大小必須在指定的範圍內
@Digits (integer, fraction) 被註釋的元素必須是一個數字，其值必須在可接受的範圍內
@Past 被註釋的元素必須是一個過去的日期
@Future 被註釋的元素必須是一個將來的日期
@Pattern(value) 被註釋的元素必須符合指定的正則表示式
  • Hibernate validator 在JSR303的基礎上對校驗註解進行了擴充套件，擴充套件註解如下：
註解 詳細資訊
@Email 被註釋的元素必須是電子郵箱地址
@Length 被註釋的字串的大小必須在指定的範圍內
@NotEmpty 被註釋的字串的必須非空
@Range 被註釋的元素必須在合適的範圍內

引數校驗的應用

依賴

  1. <!-- hibernate validator-->
  2. <dependency>
  3.     <groupId>org.hibernate</groupId>
  4.     <artifactId>hibernate-validator</artifactId>
  5.     <version>5.2.4.Final</version>
  6. </dependency>

簡單的引數校驗示例

  • 要想開啟引數校驗，需要在類上標註@Validated註解
  • 控制器
  1.  @PostMapping(value = "/test")
  2.  public ValidOneEvt param(@RequestBody @Validated ValidOneEvt evt){
  3.      return evt;
  4.  }
  • 實體驗證
  1. @Getter
  2. @Builder
  3. public class ValidOneEvt {
  5.     @NotEmpty(message = "名稱不能為空")
  6.     private String name;
  8.     private String sex;
  10. }
  • 測試結果

級聯校驗

  • 級聯校驗需要在校驗的實體上新增@Valid。
  • 控制器
  1. @PostMapping(value = "/test")
  2. public ValidOneEvt param(@RequestBody @Validated ValidOneEvt evt){
  3.     return evt;
  4. }
  • 實體驗證
  1. @Getter
  2. @Builder
  3. public class ValidOneEvt {
  5.     @NotEmpty(message = "名稱不能為空")
  6.     private String name;
  8.     private String sex;
  10.     @Valid
  11.     private ValidTwoEvt validTwoEvt;
  13. }
  • 級聯實體
  1. @Getter
  2. @Setter
  3. public class ValidTwoEvt {
  5.     @Length(min = 2)
  6.     private String name;
  8. }
  • 請求示例

  • 校驗結果

@Validated 與 @Valid

兩者具有相似性

註解地方

  • @Valid：可以用在方法、建構函式、方法引數和成員屬性（欄位）上。
  • @Validated：可以用在型別、方法和方法引數上，不能用在成員屬性（欄位）上。

@Validated和@Valid在級聯驗證功能上的區別

  • @Valid：用在方法入參上無法單獨提供級聯驗證功能。能夠用在成員屬性（欄位）上，提示驗證框架進行級聯驗證。

  • @Validated：用在方法入參上無法單獨提供級聯驗證功能。不能用在成員屬性（欄位）上，也無法提示框架進行級聯驗證。能配合級聯驗證註解@Valid進行級聯驗證。

  • 總結： 通常使用@Validated， 級聯驗證使用@Valid。

自定義校驗註解

自定義校驗註解用於基礎校驗註解不能滿足業務需求。

  • 自定義效驗註解驗證密碼是否相等
  1. import javax.validation.Constraint;
  2. import javax.validation.Payload;
  3. import java.lang.annotation.*;
  5. /**
  6.  * @Description 自定義引數校驗註解
  7.  *      @Documented 註解中的註釋加入文件
  8.  *      @Retention 註解保留階段 RetentionPolicy.RUNTIME 執行階段
  9.  *      @Target 作用目標,註解的使用範圍 TYPE:用於描述類、介面(包括註解型別) 或enum宣告
  10.  *      @Constraint 將註解和註解關聯類關聯到一起
  11.  * @author coisini
  12.  * @date Aug 10, 2021
  13.  * @Version 1.0
  14.  */
  15. @Documented
  16. @Retention(RetentionPolicy.RUNTIME)
  17. @Target({ElementType.TYPE})
  18. @Constraint(validatedBy = PasswordValidator.class)
  19. public @interface PasswordEquals {
  21.     int min() default 4;
  23.     int max() default 6;
  25.     String message() default "passwords are not equal";
  27.     Class<?>[] groups() default {};
  29.     Class<? extends Payload>[] payload() default {};
  31. }
  • 自定義校驗註解關聯類
  1. import javax.validation.ConstraintValidator;
  2. import javax.validation.ConstraintValidatorContext;
  4. /**
  5.  * @Description 自定義校驗註解關聯類
  6.  *      ConstraintValidator的第一個引數：註解的型別
  7.  *      ConstraintValidator的第二個引數：自定義註解修飾的目標的型別
  8.  * @author coisini
  9.  * @date Aug 10, 2021
  10.  * @Version 1.0
  11.  */
  12. public class PasswordValidator implements ConstraintValidator<PasswordEquals, ValidEvt> {
  14.     private int min;
  15.     private int max;
  17.     /**
  18.      * 初始化獲取註解引數
  19.      * @param constraintAnnotation
  20.      */
  21.     @Override
  22.     public void initialize(PasswordEquals constraintAnnotation) {
  23.         this.min = constraintAnnotation.min();
  24.         this.max = constraintAnnotation.max();
  25.     }
  27.     /**
  28.      * 校驗引數
  29.      * @param value
  30.      * @param context
  31.      * @return
  32.      */
  33.     @Override
  34.     public boolean isValid(ValidEvt value, ConstraintValidatorContext context) {
  35.         String password1 = value.getPassword1();
  36.         String password2 = value.getPassword2();
  38.         return password1.equals(password2) && this.validLength(password1, password2);
  39.     }
  41.     /**
  42.      * 校驗密碼長度
  43.      * @param password1
  44.      * @param password2
  45.      * @return
  46.      */
  47.     private boolean validLength(String password1, String password2) {
  48.         return password1.length() > min && password1.length() < max
  49.                 && password2.length() > min && password2.length() < max;
  50.     }
  52. }
  • 自定義註解校驗類
  1. /**
  2.  * @Description 自定義註解校驗類
  3.  * @author coisini
  4.  * @date Aug 10, 2021
  5.  * @Version 1.0
  6.  */
  7. @Getter
  8. @Builder
  9. @PasswordEquals(min = 1, message = "Incorrect password length or passwords are not equal")
  10. public class ValidEvt {
  12.     private String password1;
  13.     private String password2;
  15. }
  • 引數驗證異常統一處理
  1. @ControllerAdvice
  2. public class GlobalExceptionAdvice {
  3. 	/**
  4.      * 引數校驗異常處理器
  5.      * @return
  6.      */
  7.     @ExceptionHandler(MethodArgumentNotValidException.class)
  8.     @ResponseBody
  9.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  10.     public UnifyMessage handleBeanValidation(HttpServletRequest request, MethodArgumentNotValidException e) {
  11.         String method = request.getMethod();
  12.         String requestUrl = request.getRequestURI();
  13.         System.out.println(e);
  15.         List<ObjectError> errors = e.getBindingResult().getAllErrors();
  16.         String message = formatAllErrorMessages(errors);
  18.         return new UnifyMessage(10001, message,method + " " + requestUrl);
  19.     }
  21.     /**
  22.      * 自定義註解校驗異常處理器
  23.      * @param req
  24.      * @param e
  25.      * @return
  26.      */
  27.     @ExceptionHandler(ConstraintViolationException.class)
  28.     @ResponseBody
  29.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  30.     public UnifyMessage handleConstrainException(HttpServletRequest req, ConstraintViolationException e){
  31.         String method = req.getMethod();
  32.         String requestUrl = req.getRequestURI();
  33.         String message = e.getMessage();
  34.         return new UnifyMessage(10001, message,method + " " + requestUrl);
  35.     }
  37.     /**
  38.      * 異常訊息拼接
  39.      * @param errors
  40.      * @return
  41.      */
  42.     private String formatAllErrorMessages(List<ObjectError> errors){
  43.         StringBuffer errorMsg = new StringBuffer();
  44.         errors.forEach(error ->
  45.                 errorMsg.append(error.getDefaultMessage()).append(";")
  46.         );
  47.         return errorMsg.toString();
  48.     }
  49. }
  • 統一訊息返回
  1. /**
  2.  * @Description 統一訊息返回
  3.  * @author coisini
  4.  * @date Aug 9, 2021
  5.  * @Version 1.0
  6.  */
  7. public class UnifyMessage {
  9.     private int code;
  10.     private String message;
  11.     private String requestUrl;
  13.     public int getCode() {
  14.         return code;
  15.     }
  17.     public String getMessage() {
  18.         return message;
  19.     }
  21.     public String getRequestUrl() {
  22.         return requestUrl;
  23.     }
  25.     public UnifyMessage(int code, String message, String requestUrl) {
  26.         this.code = code;
  27.         this.message = message;
  28.         this.requestUrl = requestUrl;
  29.     }
  31. }
  • 測試類
  1. @PostMapping(value = "/test1")
  2. public ValidEvt test1(@RequestBody @Validated ValidEvt evt){
  3.     return evt;
  4. }
  • 測試結果

- End -
﹀
﹀
﹀
夢想是鹹魚
關注一下吧