SpringBoot项目自定义校验枚举注解

SpringBoot项目自定义校验枚举注解

文章目录

1. 使用场景2. 技术实现

2.1 实现思路2.2 代码实现

2.2.1 引入依赖2.2.2 自定义校验注解2.2.3 校验工具类2.2.4 校验处理逻辑 3. 使用示例

1. 使用场景

某接口的入参某属性，只希望为系统中某枚举的中定义过的值。


例如：用户类型枚举中定义 10-普通用户 20-管理员 30-游客 40-中级用户 50-高级用户
希望某接口的入参 userType 只能填入这几种type


支持扩展场景：

只允许填入枚举中定义过的某些值不允许填入某些值

2. 技术实现 2.1 实现思路

使用Hibernate Validator校验工具，自定义校验注解及其校验逻辑。


Hibernate Validator官方文档：
https://docs.jboss.org/hibernate/validator/7.0/reference/en-US/html_single/#validator-gettingstarted

2.2 代码实现 2.2.1 引入依赖

 
     org.springframework.boot
     spring-boot-starter-validation
 
 

2.2.2 自定义校验注解

@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RUNTIME)
@Repeatable(VerifyEnum.List.class)
@Constraint(validatedBy = {EnumValidator.class})
public @interface VerifyEnum {

    
    Class> enumClass();


    
    String keyColumn();

    
    String[] allowedValues() default { };

    
    String[] notAllowedValues() default { };

    
    String message() default "";

    Class[] groups() default { };

    Class[] payload() default {};

    @Target({ElementType.PARAMETER, ElementType.FIELD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface List {
        VerifyEnum[] value();
    }
}

2.2.3 校验工具类

public class ValidatorUtils {
    
    private static ValidatorFactory factory;
    
    public static Validator validator;
    
    public static Executablevalidator executablevalidator;

    static {
        initValidator();
        clean();
    }

    
    public static void initValidator() {
        factory = Validation.byProvider(Hibernatevalidator.class)
                .configure()
                .failFast(true)
                .buildValidatorFactory();
        validator = factory.getValidator();
    }

    
    public static void initExecutablevalidator() {
        factory = Validation.buildDefaultValidatorFactory();
        executablevalidator = factory.getValidator().forExecutables();
    }

    
    public static void clean() {
        factory.close();
    }

    
    public static Set> validMethod(T t, Method method, Object[] parameterValues){
        return executablevalidator.validateParameters(t, method, parameterValues);
    }

    
    public static void validateObject(Object object, Class... groups) {
        Set> constraintViolations = validator.validate(object, groups);
        if(CollectionUtil.isNotEmpty(constraintViolations)){
            String errorMsg = StrUtil.format("对象{}校验异常：{}", object.getClass().getSimpleName(), getErrorMsg(constraintViolations));
            throw new ApiException(ResultEnum.PARAMETER_VERIFICATION_FAIL.getCode(), errorMsg);
        }

    }

    
    public static void validateObjectList(List