分組校驗

JSR303校驗

一、環境准備

這個pom坐標在自定義注解的時候有用

 <dependency>
      <groupId>javax.validation</groupId>
      <artifactId>validation-api</artifactId>
      <version>2.0.1.Final</version>
  </dependency>

 

二、JSR 303 基本的校驗規則

1、空檢查

 @Null 驗證對象是否為null 
 @NotNull 驗證對象是否不為null, 無法查檢長度為0的字符串 
 @NotBlank 檢查約束字符串是不是Null還有被Trim的長度是否大於0,只對字符串,且會去掉前后空格. 
 @NotEmpty 檢查約束元素是否為NULL或者是EMPTY.

2、Booelan檢查

 @AssertTrue 驗證 Boolean 對象是否為 true 
 @AssertFalse 驗證 Boolean 對象是否為 false

3、長度檢查

 @Size(min=, max=) 驗證對象（Array,Collection,Map,String）長度是否在給定的范圍之內 
 @Length(min=, max=) Validates that the annotated string is between min and max included.

 

4、日期檢查

 @Past 驗證 Date 和 Calendar 對象是否在當前時間之前，驗證成立的話被注釋的元素一定是一個過去的日期 
 @Future 驗證 Date 和 Calendar 對象是否在當前時間之后 ，驗證成立的話被注釋的元素一定是一個將來的日期 
 @Pattern 驗證 String 對象是否符合正則表達式的規則，被注釋的元素符合制定的正則表達式，regexp:正則表達式 flags: 指定 Pattern.Flag 的數組，表示正則表達式的相關選項。

5、數值檢查

建議使用在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=) 被指定的元素必須在合適的范圍內 
 @Range(min=10000,max=50000,message=”range.bean.wage”) 
 @Valid 遞歸的對關聯對象進行校驗, 如果關聯對象是個集合或者數組,那么對其中的元素進行遞歸校驗,如果是一個map,則對其中的值部分進行校驗.(是否進行遞歸驗證) 
 @CreditCardNumber信用卡驗證 
 @Email 驗證是否是郵件地址，如果為null,不進行驗證，算通過驗證。 
 @ScriptAssert(lang= ,script=, alias=) 
 @URL(protocol=,host=, port=,regexp=, flags=)

三、案例

1、寫一個java bean

 @Data
 public class User {
 ​
     @NotNull(message = "更新時必須攜帶ID",groups = {UpdateGroup.class})
     @Null(message = "插入時不能攜帶id",groups = {InsertGroup.class})
     private Integer id;
 ​
     @NotEmpty(message = "名字不能為空")
     private String name;
 ​
     @Email(message = "郵箱不能為空")
     private String email;
 ​
 ​
     private String phone;
 }

 

2、在controller的參數上加上注解@Valid

controller

 @RestController
 @Slf4j
 public class UserController {
 ​
     @PostMapping("/jsr303")
     public R jsr303Test(@Valid @RequestBody User user){
         log.info("參數user:{}",user);
         return R.ok() ;
     }
 ​
 }

 

3、異常處理類

@Slf4j
 @RestControllerAdvice(basePackages = "com.ybl.test.controller")
 public class MyExceptionControllerAdvice {
 ​
 ​
     /**
      * @ExceptionHandler 是為了告訴RestControllerAdvice能處理哪些異常
      * @param e
      * @return
      */
     @ExceptionHandler(value= MethodArgumentNotValidException.class)
     public R handleVaildException(MethodArgumentNotValidException e){
         log.error("數據校驗出現問題{}，異常類型：{}",e.getMessage(),e.getClass());
         //獲取數據校驗的結果
         BindingResult bindingResult = e.getBindingResult();
 ​
         Map<String,String> errorMap = new HashMap<>();
         /**
          * 獲取所有的錯誤消息
          * key 存錯誤字段
          * value 存message
          */
         bindingResult.getFieldErrors().forEach((fieldError)->{
             errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
         });
         return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(),BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data",errorMap);
     }
 ​
     @ExceptionHandler(value = Throwable.class)
     public R handleException(Throwable throwable){
 ​
         log.error("錯誤：",throwable);
         return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
     }
 }

 

