java枚举值校验_SpringBoot使⽤validation-api实现对枚举类参
数校验的⽅法
前⾔
之前写了⼀个博客是关于使⽤SpringBoot使⽤validation-api实现参数校验，当时使⽤的注解都是validation-api⾃带的注解只能完成对空值、长度等简单的校验，在我们⽇常的使⽤当中会遇到对参数是否在枚举值类的校验，针对这种情况我们怎么来实现呢？
SpringBoot使⽤validation-api实现参数校验可参考我的博客：SpringBoot使⽤validation-api实现参数校验
正⽂
SpringBoot使⽤validation-api实现对枚举类参数校验
ValidationApi框架就是⽤来解决参数校验中代码冗余问题，ValidationApi框架提供⼀些注解⽤来帮助我们对请求参数进⾏校验。
Maven依赖
javax.validation
validation-api
2.0.1.Final
org.apachemons
commons-lang3
3.3.2
org.projectlombok
lombok
1.18.2
true
com.github.xiaoymin
knife4j-spring-boot-starter
2.0.4
EnumValidate：⽤于对枚举校验的接⼝
/**
* ⽤于实现枚举类的校验
*/
public interface EnumValidate {
/**
* 校验枚举值是否存在
*/
boolean existValidate(T value);
}
ActionTypeEnumValid：⽤于对枚举类校验的⾃定义注解
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {ActionTypeEnumValidator.class})
@Documented
public @interface ActionTypeEnumValid {
String message() default "";
Class
ActionTypeEnumValidator：枚举校验器
/**
* ⽤于校验ActionTypeEnumValidator
*/
public class ActionTypeEnumValidator implements ConstraintValidator {
private Class extends Enum> enumClass;
@Override
public void initialize(ActionTypeEnumValid actionTypeEnumValid) {
enumClass = umClass();
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if (value == null || "".equals(value)) {
return true;
}
EnumValidate[] enums = (EnumValidate[]) EnumConstants();
if(enums ==null || enums.length == 0){
return false;
}
return enums[0].existValidate(value);
}
}
ActionTypeEnum：枚举类
@Getter
publ编程客栈ic enum ActionTypeEnum implements EnumValidate {
ACTION_INVOKR("invoke", "invoke"),
UNKNOWN_ERROR("no", "no");
* 状态值
*/
private String couponType;
/**
* 状态描述
*/
private String couponTypeDesc;
ActionTypeEnum(String couponType, String couponTypeDesc) { uponType = couponType;
}
public static String getDescByType(String couponType) {
for (ActionTypeEnum type : ActionTypeEnum.values()) {
if (uponType.equals(couponType) ) {
uponTypeDesc;
}
}
return null;
}
/**
* 判断是否在枚举类当中
* @param value
* @return
*/
@Override
public boolean existValidate(String value) {
if (value == null || "".equals(value)) {
return false;
}
for (ActionTypeEnum testEnum : ActionTypeEnum.values()) {
if (CouponType().equalsIgnoreCase(value)) {
return true;
}
return false;
}
public String getcouponTypeStr() {
return String.uponType);
}
}
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
/**
* 忽略参数异常处理器
*
validation框架* @param e 忽略参数异常
* @return Response
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(MissingServletRequestParameterException.class)
public ResponseResult parameterMissingExceptionHandler(MissingServletRequestParameterException e) { ("参数异常", e);
return new ResponseResult(CouponTypeEnum.uponTypeStr(), "请求参数 " +
}
/**
* 缺少请求体异常处理器
*
* @param e 缺少请求体异常
* @return Response
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(HttpMessageNotReadableException.class)
public ResponseResult parameterBodyMissingExceptionHandler(HttpMessageNotReadableExceptio
n e) { ("缺少请求体异常", e);
return new ResponseResult(CouponTypeEnum.uponTypeStr(), "参数体不能为空");
/**
* 参数效验异常处理器
*
* @param e 参数验证异常
* @return ResponseInfo
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseResult parameterExceptionHandler(MethodArgumentNotValidExce编程客栈ption e) {
<("参数验证异常", e);
// 获取异常信息
BindingResult exceptions = e.getBindingResult();
// 判断异常中是否有错误信息，如果存在就使⽤异常中的消息，否则使⽤默认消息
if (exceptions.hasErrors()) {
List errors = AllErrors();
if (!errors.isEmpty()) {
// 这⾥列出了全部错误参数，按正常逻辑，只需要第⼀条错误即可
FieldError fieldError = (FieldError) (0);
return new ResponseResult(CouponTypeEnum.uponTypeStr(), DefaultMessage()); }
}
return new ResponseResult(CouponTypeEnum.PARAMETER_ERROR);
}
/**
* ⾃定义参数错误异常处理器
*
* @param e ⾃定义参数
* @return ResponseInfo
*/
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler({BusinessException.class})
public ResponseResult paramExceptionHandler(BusinessException e) {
<("业务异常", e);