什么是JSR303

JSR是JAVA Specification Requests的縮寫，意思是Java 規范提案。是指向JCP(Java Community Process)提出新增 一個標準化技術規范的正式請求。任何人都可以提交JSR，以向Java平臺增添新的API和服務。JSR已成為Java 界定的一個重要標準。

自帶的校驗注解都有哪些？

提供的注解都在 import
javax.validation.constraints這個包下面的

下面我們先簡單的使用下基本注解校驗

首先我們先準備一個VO

注解 @NotNull 校驗 page 和 limit 屬性 這里手動制定了message 如果不手動指定的話會去加載默認的message

ValidationMessages.properties文件中

@Data
@ApiModel(description= "ListVO")
public class ListVo {
    @NotNull(message = "頁碼不能為空")
    @ApiModelProperty(value = "頁碼")
    private Integer page;
    @NotNull(message = "分頁大小不能為空")
    @ApiModelProperty(value = "分頁大小")
    private Integer limit;
    @ApiModelProperty(value = "搜索條件")
    private Object searchObj;
}
復制代碼

開啟注解校驗

@Valid 開啟校驗，BindingResult 緊跟著注解校驗對象后面可以獲取到校驗結果

@PostMApping("/getlist")
@SysOperaLog("獲取日志列表")
public R getlist(@Valid @RequestBody ListVo parm, BindingResult bindingResult){
    if(bindingResult.hasErrors()){
        Map<String,Object> map = new HashMap<>();
        bindingResult.getFieldErrors().forEach((e)->{
            //錯誤提示信息
            String defaultMessage = e.getDefaultMessage();
            //出問題的屬性
            String field = e.getField();
            map.put("message",defaultMessage);
            map.put("field",field);
        });
    return     R.error().data(map);
    }
    return  iLogService.getList(parm);
}
復制代碼

下面我們使用 postman 測試一下

下面我們使用以下 如何使用 自定義校驗

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

@DataCheck 注解

//可以被標注到那個地方
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
//這里指向的是我們自定義的校驗規則，可以治黨多個不同校驗器，適配不同的情況
@Constraint(validatedBy = {DataCheckVaildator.class})
public @interface DataCheck {
    //當然這里的message也可以去屬性文件中指定
    String message() default "請提交規范數據";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
    //用來獲取注解屬性值
    int[] vals() default {};
}
復制代碼

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

自定義校驗器

public class DataCheckVaildator implements ConstraintValidator<DataCheck,Integer> {

    private Set<Integer> setNum = new HashSet<>();
    //初始化方法
    @Override
    public void initialize(DataCheck constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            setNum.add(val);
        }
    }

    @Override
    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
    //如果包含我們規定的 數據就會返回true  不包含就會返回false
        return setNum.contains(integer);
    }
}
復制代碼

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

在自定義的注解上面將我們自定義的校驗器進行綁定

@Constraint(validatedBy = {DataCheckVaildator.class})
復制代碼

使用@DataCheck 進行分頁大小的校驗 只能傳遞 10,20,30,40,50

@Data
@ApiModel(description= "ListVO")
public class ListVo {
    @NotNull(message = "頁碼不能為空")
    @ApiModelProperty(value = "頁碼")
    private Integer page;
    @NotNull(message = "分頁大小不能為空")
    @DataCheck(vals={10,20,30,40,50})
    @ApiModelProperty(value = "分頁大小")
    private Integer limit;
    @ApiModelProperty(value = "搜索條件")
    private Object searchObj;
}
復制代碼

使用Postman調用 可以看到 limit 傳遞的值不在 規定返回之內時完成校驗

不在規定返回之內：

返回提示信息

在規定返回之內時：

正常返回數據