枚举注解校验字段

枚举实现校验逻辑
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;
    }
}

 

使用注解方式对 String 类型进行枚举校验,可按以下步骤操作: ### 1. 定义自定义注解 自定义注解用于标记需要进行枚举校验字段,可参考如下代码: ```java 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.FIELD; import static java.lang.annotation.ElementType.PARAMETER; import static java.lang.annotation.RetentionPolicy.RUNTIME; @Documented @Retention(RUNTIME) @Target({FIELD, PARAMETER}) @Constraint(validatedBy = EnumValidator.class) public @interface EnumValid { Class<?> value(); String message() default "入参值不在正确枚举中"; String method() default "getName"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; } ``` 该注解 `EnumValid` 可作用于字段参数,通过 `validatedBy` 指定校验器为 `EnumValidator`,`value` 用来指定枚举类,`message` 是校验不通过时的提示信息 [^4]。 ### 2. 实现校验器 实现 `ConstraintValidator` 接口来完成具体的校验逻辑,示例代码如下: ```java import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; import java.lang.reflect.Method; public class EnumValidator implements ConstraintValidator<EnumValid, String> { private EnumValid annotation; @Override public void initialize(EnumValid constraintAnnotation) { this.annotation = constraintAnnotation; } @Override public boolean isValid(String value, ConstraintValidatorContext context) { if (value == null) { return true; // 可根据需求修改空值处理逻辑 } Class<?> cls = annotation.value(); Object[] objects = cls.getEnumConstants(); try { Method method = cls.getMethod(annotation.method()); for (Object obj : objects) { String enumValue = (String) method.invoke(obj); if (enumValue.equals(value)) { return true; } } } catch (Exception e) { e.printStackTrace(); } return false; } } ``` 在 `isValid` 方法中,首先获取注解指定的枚举类,然后通过反射调用指定的方法获取枚举值,与传入的 `String` 值进行比较,若匹配校验通过 [^1][^4]。 ### 3. 使用注解进行校验 在需要校验字段上使用自定义注解,示例如下: ```java public class UserDTO { @EnumValid(value = GenderEnum.class, method = "getName") private String gender; // 其他字段方法 } ``` 这里 `GenderEnum` 是自定义的枚举类,`getName` 是枚举类中获取枚举值的方法 [^1][^4]。 ### 示例枚举类 ```java public enum GenderEnum { MALE("Male"), FEMALE("Female"); private String name; GenderEnum(String name) { this.name = name; } public String getName() { return name; } } ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值