寄居の友人c

JSR-303 參數校驗及自定義注解

導入依賴

<!--        數據校驗-->
        <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>2.0.1.Final</version>
        </dependency>

在實體類上標注解。

空檢查
@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=) Validates that the annotated string is between min and max included.

日期檢查
@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=) 檢查數字是否介于min和max之間.
@Range(min=10000,max=50000,message="range.bean.wage")
private BigDecimal wage;

@Valid 遞歸的對關聯對象進行校驗, 如果關聯對象是個集合或者數組,那么對其中的元素進行遞歸校驗,如果是一個map,則對其中的值部分進行校驗.(是否進行遞歸驗證)
@CreditCardNumber信用卡驗證
@Email  驗證是否是郵件地址，如果為null,不進行驗證，算通過驗證。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)

以上來自網絡

分組校驗

@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})

新建一些空接口AddGroup、 UpdateStatusGroup

在controller里的參數里面加上@Validated({AddGroup.class})，就OK了

自定義注解

創建注解ListValue。

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

    int[] vals() default { }; //屬性值，可以填的內容，就如groups()，這個。使用時：@ListValue(vals={0,1})在controller方法李曼
}

自定義注解需要三個屬性：

	String message() default "{從ValidationMessages.properties中取出錯誤的值}"; //出錯信息，可以在使用時填上，就不顯示這個文件里面的內容了，eg:com.atguigu.common.valid.ListValue.message (從配置文件中取出來)
	Class<?>[] groups() default { };
	Class<? extends Payload>[] payload() default { };

還需要幾個注解：

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = { })  //自定義校驗器。里面填寫自定義的校驗器class

創建文件ValidationMessages.properties（默認的文件），填寫com.atguigu.common.valid.ListValue.message = "必須添加內容"

創建自定義校驗器類，繼承ConstrainValidator接口:

public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
    private Set<Integer> set = new HashSet<>();
    //初始化方法
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            set.add(val);
        }
    }
    //判斷是否校驗成功
    /**
     * @param value 需要校驗的值
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }