JAVA入参注解方式校验枚举类

最新推荐文章于 2024-05-17 18:18:32 发布

WhiteEmperor

最新推荐文章于 2024-05-17 18:18:32 发布

阅读量2.5k

点赞数

文章标签： java 后端

本文链接：https://blog.csdn.net/WhiteEmperor/article/details/126712466

版权

废话不多说，直接上代码

Controller层



public Result<Void> save(@Valid @RequestBody GameResult gameResult){
    gameService.saveGameResult(gameResult);
    return Result.success();
}

入参


public class GameResult{

    @ApiModuleProperties("用户ID")
    private String userId;

    @Enum(value = GameResultEnum.class, message = "游戏结果类型错误！1-胜利；0-失败；-1-逃跑")
    @ApiModuleProperties("游戏结果")
    private Integer result;

}

自定义Enum注解

@Target(FIELD)
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = EnumValidator.class)
public @interface Enum {

    String DEFAULT_MESSAGE = "不在指定枚举值范围内\n";

    String message() default DEFAULT_MESSAGE;

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

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

    Class<?> value();

    String enumMethod() default "getKey";
}

校验类

@Slf4j
public class EnumValidator implements ConstraintValidator<Enum, Integer>{

    private Set<Integer> set = new HashSet<>();

    @Override
    public void initialize(Enum constraintAnnotation){

        if(null == constraintAnnotation){
        
            return;
        
        }

        Class<?> clazz = constraintAnnotation.value();
        
        String methodName = constraintAnnotation.enumMethod();

        if(clazz.isEnum()){
            
            Method getCode;
            
            Object[] objs = clazz.getEnumConstants();

            try{
                
                getCode = clazz.getMehtod(methodName);
        
                if(null == getCode){
                    
                    throw new RuntimeException("enum method can not be null, methodName:" + methodName);
              
                  }

                for(Object obj : objs){
                    
                    Integer code = (Integer)getCode.invoke(obj);

                    set.add(code);

                }

            }catch(Exception e){

                log.error("EnumValitor error", e);
                
                throw new RuntimeException(e);

            }
        }
        
    }

}

枚举类

public enum GameResultEnum{


    WIN(1),

    LOSE(0),

    RUN_AWAY(-1);

    
    private Integer key;


    GameResultEnum(Integer key){
        
        this.key = key;

    }

    public Integer getKey(){

        return key;

    }

}

目前这套代码只支持整数类型枚举值，如果是其他类型的枚举值需要调整一下，只是给各位大佬提供一个思路。

以上。