Java如何實現自定義枚舉值校驗器

本篇內容主要講解“Java如何實現自定義枚舉值校驗器”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“Java如何實現自定義枚舉值校驗器”吧!

前言

定義一個枚舉類，現需要對傳入的枚舉值進行范圍校驗。

@Getter
public enum UserTypeEnum {
    STUDENT(“1”, "學生"),
    TEACHER(“2”, "老師");
 
    private Integer code;
    private String name;
 
    UserTypeEnum(Integer code, String name) {
        this.code = code;
        this.name = name;
    }
}

當超出范圍時，報錯。

注解校驗

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
@Constraint(validatedBy = EnumValidatorHandler.class)
public @interface EnumValidator {
    Class<?> value();
 
    String message() default "入參值不在正確枚舉中";
    String method() default "getCode";
    Class<?>[] groups() default {};
 
    Class<? extends Payload>[] payload() default {};
}

@Slf4j
class EnumValidatorHandler implements ConstraintValidator<EnumValidator, Object> {
    private List<Object> values = new ArrayList<>();

    @Override
    public void initialize(EnumValidator enumValidator) {
        Class<?> clazz = enumValidator.value();
        Object[] objects = clazz.getEnumConstants();
        try {
            Method method = clazz.getMethod(enumValidator.method());
            Object value;
            for (Object obj : objects) {
                value = method.invoke(obj);
                values.add(value);
            }
        } catch (Exception e) {
            log.error("處理枚舉校驗異常:{}", e);
        }
    }

    @Override
    public boolean isValid(Object value, ConstraintValidatorContext constraintValidatorContext) {
        if (value instanceof String) {
            String valueStr = (String)value;
            return StringUtils.isEmpty(valueStr)|| values.contains(value);
        }
        return Objects.isNull(value) || values.contains(value);
    }
}

使用

在實體類的屬性上加入注解

@Entity
public class User {
    @EnumValidator(value = UserTypeEnum.class)
    private String userType;
}

在c層入參的參數上加入@Valid注解

public User add(@Valid User user) {
}

如果是其他層的入參校驗，需要所在類上加入@Validated注解。

他拋出的異常為ConstraintViolationException，

最后，加入一個全局異常處理器處理異常。

除了自定義的注解，還有常規的注解校驗器

到此，相信大家對“Java如何實現自定義枚舉值校驗器”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！