【Java】使用 validation 完成自定義校驗注解

總括：

validation 讓我們簡化了開發過程，可以使用簡單的一個注解就實現了很多常見的檢驗數據的功能，同時支持自定義注解。spring-boot-starter-validation 是由 Spring Boot 整合的一套用于處理validation 的約定化自動配置啟動器。Spring 系列框架通過簡單的安裝依賴即可直接使用 validation 提供的參數校驗功能，通過為接口添加 @Valid / @Validated 對特定參數進行校驗。

使用方法：

1. 安裝依賴

    org.springframework.boot    spring-boot-starter-validation

如果已使用 Spring Boot 框架可以不指定版本號，依賴于Spring Boot 版本。

(資料圖)

2. 接口參數添加@Valid / @Validated 進行參數校驗

@RequestMapping("/doLogin")@ResponseBodypublic ResponseBean doLogin(@Valid LoginVo loginVo, HttpServletRequest request, HttpServletResponse response) {    return userService.doLogin(loginVo, request, response);}

3. 在需要進行校驗的參數的屬性上使用validation 基礎注解

/* 空檢查 */@Null　　　　 // 驗證對象是否為null@NotNull        // 驗證對象是否不為null, 無法查檢長度為0的字符串@NotBlank　　　　　　// 檢查約束字符串是不是Null還有被Trim的長度是否大于0,只對字符串,且會去掉前后空格.@NotEmpty　　　　　　// 檢查約束元素是否為NULL或者是EMPTY. /* Booelan檢查 */@AssertTrue　　　　　 // 驗證 Boolean 對象是否為 true  @AssertFalse  　      // 驗證 Boolean 對象是否為 false  /* 長度檢查 */@Size(min=, max=)　　 // 驗證對象（Array,Collection,Map,String）長度是否在給定的范圍之內  @Length(min=, max=)  　　// 驗證注解的元素值長度在min和max區間內/* 日期檢查 */@Past      　　  // 驗證 Date 和 Calendar 對象是否在當前時間之前  @Future    　　    // 驗證 Date 和 Calendar 對象是否在當前時間之后  @Pattern    　　    // 驗證 String 對象是否符合正則表達式的規則/* 數值檢查，建議使用在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=) // IP地址校驗                

4. 自定義參數校驗注解

4.1 自定義注解

可以照抄@NotNull 等基礎校驗注解的寫法

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})@Retention(RetentionPolicy.RUNTIME)@Documented@Constraint(        validatedBy = {IsMobileValidator.class})public @interface IsMobile {    boolean required() default true;    String message() default "手機號碼格式錯誤";    Class[] groups() default {};    Class[] payload() default {};}

4.2 實現ConstraintValidator 接口，用以實現自定義參數校驗邏輯

public class IsMobileValidator implements ConstraintValidator {    　　private boolean required = false;　　 /**　　　*@Param: {@link IsMobile } constraintAnnotation　　　*@Return: void　　　*@TODO: 初始化方法，可以用自定義注解中獲取值進行初始化  　　**/    @Override    public void initialize(IsMobile constraintAnnotation) {        required = constraintAnnotation.required();    }　　　　　　 /**　　  *@Param: {@link String} value　　　*@Param: {@link ConstraintValidatorContext } constraintValidatorContext　　　*@Return: {@link boolean}　　　*@TODO: 實際校驗自定義注解 value 值　　　**/    @Override    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {        if(required){            return ValidatorUtil.isMobile(value);        }else {            if(StringUtils.isEmpty(value)){                return true;            }else {                return ValidatorUtil.isMobile(value);            }        }    }}

其中IsMobile 為自定義注解名(根據個人需求自己命名)，isValid 方法具體校驗邏輯由個人需求及業務確定。使用時同基礎校驗注解一般放置在需要校驗的參數屬性上即可。

注意：自定義注解上必須有@Constraint 注解，其中validatedBy 指定執行校驗的類，該類必須實現ConstraintValidator 接口

標簽：