栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

SpringBoot使用validation-api实现对枚举类参数的校验

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

SpringBoot使用validation-api实现对枚举类参数的校验

文章目录
  • 引言
  • 一、引入Maven依赖
  • 二、自定义注解@EnumValid 用于对枚举类校验
  • 三、定义接口EnumValidate 用于实现枚举的校验
  • 四、枚举校验器 用于校验EnumValidator
  • 五、自定义枚举类 实现EnumValidate接口中的方法
  • 六、在用于参数接收的VO中使用刚才我们自定义的@EnumValid注解
  • 七、在Controller参数接收的位置添加@Validated注解


引言

ValidationApi框架就是用来解决参数校验中代码冗余问题,它提供一些注解用来帮助我们对请求参数进行校验。但是在实际项目中经常需要自定义枚举类来限制参数类型,此篇文章笔者将带领大家解决这个问题。

一、引入Maven依赖


 javax.validation
 validation-api
 2.0.1.Final

 
 


 org.apache.commons
 commons-lang3
 3.3.2

 
 


 org.projectlombok
 lombok
 1.18.2
 true

 
 


 com.github.xiaoymin
 knife4j-spring-boot-starter
 2.0.4

二、自定义注解@EnumValid 用于对枚举类校验
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {EnumValidator.class})
@Documented
public @interface EnumValid {

 
    String message() default "";
 
 
    Class[] groups() default {};
 
 
    Class[] payload() default {};
 
 
   Class[] target() default {};
 
    
    Class> enumClass();
}
三、定义接口EnumValidate 用于实现枚举的校验
public interface EnumValidate {
 
    
    boolean existValidate(T value);
}
四、枚举校验器 用于校验EnumValidator
public class EnumValidator implements ConstraintValidator {
 
 
    private Class enumClass;
 
 
    @Override
    public void initialize(EnumValid enumValid) {
        enumClass = enumValid.enumClass();
    }
 
 
     @Override
     public boolean isValid(String value, ConstraintValidatorContext context) {
         if (value == null || "".equals(value)) {
             return true;
         }
         EnumValidate[] enums = (EnumValidate[]) enumClass.getEnumConstants();
         if(enums ==null || enums.length == 0){
             return false;
         }
         return enums[0].existValidate(value);
     }
 
}
五、自定义枚举类 实现EnumValidate接口中的方法
@Getter
public enum SexEnun implements EnumValidate {

    SEX_MEN("1", "男"),
    SEX_WOMEN("2", "女");

    private final String sex;
    private final String value;

    SexEnun(String sex, String value){
        this.sex = sex;
        this.value = value;
    }


    
    @Override
    public boolean existValidate(String value) {
        if (value == null || "".equals(value)) {
            return false;
        }
        for (SexEnun testEnum : SexEnun.values()) {
            if (testEnum.getSex().equalsIgnoreCase(value)) {
                return true;
            }
        }
        return false;
    }

}
六、在用于参数接收的VO中使用刚才我们自定义的@EnumValid注解
public class StudentVO {

    private String studentId;

    @NotBlank(message = "学生姓名为必填项")
    private String studentName;

    @EnumValid(message = "学生性别参数有误!", enumClass = SexEnun.class)
    private String studentSex;

}
七、在Controller参数接收的位置添加@Validated注解
@RestController
@RequestMapping("
    @PostMapping("***")
    public VResponse> saveStudent(@Validated @RequestBody StudentVO studentVO) {
        String studentId = studentBpo.saveStudent(studentVO);
        Map map = new HashMap<>();
        map.put("studentId", studentId);
        return new VResponse<>(HttpStatus.OK, ResultEnum.SUCCESS_SAVE.getValue(), map);
    }

}
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/972304.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号