快捷導(dǎo)航

SpringBoot枚舉類型參數(shù)認(rèn)證的實現(xiàn)代碼

更新時間：2023年12月29日 09:31:06 作者：代碼君.

項目當(dāng)中經(jīng)常需要接口參數(shù)是否在一個可選的范圍內(nèi),也就是驗證類枚舉參數(shù)的需求,所以本文我們將使用SpringBoot實現(xiàn)枚舉類型參數(shù)認(rèn)證,文中有詳細(xì)的代碼示例,需要的朋友可以參考下

背景

項目當(dāng)中經(jīng)常需要接口參數(shù)是否在一個可選的范圍內(nèi)，也就是驗證類枚舉參數(shù)的需求。
如果參數(shù)類型是String類型，那么可以使用@Pattern注解，就是用正則進(jìn)行匹配，比如：

@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ù)認(rèn)證的實現(xiàn)代碼的文章就介紹到這了,更多相關(guān)SpringBoot枚舉類型參數(shù)認(rèn)證內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

相關(guān)文章

java構(gòu)造器的重載實現(xiàn)實例講解
在本篇文章里小編給大家整理的是一篇關(guān)于java構(gòu)造器的重載實現(xiàn)實例講解內(nèi)容，有興趣的朋友們可以學(xué)習(xí)下。
2021-01-01
Nacos配置中心命名空間與組的用法解讀
文章介紹了如何將配置文件拆分并放在Nacos配置中心中,包括創(chuàng)建命名空間和組、配置數(shù)據(jù)源、MyBatis和Spring的配置,以及如何通過bootstrap.properties文件從Nacos中引入多個配置文件,測試發(fā)現(xiàn)項目能正常運(yùn)行,并且切換環(huán)境只需修改組名
2026-03-03
C++享元模式詳解
這篇文章主要為大家詳細(xì)介紹了C++設(shè)計模式之享元模式Flyweight，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2021-09-09
Spring?boot如何在IDEA中讓一個應(yīng)用在不同的端口多次啟動詳解
在開發(fā)過程中,SpringBoot項目的多端口啟動是一個實用的需求,特別是在進(jìn)行并發(fā)測試或者隔離環(huán)境時,這篇文章主要介紹了Spring?boot如何在IDEA中讓一個應(yīng)用在不同的端口多次啟動的相關(guān)資料,需要的朋友可以參考下
2026-01-01
Java使用延時隊列搞定超時訂單處理的場景
這篇文章主要介紹了Java使用延時隊列搞定超時訂單處理,本文通過示例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2022-08-08
Java中實現(xiàn)用戶之間的通訊方式
在Java中實現(xiàn)用戶間通訊主要有兩種方法：Socket編程和WebSocket,Socket編程允許兩個設(shè)備間進(jìn)行數(shù)據(jù)交換,適用于基本的網(wǎng)絡(luò)通訊,本文提供了兩種方法的基本實現(xiàn)代碼和相關(guān)配置,幫助開發(fā)者根據(jù)需求選擇合適的通訊方式
2024-09-09
Java 在PPT中創(chuàng)建散點(diǎn)圖的實現(xiàn)示例
本文將以Java代碼示例展示如何在PPT幻燈片中創(chuàng)建散點(diǎn)圖表。文中通過示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2021-11-11
你會用Java代碼模擬高并發(fā)嗎
這篇文章主要介紹了你會用Java代碼模擬高并發(fā)嗎，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
2019-07-07
java?安全?ysoserial?CommonsCollections6?分析
這篇文章主要介紹了java?安全?ysoserial?CommonsCollections6示例分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪
2022-10-10
基于java+springboot+mybatis+laiyu實現(xiàn)學(xué)科競賽管理系統(tǒng)
這篇文章主要介紹了基于java+springboot+mybatis+laiyu實現(xiàn)的學(xué)科競賽管理系統(tǒng)，本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下
2021-09-09