SpringBoot 使用 JSR303 自定义校验注解

2020-04-08 16:11:44来源:博客园 阅读 ()

新老客户大回馈,云服务器低至5折

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.cnblogs.com/songjilong/p/12663564.html
如有疑问请与原作者联系

标签:

版权申明:本站文章部分自网络,如有侵权,请联系:west999com@outlook.com
特别注意:本站所有转载文章言论不代表本站观点,本站所提供的摄影照片,插画,设计作品,如需使用,请与原作者联系,版权归原作者所有

上一篇:【从零开始学Spring笔记】Spring的JDBC模板的使用

下一篇:【从零开始学Spring笔记】Spring的事务管理