SpringBoot 使用 JSR303 自定义校验注解-演道网

<

div id=”content”>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[] payload() default {};
 
    //自定义值的类型
    String[] vals() default {};
}

3、创建自定义约束校验器,继承 ConstraintValidator,第一个泛型是自定义注解、第二个是校验值的类型,也即注解标注的字段的类型

public class ListValueConstraintValidator implements ConstraintValidator{
   
    private static Set 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=必须提交指定的值

輯div>

转载自演道,想查看更及时的互联网产品技术热点文章请点击http://go2live.cn

Add a Comment

电子邮件地址不会被公开。 必填项已用*标注