飞虎兄

飞虎兄

Developer

© 2019

  • Java 自定义参数验证器

    在服务器端开发过程中,经常需要对一些参数进行验证。比如参数不能为 null ,email 那么必须符合 email 的格式,如果手动进行 if 判断则会导致开发效率太慢,于是就有了 bean validation 框架。

    bean validation 框架验证介绍

    validation bean 是基于 JSR-303 标准开发出来的,使用注解方式实现,及其方便,但其实一个接口,没有具体实现。如果使用 SpringBoot 开发的话无需添加该接口的实现,否则需要添加依赖,如: Hibernate Validator。

    下面为一些已提供的常用注解:

    限制 详细信息
    @Null 被注释的元素必须为null
    @NotNull 被注释的元素必须不为null
    @AssertTrue 被注释的元素必须为true
    @AssertFalse 被注释的元素必须为false
    @Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
    @Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
    @DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
    @DecimalMax (value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
    @Size(max,min) 被注释的元素的大小必须在指定的范围内
    @Digits (integer, fraction) 被注释的元素必须是一个数字,其值必须在可接受的范围内
    @Past 被注释的元素必须是一个过去的日期
    @Future 被注释的元素必须是一个将来的日期
    @Pattern(value) 被注释的元素必须符合指定的正则表达式

    自定义注解

    如果以上注解不能满足我们的需求,就需要我们自己来定义注解和验证规则了。 下面举个例子,实现一个用来验证参数必须为限定值的注解。

    • 定义注解 LimitValue
    @Target({ ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE })
    @Retention(RetentionPolicy.RUNTIME)
    @Constraint(validatedBy = LimitValueValidator.class)
    @Documented
    public @interface EnumConstraint {
    
        String message() default "非法的参数值";
    
        String[] limit() default {};
    
        Class<?>[] groups() default {};
    
        Class<? extends Payload>[] payload() default {};
    }
    
    
    • 定义验证器 LimitValueValidator
    public class LimitValueValidator implements ConstraintValidator<LimitValue, Object> {
    
        private LimitValue limitValue;
    
        @Override
        public void initialize(LimitValue constraintAnnotation) {
            limitValue = constraintAnnotation;
        }
    
        @Override
        public boolean isValid(Object value, ConstraintValidatorContext context) {
    
            if (value == null) {
                return false;
            }
    
            String[] limit = enumConstraint.limit();
    
            for (String v : limit) {
                if (v.equals(value.toString())) {
                    return true;
                }
            }
    
            return false;
        }
    }
    
    
    • 应用注解
    public class User {
    
      @LimitValue(limit={"1", "2"})
      private String type;
    
    }
    
    • 测试

    结合 Spring 框架验证参数

    public String add(@RequestBody @Valid User user, BindingResult result) {
    
        if (result.hasErrors()) {
            return result.getFieldError().getDefaultMessage();
        }
        userService.add(user);
    
        return "success";
    }