使用自定義注解進(jìn)行restful請(qǐng)求參數(shù)的校驗(yàn)方式

更新時(shí)間：2021年10月19日 11:59:52 作者：teng_sd_cn

這篇文章主要介紹了使用自定義注解進(jìn)行restful請(qǐng)求參數(shù)的校驗(yàn)方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

自定義注解進(jìn)行restful請(qǐng)求參數(shù)的校驗(yàn)

在使用springmvc開(kāi)發(fā)的時(shí)候，我們通常會(huì)在controller中的方法參數(shù)實(shí)體類中加上@NotNull()等類似注解，然后在方法參數(shù)上加上

@Vilad 注解，這樣在有請(qǐng)求的時(shí)候，就會(huì)自動(dòng)按照我們的注解進(jìn)行參數(shù)是否合法，避免了我們手工的校驗(yàn)。

但是，自帶的校驗(yàn)注解有的時(shí)候并不能滿足我們的業(yè)務(wù)驗(yàn)證需求，因此，我們就有必要進(jìn)行自定義校驗(yàn)注解，以業(yè)務(wù)為需求定制我們

自己的校驗(yàn)注解。

下面我們來(lái)看一個(gè)例子：

1、首先我們使用@interface定義一個(gè)注解

@Target( { METHOD, FIELD, ANNOTATION_TYPE })
@Retention(RUNTIME)
@Constraint(validatedBy = ByteLengthValidator.class)// 使用@Constraint指定注解校驗(yàn)實(shí)現(xiàn)類，這是一個(gè)限制型注解，只能使用指定的實(shí)現(xiàn)類
@Documented
public @interface ByteLength {
    int min() default 0; 
    int max() default 2147483647; 
    String charsetName() default "GBK"; 
    String message() default "的長(zhǎng)度只能在{min}和{max}之間"; 
    Class<?>[] groups() default {}; 
    Class<? extends Payload>[] payload() default {};
}

2、實(shí)現(xiàn)注解實(shí)現(xiàn)類(和@interface定義的注解在同一個(gè)包下)

注解實(shí)現(xiàn)類需要實(shí)現(xiàn)ConstraintValidator 接口

public class ByteLengthValidator implements ConstraintValidator<ByteLength, String>{   // 實(shí)現(xiàn)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) {   // 實(shí)現(xiàn)校驗(yàn)規(guī)則
        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;
        }
 }
}