4、數據返回類

public class R extends HashMap<String, Object> {
     private static final long serialVersionUID = 1L;
 ​
     public R() {
         put("code", 0);
         put("msg", "success");
     }
 ​
     public static R error() {
         return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, "未知異常，請聯系管理員");
     }
 ​
     public static R error(String msg) {
         return error( HttpStatus.SC_INTERNAL_SERVER_ERROR, msg);
     }
 ​
     public static R error(int code, String msg) {
         R r = new R();
         r.put("code", code);
         r.put("msg", msg);
         return r;
     }
 ​
     public static R ok(String msg) {
         R r = new R();
         r.put("msg", msg);
         return r;
     }
 ​
     public static R ok(Map<String, Object> map) {
         R r = new R();
         r.putAll(map);
         return r;
     }
 ​
     public static R ok() {
         return new R();
     }
 ​
     @Override
     public R put(String key, Object value) {
         super.put(key, value);
         return this;
     }
     public  Integer getCode() {
 ​
         return (Integer) this.get("code");
     }
 ​
 }

 

5、錯誤信息枚舉類

public enum BizCodeEnume {
     UNKNOW_EXCEPTION(10000,"系統未知異常"),
     VAILD_EXCEPTION(10001,"參數格式校驗失敗");
 ​
     private int code;
     private String msg;
     BizCodeEnume(int code, String msg){
         this.code = code;
         this.msg = msg;
     }
 ​
     public int getCode() {
         return code;
     }
 ​
     public String getMsg() {
         return msg;
     }
 }

 

6、測試：

正常：

 

 

 

缺少ID：

 

 

 

 

四、分組校驗

比如，我們在update和insert的時候校驗規則是不同的，insert的時候，id可以不需要，update的時候id就必須帶着。

在上面的校驗注解中可以填寫groups的參數，這個參數就是用來標識那種分組，然后針對不同情況校驗。

 

 

 

groups是一個數組，可以指定多個分組，而且規定這個分組必須是一個接口，這些接口不需要寫接口方法。

1、接口定義

 public interface UpdateGroup {
 }
 public interface InsertGroup {
 }

 

2、更改校驗規則

 @Data
 public class User {
 ​
     @NotNull(message = "更新時必須攜帶ID",groups = {UpdateGroup.class})
     @Null(message = "插入時不能攜帶id",groups = {InsertGroup.class})
     private Integer id;
 ​
     @NotEmpty(message = "名字不能為空")
     private String name;
 ​
     @Email(message = "郵箱不能為空")
     private String email;
 ​
 ​
     private String phone;
 }

 

3、編寫controler

這里校驗注解使用的是@Validated，它是由Spring提供的，@Valid是由jsr303提供的一種規范，@Validated支持一個添加分組的參數

@Validated:

 

 

 

@Valid:

 

 

 

 

@PostMapping("/insert")
public R jsr303Insert(@Validated(InsertGroup.class) @RequestBody User user){
     log.info("insert=======user:{}",user);
     return R.ok() ;
}
 ​
@PostMapping("/update")
public R jsr303Update(@Validated(UpdateGroup.class) @RequestBody User user){
     log.info("update-------user:{}",user);
     return R.ok() ;
}

 

4、測試：

測試insert

localhost:8080/insert

不攜帶id

 

 

 

攜帶id：

 

 

 

測試update

localhost:8080/update

不攜帶id：

 

 

 

攜帶id：

 

 

 

五、自定義校驗注解

假如我們需要在上面的類添加一個字段status，用來標識當前用戶是否可用，而這個字段只允許使用兩個值0和1，0表示不能用，1表示能用，我們在修改這個字段的時候需要校驗這個值。我們下面就來講解怎么自定義校驗注解

1、編寫一個自定義的校驗注解

先來創建這個注解

 public @interface ListValue {
 }

 

