SpringBoot自定义validation注解校验参数只能为指定的值

╰+攻爆jí腚メ 2021-09-22 00:58 699阅读 0赞

### 目录 ###

*  自定义校验注解
 *  使用

需求：实体类中某个属性的值必须为指定的值，比如 0 或者 1

![在这里插入图片描述][20210715095555454.png]  
SpringBoot 版本：2.4.8

`validation` 依赖

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>

# 自定义校验注解 #

1、创建自定义校验注解 `EnumValue`

package com.pro.utils;
    
    import javax.validation.Constraint;
    import javax.validation.Payload;
    import java.lang.annotation.Documented;
    import java.lang.annotation.Retention;
    import java.lang.annotation.Target;
    
    import static java.lang.annotation.ElementType.*;
    import static java.lang.annotation.RetentionPolicy.RUNTIME;
    
    /** * 枚举校验注解 */
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
    @Retention(RUNTIME)
    @Documented
    @Constraint(validatedBy = { EnumValueValidator.class})
    public @interface EnumValue { 
    
        // 默认错误消息
        String message() default "必须为指定值";
    
        String[] strValues() default { };
    
        int[] intValues() default { };
    
        // 分组
        Class<?>[] groups() default { };
    
        // 负载
        Class<? extends Payload>[] payload() default { };
    
        // 指定多个时使用
        @Target({ FIELD, METHOD, PARAMETER, ANNOTATION_TYPE})
        @Retention(RUNTIME)
        @Documented
        @interface List { 
            EnumValue[] value();
        }
    }

2、创建 `EnumValue` 校验注解处理类 `EnumValueValidator`

package com.pro.utils;
    
    import javax.validation.ConstraintValidator;
    import javax.validation.ConstraintValidatorContext;
    
    /** * 枚举校验注解处理类 */
    public class EnumValueValidator implements ConstraintValidator<EnumValue, Object> { 
    
        private String[] strValues;
        private int[] intValues;
    
        @Override
        public void initialize(EnumValue constraintAnnotation) { 
            strValues = constraintAnnotation.strValues();
            intValues = constraintAnnotation.intValues();
        }
    
        @Override
        public boolean isValid(Object value, ConstraintValidatorContext context) { 
            if (value instanceof String) { 
                for (String s : strValues) { 
                    if (s.equals(value)) { 
                        return true;
                    }
                }
            } else if (value instanceof Integer) { 
                for (int s : intValues) { 
                    if (s == ((Integer) value).intValue()) { 
                        return true;
                    }
                }
            }
            return false;
        }
    }

# 使用 #

可以指定整数类型和字符串类型的参数，就可以像 `validation` 的注解一样使用了

package com.pro.dto.user;
    
    import com.pro.utils.EnumValue;
    import io.swagger.annotations.ApiModel;
    import io.swagger.annotations.ApiModelProperty;
    
    import javax.validation.constraints.Email;
    import javax.validation.constraints.NotNull;
    
    /** * 更新用户参数 */
    @ApiModel("更新用户参数")
    public class UpdateUserDto { 
    
        @ApiModelProperty(value = "用户id", name = "uid", required = true)
        @NotNull
        private Integer uid;
    
        @ApiModelProperty(value = "账户状态", name = "active", required = true)
        @EnumValue(intValues = { 0, 1}, message = "账户状态只能是0或者1")
        private Integer active;
    
    	// 文章类型 blog 博客，photo 作品
        @ApiModelProperty(value = "文章类型", name = "type", required = true)
        @EnumValue(strValues = { "blog", "photo"}, message = "文章类型只能是blog或者photo")
        private String type;
        
    }

[20210715095555454.png]: /images/20210920/7984a164d71046b797b879a0b1aef404.png