枚举注解校验字段

枚举实现校验逻辑
1:枚举注解类
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;
/**
* 枚举限制校验
*/
@Documented
@Constraint(validatedBy = {EnumPatternValidator.class})
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
public @interface EnumPattern {

    /**
     * 枚举类
     * @return
     */
    Class<? extends Enum> value();

    /**
     * 取值字段<br>
     *     如果枚举实现了com.common.api.EnumPatternAble接口,则忽略此值,取值getPatternValue()
     *     如果值为空,则取值name()
     *     否则,通过反射使用getter获取fieldName的值
     * @return
     */
    String fieldName() default "";

    /**
     * 是否忽略枚举限制校验能力接口<br>
     *     是否忽略枚举实现的com.perfect.perfectmall.common.api.EnumPatternAble接口,强制使用fieldName控制获取值
     * @return
     */
    boolean ignorePatternAble() default false;

    /**
     * 描述
     * @return
     */
    String message() default "不在取值范围内";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

2:属性类添加枚举注解

@EnumPattern(value = ChannelEnum.class,fieldName = "code",message = "不支持的支付通道")
private String channelCode;

a:fieldName:按枚举类型字段名称判断区分

b:message:字段提示错误消息

3:枚举相关类

@Getter
@AllArgsConstructor
public enum ChannelEnum {
    /**
     * 支付渠道
     */
    ICBC("ICBC", "工商银行", (short) 1),
    PSBC("PSBC", "邮政储蓄银行", (short) 2),
    CCB("CCB", "建设银行", (short) 3),
    UNIONPAY("UNIONPAY", "银联", (short) 4),
    WEIXIN("WEIXIN", "微信", (short) 5),
    ALIPAY("ALIPAY", "支付宝", (short) 6),
    PAB("PAB", "平安银行", (short) 7),
    BCM("BCM", "交通银行", (short) 8);
    /**
     * 操作代码
     */
    private final String code;
    /**
     * 描述
     */
    private final String msg;
    /**
     * 前端代码
     */
    private final Short frontCode;
    public static ChannelEnum get(String code) {
        for (ChannelEnum fromEnum : values()) {
            if (fromEnum.getCode().equals(code)) {
                return fromEnum;
            }
        }
        throw new CustomException(String.format("支付渠道[%s]未定义", code));
    }

    /**
     * 通过前端代码获取操作代码
     * @param frontCode
     * @return
     */
    public static String getCodeByFront(Short frontCode) {
        for (ChannelEnum anEnum : ChannelEnum.values()) {
            if (anEnum.frontCode.equals(frontCode)) {
                return anEnum.code;
            }
        }
        return null;
    }
}

 

### Java校验枚举值的注解方法 在 Java 的 Bean Validation 框架中,默认提供的注解(如 `@NotNull` 或 `@Pattern`)通常不适用于直接验证枚举类型。这是因为框架本身并未提供专门针对枚举类型的内置约束机制[^3]。 #### 自定义注解实现枚举校验 为了满足这一需求,可以通过创建自定义注解并结合相应的验证器类来完成对枚举类型的校验。以下是具体实现方式: 1. **定义自定义注解** 创建一个新的注解,例如 `@EnumValue`,并通过元注解指定其作用范围以及关联的验证逻辑。 ```java import javax.validation.Constraint; import javax.validation.Payload; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target({ElementType.FIELD, ElementType.PARAMETER}) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = EnumValidator.class) // 关联验证器 public @interface EnumValue { String message() default "Invalid enum value"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; // 定义允许的枚举类 Class<? extends Enum<?>> enumClass(); } ``` 2. **编写验证器类** 实现具体的验证逻辑,确保传入的值属于目标枚举类型中的合法成员。 ```java import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; public class EnumValidator implements ConstraintValidator<EnumValue, Object> { private Enum<?>[] values; @Override public void initialize(EnumValue constraintAnnotation) { this.values = constraintAnnotation.enumClass().getEnumConstants(); // 获取所有枚举常量 if (this.values == null || this.values.length == 0) { throw new IllegalArgumentException("The given enum is empty!"); } } @Override public boolean isValid(Object value, ConstraintValidatorContext context) { if (value == null) { // 如果字段可以为空,则返回 true return true; } for (Enum<?> e : values) { if (e.name().equals(value.toString())) { // 验证输入值是否匹配任意枚举名称 return true; } } return false; // 输入值非法 } } ``` 3. **应用自定义注解** 将新定义的注解应用于需要校验字段上。 ```java public enum CustomerType { INDIVIDUAL, BUSINESS } public class Customer { @EnumValue(enumClass = CustomerType.class, message = "Unsupported customer type") private String customerType; // Getter and Setter methods... } ``` 4. **测试验证功能** 使用 Hibernate Validator 等工具运行验证流程,确认枚举值的有效性。 ```java import org.hibernate.validator.messageinterpolation.ResourceBundleMessageInterpolator; import javax.validation.Validation; import javax.validation.ValidatorFactory; import javax.validation.Validator; import javax.validation.ConstraintViolation; public class MainApp { public static void main(String[] args) { ValidatorFactory factory = Validation.byDefaultProvider() .configure() .messageInterpolator(new ResourceBundleMessageInterpolator()) .buildValidatorFactory(); Validator validator = factory.getValidator(); Customer customer = new Customer(); customer.setCustomerType("INVALID_TYPE"); Set<ConstraintViolation<Customer>> violations = validator.validate(customer); for (ConstraintViolation<Customer> violation : violations) { System.out.println(violation.getMessage()); // 输出: Unsupported customer type } } } ``` 以上代码展示了如何通过自定义注解验证器实现对枚举类型的校验。这种方法不仅灵活而且易于扩展,能够适应多种业务场景的需求[^4]。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值