要怎么寫呢？我們可以參考jsr303提供的校驗注解是怎么寫得，以NotNull為例：

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
 @Retention(RUNTIME)
 @Repeatable(List.class)
 @Documented
 @Constraint(validatedBy = { })
 public @interface NotNull {
     String message() default "{javax.validation.constraints.NotNull.message}";
 ​
     Class<?>[] groups() default { };
 ​
     Class<? extends Payload>[] payload() default { };
 ​
     /**
      * Defines several {@link NotNull} annotations on the same element.
      *
      * @see javax.validation.constraints.NotNull
      */
     @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
     @Retention(RUNTIME)
     @Documented
     @interface List {
 ​
         NotNull[] value();
     }
 }

 

可以看到需要有三個屬性

message：出現錯誤，錯誤信息去哪里取(去ValidationMessages.properties這個配置文件中取錯誤信息).

groups:定義分組，那些分組能用。

payload：自定義一些負載信息

作為一個注解，他還需要標注一些元信息數據，比如：

@Target用於標識這個注解能寫在那些地方(類、方法、構造等)

@Retention用於標識運行時機

@Constraint用於指定那個校驗器進行校驗

@Repeatable可重復注解

@Documented它會被 javadoc 之類的工具處理, 所以注解類型信息也會被包括在生成的文檔中，是一個標記注解，沒有成員。

編寫java類：

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
 @Retention(RUNTIME)
 @Documented
 @Constraint(validatedBy = { })
 public @interface ListValue {
     
     
     String message() default "{com.ybl.test.valid.ListValue.message}";
 ​
     Class<?>[] groups() default { };
 ​
     Class<? extends Payload>[] payload() default { };
 ​
 ​
     int[] vals() default { };
 }

 

編寫ValidationMessages.properties：

 com.ybl.test.valid.ListValue.message=“必須提交指定的值”

@Constraint中validatedBy可以指定校驗器，我們下面就來編寫自定義的校驗器

2、編寫一個自定義的校驗器

參考上面，我們先來看一下校驗器是怎么做的

 @Documented
 @Target({ ANNOTATION_TYPE })
 @Retention(RUNTIME)
 public @interface Constraint {
     Class<? extends ConstraintValidator<?, ?>>[] validatedBy();
 }

 

可以看出，他是使用ConstraintValidator來校驗的。ConstraintValidator是一個接口：

 public interface ConstraintValidator<A extends Annotation, T> {
 ｝

這個接口有兩個泛型，第一個泛型用來指定要校驗的注解，第二個泛型指定我們要校驗什么類型的數據。

接下來，我們來實現這個接口

public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
 ​
     private Set<Integer> set = new HashSet<Integer>();
 ​
     /**
      * 初始化方法，他會將注解的詳細信息vals、message拿到
      * @param constraintAnnotation
      */
     @Override
     public void initialize(ListValue constraintAnnotation) {
         int[] vals = constraintAnnotation.vals();
         if(vals != null || vals.length>0){
             for (int val : vals) {
                 set.add( val );
             }
         }
     }
 ​
     /**
      * 判斷是否校驗成功
      * @param value 需要校驗的值，也就是我們前台傳過來的值
      * @param context
      * @return
      */
     @Override
     public boolean isValid(Integer value, ConstraintValidatorContext context) {
         
         return set.contains( value );
     }
 }

 

自定義校驗器定義好了，我們就要把校驗器和校驗注解關聯起來。

3、關聯自定義的校驗器和校驗注解

校驗器和校驗注解關聯起來，validateBy是用來指定校驗器的，

 @Constraint(validatedBy = { ListValueConstraintValidator.class })

4、測試是否能成功

 @ListValue(vals = {0, 1}, groups = {UpdateGroup.class})
 private Integer status;

編寫controller

 @PostMapping("/status")
 public R jsr303Status(@Validated({UpdateGroup.class}) @RequestBody User user){
     log.info("Status-------user:{}",user);
     return R.ok() ;
 }

 

訪問：localhost:8080/status

4.1、測試status為1或者2

 

 

 

 

4.2、測試其他值

 

 

測試結果是我們想要的，自定義校驗器編寫成功。