SpringBoot 利用 JSR303 自界说校验注解

JSR303 是 Java EE 6 中的一项子类型,叫做 Bean Validation,官方参考实现是hibernate Validator,有了它,我们可以在实体类的字段上标注差异的注解实现对数据的校验,不消 if-else 判定,简化了我们的开拓,并且可读性也很好。

但有时候它提供的注解并不能满意我们的要求,好比,我们要求字段 color 必需是「red,blue,yellow」这三个值之一,这时候,我们就需要本身写判定的逻辑了,你可以自界说一个要领在其他处所举办判定,但既然用了 JSR303,为了统一代码,可以自界说校验注解。

1、给字段 color 上标注自界说注解 @ListValue,写上这几个值

@ListValue(vals = {"red", "blue", "yellow"})
private String color;

2、建设注解 @ListValue,可以参考官方的注解,好比 @NotNull,我们只需要修改下面注释的几处即可

//自界说的约束校验器
@Constraint(validatedBy = {ListValueConstraintValidator.class})
@Documented
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
public @interface ListValue {

//设置文件中错误提示信息的名称
  String message() default "{com.sjl.common.valid.ListValue.message}";

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

Class<? extends Payload>[] payload() default {};
 
    //自界说值的范例
    String[] vals() default {};
}

3、建设自界说约束校验器,担任 ConstraintValidator,第一个泛型是自界说注解、第二个是校验值的范例,也即注解标注的字段的范例

public class ListValueConstraintValidator implements ConstraintValidator<ListValue,String>{
   
    private static Set<String> set = new HashSet<>();

@Override
    public void initialize(ListValue constraintAnnotation) {
        for (String val : constraintAnnotation.vals()) {
            set.add(val);
        }
    }

/**
    * 判定是否通过校验
    *
    * @param value  传入的值
    * @param context
    * @return
    */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}

4、在 resources 目次下建设一个 ValidationMessages.properties 设置文件,key 是第二步 message 配置的默认值,value 是自界说错误信息

com.sjl.common.valid.ListValue.message=必需提交指定的值

至此,所有的事情都已完成,自界说注解 @ListValue 就可以事情了,虽然这只是很简朴的校验,但要领大同小异。

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wsdjxg.html