SpringBoot枚舉類型參數(shù)認證的實現(xiàn)代碼
更新時間：2023年12月29日 09:31:06 作者：代碼君.
項目當中經(jīng)常需要接口參數(shù)是否在一個可選的范圍內(nèi),也就是驗證類枚舉參數(shù)的需求,所以本文我們將使用SpringBoot實現(xiàn)枚舉類型參數(shù)認證,文中有詳細的代碼示例,需要的朋友可以參考下
背景
項目當中經(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;
到此這篇關(guān)于SpringBoot枚舉類型參數(shù)認證的實現(xiàn)代碼的文章就介紹到這了,更多相關(guān)SpringBoot枚舉類型參數(shù)認證內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java之不通過構(gòu)造函數(shù)創(chuàng)建一個對象問題
這篇文章主要介紹了Java之不通過構(gòu)造函數(shù)創(chuàng)建一個對象問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-03-03
當線程池中的任務(wù)隊列已滿且無法再接受新的任務(wù)時,就需要采取拒絕策略來處理這種情況,本文主要介紹了Java多線程拒絕策略,包含了四種常見的拒絕策略,具有一定的參考價值,感興趣的可以了解一下2024-03-03
這篇文章主要為大家詳細介紹了如何通過Javax Validation自定義注解進行身份證號校驗,文中的示例代碼講解詳細,有需要的小伙伴可以參考一下2024-10-10
Java通過FTP下載文件主要有兩種方式：第一種是直接在連接中包含賬號和密碼進行遠程下載；第二種是登錄后使用賬號和密碼進行下載,這些方法適用于需要從遠程服務(wù)器獲取文件的場景2024-11-11
這篇文章主要介紹了OGNL表達式基本語法與用法詳解，具有一定參考價值。需要的朋友可以了解下。2017-09-09
最小生成樹（Minimum Spanning Tree）：在連通圖的所有生成樹中，所有邊的權(quán)值和最小的生成樹，稱為最小生成樹。這篇文章主要介紹了求最小生成樹的兩種方法：Prim算法和Kruskal算法，需要的可以參考一下2022-01-01
idea查看properties中文變成unicode碼的解決方案
這篇文章主要介紹了idea查看properties中文變成unicode碼的解決方案,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06
本篇文章主要介紹Java中的異常、如何處理函數(shù)拋出的異常、處理異常的原則、異常處理時，性能開銷大的地方，感興趣的小伙伴可以參考一下2022-09-09
這篇文章主要為大家詳細介紹了Java實現(xiàn)自動生成縮略圖片，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-04-04
之前介紹了線程池相關(guān)的對象,Runable Callable與Future,下面介紹FutureTask的作用,它的特性是怎樣的呢,需要的朋友可以參考下2021-06-06