SpringBoot枚舉類型參數(shù)認證的實現(xiàn)代碼
背景
項目當中經(jīng)常需要接口參數(shù)是否在一個可選的范圍內(nèi),也就是驗證類枚舉參數(shù)的需求。
如果參數(shù)類型是String類型,那么可以使用@Pattern注解,就是用正則進行匹配,比如:
@Pattern(regex = "^(male|female)$", message = "性別不合法") private String gender;
但是如果參數(shù)類型不是String類型,就不能使用@Pattern了。SpringBoot的validation中并沒有提供針對這種枚舉值的校驗注解。
接下來我們來自己實現(xiàn)一個。
定義枚舉類
為了后續(xù)可以方便獲取枚舉值,我們的枚舉類需要實現(xiàn)一個interface,就叫ValueEnum:
public interface ValueEnum {
Interger getValue();
}
定義枚舉:
@Getter
@RequiredArgsConstructor
public enum Gender implements ValueEnum {
MALE(1, "男"),
FEMALE(2, "女");
private final Integer value;
private final String name;
}
定義校驗注解
@Target( FIELD )
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = EnumValueValidator.class)
public @interface EnumValue {
String message() default "參數(shù)值不合法";
Class<? extends ValueEnum> enumClass();
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
這里指定了校驗器EnumValueValidator,接下來定義這個。
定義EnumValueValidator
public class EnumValueValidator implements ConstraintValidator<EnumValue, Integer> {
private EnumValue enumValue;
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
Class<? extends ValueEnum> enumClass = enumValue.enumClass();
return Arrays.stream(enumClass.getEnumConstants()).anyMatch(i -> Objects.equals(i.getValue(), value));
}
@Override
public void initialize(EnumValue enumValue) {
this.enumValue = enumValue;
}
}
在代碼中使用
@EnumValue(enumClass = Gender.class) private Integer gender;
到此這篇關于SpringBoot枚舉類型參數(shù)認證的實現(xiàn)代碼的文章就介紹到這了,更多相關SpringBoot枚舉類型參數(shù)認證內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Java之不通過構造函數(shù)創(chuàng)建一個對象問題
這篇文章主要介紹了Java之不通過構造函數(shù)創(chuàng)建一個對象問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-03-03
idea查看properties中文變成unicode碼的解決方案
這篇文章主要介紹了idea查看properties中文變成unicode碼的解決方案,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06

