Java web服務端參數校驗Javax.validation （springboot）

一、基本使用

       Javax.validation是spring集成自帶的一個參數校驗接口。可通過添加注解來設置校驗條件。

下面以springboot項目為例進行說明。創建web項目后，不需要再添加其他的依賴；

1、 被校驗參數

public class User {

    private Long id;
    @NotBlank(message = "用戶名不能為空")
    private String name;
    @NotBlank(message = "手機號不能為空")
    private String phone;
    @NotNull(message = "年齡不能為空")
    private Integer age;
}

2、Controller

@RestController
public class TestController {

    @RequestMapping("/create")
    public String createUser(@Valid User user, BindingResult bindingResult){
        if (bindingResult.hasErrors()){
            return bindingResult.getFieldError().getDefaultMessage();
        }
        return  "success";
    }
}

3、啟動服務，然后在本地請求，如果請求參數不對，即可看到我們給出的錯誤信息

 

 

 

二、所有原生可用的注解

@NotBlank            元素不能為null，且不能全是空格，用於校驗字符串；
@NotEmpty            元素不能為null，且不能為空，用於校驗集合類型數據；
@NotNull             元素不能為null，所有類型的數據都可以校驗；
@Null                元素必須為null, 所有類型的數據都可以校驗；
@Size(min = 1, max = 5)    元素長度介於給定值之前(包含邊界)，用於校驗集合類型數據(包含字符串)，；
@Future        　　　　　　　元素為時間，且是將來的時間；
@FutureOrPresent      　   元素為時間，且是現在或將來的時間；
@Past    　　　　　　　　　　 元素為時間，且是已經過去的時間；
@PastOrPresent   　　　　   元素為時間，且是現在或已經過去的時間；
@Max(value = 2)   　　　　  元素值不大於給定值value,可校驗所有Number類型數據(除了double和float)；;
@Min(value = 1)   　　　　  元素值不小於給定值value,可校驗所有Number類型數據(除了double和float)；;
@Negative 　　　　　　　　　 元素值為負數,可校驗所有Number類型數據；;
@NegativeOrZero   　　　　  元素值為負數或0,可校驗所有Number類型數據；;
@Positive　　　　　　　　　　元素值為正數,可校驗所有Number類型數據；;
@PositiveOrZero  　　　　  元素值為正數或0,可校驗所有Number類型數據；;
@DecimalMax(inclusive = true, value = "3.2") 　　元素值不大於給定值value, inclusive默認是true，可不填，可校驗所有Number類型數據(除了double和float)；
@DecimalMin(inclusive = false, value = "23")　 　元素值大於給定值value, inclusive默認是true，可不填，可校驗所有Number類型數據(除了double和float)；
@Digits(integer = 5, fraction = 7)   　　　　　　 元素為數字，且最大長度不超過7位，整數部分最高位不超過5位；
@AssertFalse               元素的值必須為false,用於校驗布爾類型元素；
@AssertTrue                元素的值必須為true,用於校驗布爾類型元素；
@Email        　　　　　　　 郵箱名格式校驗

注：除了前4個外，其他所有的null會被當作有效處理；

三、自定義校驗注解

1、定義注解

@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = NameValidator.class)
public @interface NameA {

    String message()  default "這個名字不是以a開頭";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

注意定義時message(),groups(),payload()這三個方法必需要定義，其他的就可以自己增加了；

2、定義校驗方法；

public class NameValidator implements ConstraintValidator<NameA, String> {

    private String reg = "[a,]\\w+";
    private Pattern pattern = Pattern.compile(reg);

    @Override
    public void initialize(NameA name){

    }

    @Override
    public boolean isValid(String name, ConstraintValidatorContext context){
        if (name == null){
            return  false;
        }
        return pattern.matcher(name).matches();
    }
}