使用自定義註解進行restful請求參數的校驗

在使用springmvc開發的時候,我們通常會在controller中的方法參數實體類中加上@NotNull()等類似註解,然後在方法參數上加上

@Vilad 註解,這樣在有請求的時候,就會自動按照我們的註解進行參數是否合法,避免了我們手工的校驗。

但是,自帶的校驗註解有的時候並不能滿足我們的業務驗證需求,因此,我們就有必要進行自定義校驗註解,以業務爲需求定製我們

自己的校驗註解。

下面我們來看一個例子:

1、首先我們使用@interface定義一個註解

@Target( { METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = ByteLengthValidator.class)// 使用@Constraint指定註解校驗實現類,這是一個限制型註解,只能使用指定的實現類
@Documented
public @interface ByteLength {
    int min() default 0;

    int max() default 2147483647;

    String charsetName() default "GBK";
	
    String message() default "的長度只能在{min}和{max}之間";

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

    Class<? extends Payload>[] payload() default {};
}

2、實現註解實現類(和@interface定義的註解在同一個包下)

       註解實現類需要實現ConstraintValidator 接口

public class ByteLengthValidator implements ConstraintValidator<ByteLength, String>{   // 實現ConstraintValidator

	int min;
	int max;
        String charsetName;

	@Override
	public void initialize(ByteLength constraintAnnotation) {
		this.min = constraintAnnotation.min();
		this.max = constraintAnnotation.max();
        this.charsetName = constraintAnnotation.charsetName();
	}

	@Override
	public boolean isValid(String value, ConstraintValidatorContext context) {   // 實現校驗規則
        if (null == value) {
            return min <= 0;
        }

        try {
            int length = value.getBytes(charsetName).length;
            return length >= min && length <= max;
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
            return false;
        }
	}
}

3、在需要校驗的對象的字段上加上@ByteLength註解,然後在接口方法的該對象參數上加上@Vilad 註解,在接收的請求的時候,就會使用

     我們自定義的@ByteLength 進行校驗該字段。


    完工。


  


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章