使用自定义注解进行restful请求参数的校验

时间：2021-11-27 11:57:40

在使用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 进行校验该字段。


    完工。


  


标签：

相关文章