前言
之前写了一个博客是关于使用SpringBoot使用validation-api实现参数校验，当时使用的注解都是validation-api自带的注解只能完成对空值、长度等简单的校验，在我们日常的使用当中会遇到对参数是否在枚举值类的校验，针对这种情况我们怎么来实现呢？
SpringBoot使用validation-api实现参数校验可参考我的博客：SpringBoot使用validation-api实现参数校验
正文
SpringBoot使用validation-api实现对枚举类参数校验
ValidationApi框架就是用来解决参数校验中代码冗余问题，ValidationApi框架提供一些注解用来帮助我们对请求参数进行校验。
Maven依赖
<!--参数校验--> <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>2.0.1.Final</version> </dependency> <!--提供一些字符串操作--> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.3.2</version> </dependency> <!--lombok--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.2</version> <optional>true</optional> </dependency> <!--knife4j接口--> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.0.4</version> </dependency>
EnumValidate：用于对枚举校验的接口
/**
* 用于实现枚举类的校验
*/
public interface EnumValidate<T> {
/**
* 校验枚举值是否存在
*/
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<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
Class<?>[] target() default {};
/**
* 允许的枚举
*
* @return
*/
Class<? extends Enum<?>> enumClass();
}
ActionTypeEnumValidator：枚举校验器
/**
* 用于校验ActionTypeEnumValidator
*/
public class ActionTypeEnumValidator implements ConstraintValidator<ActionTypeEnumValid,String> {
private Class<? extends Enum> enumClass;
@Override
public void initialize(ActionTypeEnumValid actionTypeEnumValid) {
enumClass = actionTypeEnumValid.enumClass();
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
if (value == null || "".equals(value)) {
r<em>本文来源[email protected]搞@^&代*@码)网5</em>eturn true;
}
EnumValidate[] enums = (EnumValidate[]) enumClass.getEnumConstants();
if(enums ==null || enums.length == 0){
return false;
}
return enums[0].existValidate(value);
}
}
ActionTypeEnum：枚举类
@Getter
public enum ActionTypeEnum implements EnumValidate<String> {
ACTION_INVOKR("invoke", "invoke"),
UNKNOWN_ERROR("no", "no");
/**
* 状态值
*/
private String couponType;
/**
* 状态描述
*/
private String couponTypeDesc;
ActionTypeEnum(String couponType, String couponTypeDesc) {
this.couponType = couponType;
this.couponTypeDesc = couponTypeDesc;
}
public static String getDescByType(String couponType) {
for (ActionTypeEnum type : ActionTypeEnum.values()) {
if (type.couponType.equals(couponType) ) {
return type.couponTypeDesc;
}
}
return null;
}
/**
* 判断是否在枚举类当中
* @param value
* @return
*/
@Override
public boolean existValidate(String value) {
if (value == null || "".equals(value)) {
return false;
}
for (ActionTypeEnum testEnum : ActionTypeEnum.values()) {
if (testEnum.getCouponType().equalsIgnoreCase(value)) {
return true;
}
}
return false;
}
public String getcouponTypeStr() {
return String.valueOf(this.couponType);
}
}
搞代码网（gaodaima.com）提供的所有资源部分来自互联网，如果有侵犯您的版权或其他权益，请说明详细缘由并提供版权或权益证明然后发送到邮箱[email protected]，我们会在看到邮件的第一时间内为您处理，或直接联系QQ：872152909。本网站采用BY-NC-SA协议进行授权
转载请注明原文链接：SpringBoot使用validation-api实现对枚举类参数校验的方法
转载请注明原文链接：SpringBoot使用validation-api实现对枚举类参数校验的方法
