一区二区三区在线-一区二区三区亚洲视频-一区二区三区亚洲-一区二区三区午夜-一区二区三区四区在线视频-一区二区三区四区在线免费观看

服務(wù)器之家:專(zhuān)注于服務(wù)器技術(shù)及軟件下載分享
分類(lèi)導(dǎo)航

PHP教程|ASP.NET教程|Java教程|ASP教程|編程技術(shù)|正則表達(dá)式|C/C++|IOS|C#|Swift|Android|VB|R語(yǔ)言|JavaScript|易語(yǔ)言|vb.net|

服務(wù)器之家 - 編程語(yǔ)言 - Java教程 - SpringBoot在RequestBody中使用枚舉參數(shù)案例詳解

SpringBoot在RequestBody中使用枚舉參數(shù)案例詳解

2021-12-18 13:33沉潛飛動(dòng) Java教程

這篇文章主要介紹了SpringBoot在RequestBody中使用枚舉參數(shù)案例詳解,本篇文章通過(guò)簡(jiǎn)要的案例,講解了該項(xiàng)技術(shù)的了解與使用,以下就是詳細(xì)內(nèi)容,需要的朋友可以參考下

前文說(shuō)到 優(yōu)雅的使用枚舉參數(shù) 和 實(shí)現(xiàn)原理,本文繼續(xù)說(shuō)一下如何在 RequestBody 中優(yōu)雅使用枚舉。

本文先上實(shí)戰(zhàn),說(shuō)一下如何實(shí)現(xiàn)。在 優(yōu)雅的使用枚舉參數(shù) 代碼的基礎(chǔ)上,我們繼續(xù)實(shí)現(xiàn)。

確認(rèn)需求

需求與前文類(lèi)似,只不過(guò)這里需要是在 RequestBody 中使用。與前文不同的是,這種請(qǐng)求是通過(guò) Http Body 的方式傳輸?shù)胶蠖耍ǔJ?json 或 xml 格式,Spring 默認(rèn)借助 Jackson 反序列化為對(duì)象。

同樣的,我們需要在枚舉中定義 int 類(lèi)型的 id、String 類(lèi)型的 code,id 取值不限于序號(hào)(即從 0 開(kāi)始的 orinal 數(shù)據(jù)),code 不限于 name。客戶(hù)端請(qǐng)求過(guò)程中,可以傳 id,可以傳 code,也可以傳 name。服務(wù)端只需要在對(duì)象中定義一個(gè)枚舉參數(shù),不需要額外的轉(zhuǎn)換,即可得到枚舉值。

好了,接下來(lái)我們定義一下枚舉對(duì)象。

定義枚舉和對(duì)象

先定義我們的枚舉類(lèi)GenderIdCodeEnum,包含 id 和 code 兩個(gè)屬性:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
public enum GenderIdCodeEnum implements IdCodeBaseEnum {
    MALE(1, "male"),
    FEMALE(2, "female");
 
    private final Integer id;
    private final String code;
 
    GenderIdCodeEnum(Integer id, String code) {
        this.id = id;
        this.code = code;
    }
 
    @Override
    public String getCode() {
        return code;
    }
 
    @Override
    public Integer getId() {
        return id;
    }
}

這個(gè)枚舉類(lèi)的要求與前文一致,不清楚的可以再去看一下。

在定義一個(gè)包裝類(lèi)GenderIdCodeRequestBody,用于接收 json 數(shù)據(jù)的請(qǐng)求體:

?
1
2
3
4
5
6
@Data
public class GenderIdCodeRequestBody {
    private String name;
    private GenderIdCodeEnum gender;
    private long timestamp;
}

除了GenderIdCodeEnum參數(shù)外,其他都是示例,所以隨便定義一下。

實(shí)現(xiàn)轉(zhuǎn)換邏輯

前奏鋪墊好,接下來(lái)入正題了。Jackson 提供了兩種方案:

  • 方案一:精準(zhǔn)攻擊,指定需要轉(zhuǎn)換的字段,不影響其他類(lèi)對(duì)象中的字段
  • 方案二:全范圍攻擊,所有借助 Jackson 反序列化的枚舉字段,全部具備自動(dòng)轉(zhuǎn)換功能

方案一:精準(zhǔn)攻擊

這種方案中,我們首先需要實(shí)現(xiàn)JsonDeserialize抽象類(lèi):

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public class IdCodeToEnumDeserializer extends JsonDeserializer<BaseEnum> {
    @Override
    public BaseEnum deserialize(JsonParser jsonParser, DeserializationContext deserializationContext)
            throws IOException {
        final String param = jsonParser.getText();// 1
        final JsonStreamContext parsingContext = jsonParser.getParsingContext();// 2
        final String currentName = parsingContext.getCurrentName();// 3
        final Object currentValue = parsingContext.getCurrentValue();// 4
        try {
            final Field declaredField = currentValue.getClass().getDeclaredField(currentName);// 5
            final Class<?> targetType = declaredField.getType();// 6
            final Method createMethod = targetType.getDeclaredMethod("create", Object.class);// 7
            return (BaseEnum) createMethod.invoke(null, param);// 8
        } catch (NoSuchMethodException | InvocationTargetException | IllegalAccessException | NoSuchFieldException e) {
            throw new CodeBaseException(ErrorResponseEnum.PARAMS_ENUM_NOT_MATCH, new Object[] {param}, "", e);
        }
    }
}

然后在指定枚舉字段上定義@JsonDeserialize注解,比如:

?
1
2
@JsonDeserialize(using = IdCodeToEnumDeserializer.class)
private GenderIdCodeEnum gender;

具體說(shuō)一下每行的作用:

  1. 獲取參數(shù)值。根據(jù)需要,此處可能是 id、code 或 name,也就是源值,需要將其轉(zhuǎn)換為枚舉;
  2. 獲取轉(zhuǎn)換上線(xiàn)文,這個(gè)是為 3、4 步做準(zhǔn)備的;
  3. 獲取標(biāo)記@JsonDeserialize注解的字段,此時(shí)currentName的值是gender
  4. 獲取包裝對(duì)象,也就是GenderIdCodeRequestBody對(duì)象;
  5. 根據(jù)包裝對(duì)象的Class對(duì)象,以及字段名gender獲取Field對(duì)象,為第 5 步做準(zhǔn)備;
  6. 獲取gender字段對(duì)應(yīng)的枚舉類(lèi)型,也即是GenderIdCodeEnum。之所以這樣做,是要實(shí)現(xiàn)一個(gè)通用的反序列化類(lèi);
  7. 這里是寫(xiě)死的一種實(shí)現(xiàn),就是在枚舉類(lèi)中,需要定義一個(gè)靜態(tài)方法,方法名是create,請(qǐng)求參數(shù)是Object
  8. 通過(guò)反射調(diào)用create方法,將第一步獲取的請(qǐng)求參數(shù)傳入。

我們來(lái)看一下枚舉類(lèi)中定義的create方法:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public static GenderIdCodeEnum create(Object code) {
    final String stringCode = code.toString();
    final Integer intCode = BaseEnum.adapter(stringCode);
    for (GenderIdCodeEnum item : values()) {
        if (Objects.equals(stringCode, item.name())) {
            return item;
        }
        if (Objects.equals(item.getCode(), stringCode)) {
            return item;
        }
        if (Objects.equals(item.getId(), intCode)) {
            return item;
        }
    }
    return null;
}

為了性能考慮,我們可以提前定義三組 map,分別以 id、code、name 為 key,以枚舉值為 value,這樣就可以通過(guò) O(1) 的時(shí)間復(fù)雜度返回了。可以參考前文的Converter類(lèi)的實(shí)現(xiàn)邏輯。

這樣,我們就可以實(shí)現(xiàn)精準(zhǔn)轉(zhuǎn)換了。

方案二:全范圍攻擊

這種方案是全范圍攻擊了,只要是 Jackson 參與的反序列化,只要其中有目標(biāo)枚舉參數(shù),就會(huì)受到這種進(jìn)入這種方案的邏輯中。這種方案是在枚舉類(lèi)中定義一個(gè)靜態(tài)轉(zhuǎn)換方法,通過(guò)@JsonCreator注解注釋?zhuān)琂ackson 就會(huì)自動(dòng)轉(zhuǎn)換了。

這個(gè)方法的定義與方案一中的create方法完全一致,所以只需要在create方法上加上注解即可:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@JsonCreator(mode = Mode.DELEGATING)
public static GenderIdCodeEnum create(Object code) {
    final String stringCode = code.toString();
    final Integer intCode = BaseEnum.adapter(stringCode);
    for (GenderIdCodeEnum item : values()) {
        if (Objects.equals(stringCode, item.name())) {
            return item;
        }
        if (Objects.equals(item.getCode(), stringCode)) {
            return item;
        }
        if (Objects.equals(item.getId(), intCode)) {
            return item;
        }
    }
    return null;
}

其中Mode類(lèi)有四個(gè)值:DEFAULTDELEGATINGPROPERTIESDISABLED,這四種的差別會(huì)在原理篇中說(shuō)明。還是那句話(huà),對(duì)于應(yīng)用類(lèi)技術(shù),我們可以先知其然,再知其所以然,也一定要知其所以然。

測(cè)試

先定義一個(gè) controller 方法:

?
1
2
3
4
5
@PostMapping("gender-id-code-request-body")
public GenderIdCodeRequestBody bodyGenderIdCode(@RequestBody GenderIdCodeRequestBody genderRequest) {
    genderRequest.setTimestamp(System.currentTimeMillis());
    return genderRequest;
}

然后定義測(cè)試用例,還是借助 JUnit5:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@ParameterizedTest
@ValueSource(strings = {"\"MALE\"", "\"male\"", "\"1\"", "1"})
void postGenderIdCode(String gender) throws Exception {
    final String result = mockMvc.perform(
            MockMvcRequestBuilders.post("/echo/gender-id-code-request-body")
                    .contentType(MediaType.APPLICATION_JSON_UTF8)
                    .accept(MediaType.APPLICATION_JSON_UTF8)
                    .content("{\"gender\": " + gender + ", \"name\": \"看山\"}")
    )
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andDo(MockMvcResultHandlers.print())
            .andReturn()
            .getResponse()
            .getContentAsString();
 
    ObjectMapper objectMapper = new ObjectMapper();
    final GenderIdCodeRequestBody genderRequest = objectMapper.readValue(result, GenderIdCodeRequestBody.class);
    Assertions.assertEquals(GenderIdCodeEnum.MALE, genderRequest.getGender());
    Assertions.assertEquals("看山", genderRequest.getName());
    Assertions.assertTrue(genderRequest.getTimestamp() > 0);
}

文末總結(jié)

本文主要說(shuō)明了如何在 RequestBody 中優(yōu)雅的使用枚舉參數(shù),借助了 Jackson 的反序列化擴(kuò)展,可以定制類(lèi)型轉(zhuǎn)換邏輯。礙于文章篇幅,沒(méi)有羅列大段代碼。關(guān)注公號(hào)「看山的小屋」回復(fù) spring 可以獲取源碼。關(guān)注我,下一篇我們進(jìn)入原理篇。

推薦閱讀

  • SpringBoot 實(shí)戰(zhàn):一招實(shí)現(xiàn)結(jié)果的優(yōu)雅響應(yīng)
  • SpringBoot 實(shí)戰(zhàn):如何優(yōu)雅的處理異常
  • SpringBoot 實(shí)戰(zhàn):通過(guò) BeanPostProcessor 動(dòng)態(tài)注入 ID 生成器
  • SpringBoot 實(shí)戰(zhàn):自定義 Filter 優(yōu)雅獲取請(qǐng)求參數(shù)和響應(yīng)結(jié)果
  • SpringBoot 實(shí)戰(zhàn):優(yōu)雅的使用枚舉參數(shù)
  • SpringBoot 實(shí)戰(zhàn):優(yōu)雅的使用枚舉參數(shù)(原理篇)
  • SpringBoot 實(shí)戰(zhàn):在 RequestBody 中優(yōu)雅的使用枚舉參數(shù)
  • SpringBoot 實(shí)戰(zhàn):在 RequestBody 中優(yōu)雅的使用枚舉參數(shù)(原理篇)

到此這篇關(guān)于SpringBoot在RequestBody中使用枚舉參數(shù)案例詳解的文章就介紹到這了,更多相關(guān)SpringBoot在RequestBody中使用枚舉參數(shù)內(nèi)容請(qǐng)搜索服務(wù)器之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持服務(wù)器之家!

原文鏈接:https://www.howardliu.cn/springboot-action-enum-params-in-requestbody/

延伸 · 閱讀

精彩推薦
  • Java教程Java BufferWriter寫(xiě)文件寫(xiě)不進(jìn)去或缺失數(shù)據(jù)的解決

    Java BufferWriter寫(xiě)文件寫(xiě)不進(jìn)去或缺失數(shù)據(jù)的解決

    這篇文章主要介紹了Java BufferWriter寫(xiě)文件寫(xiě)不進(jìn)去或缺失數(shù)據(jù)的解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望...

    spcoder14552021-10-18
  • Java教程升級(jí)IDEA后Lombok不能使用的解決方法

    升級(jí)IDEA后Lombok不能使用的解決方法

    最近看到提示IDEA提示升級(jí),尋思已經(jīng)有好久沒(méi)有升過(guò)級(jí)了。升級(jí)完畢重啟之后,突然發(fā)現(xiàn)好多錯(cuò)誤,本文就來(lái)介紹一下如何解決,感興趣的可以了解一下...

    程序猿DD9332021-10-08
  • Java教程Java8中Stream使用的一個(gè)注意事項(xiàng)

    Java8中Stream使用的一個(gè)注意事項(xiàng)

    最近在工作中發(fā)現(xiàn)了對(duì)于集合操作轉(zhuǎn)換的神器,java8新特性 stream,但在使用中遇到了一個(gè)非常重要的注意點(diǎn),所以這篇文章主要給大家介紹了關(guān)于Java8中S...

    阿杜7482021-02-04
  • Java教程Java實(shí)現(xiàn)搶紅包功能

    Java實(shí)現(xiàn)搶紅包功能

    這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)搶紅包功能,采用多線(xiàn)程模擬多人同時(shí)搶紅包,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙...

    littleschemer13532021-05-16
  • Java教程Java使用SAX解析xml的示例

    Java使用SAX解析xml的示例

    這篇文章主要介紹了Java使用SAX解析xml的示例,幫助大家更好的理解和學(xué)習(xí)使用Java,感興趣的朋友可以了解下...

    大行者10067412021-08-30
  • Java教程小米推送Java代碼

    小米推送Java代碼

    今天小編就為大家分享一篇關(guān)于小米推送Java代碼,小編覺(jué)得內(nèi)容挺不錯(cuò)的,現(xiàn)在分享給大家,具有很好的參考價(jià)值,需要的朋友一起跟隨小編來(lái)看看吧...

    富貴穩(wěn)中求8032021-07-12
  • Java教程xml與Java對(duì)象的轉(zhuǎn)換詳解

    xml與Java對(duì)象的轉(zhuǎn)換詳解

    這篇文章主要介紹了xml與Java對(duì)象的轉(zhuǎn)換詳解的相關(guān)資料,需要的朋友可以參考下...

    Java教程網(wǎng)2942020-09-17
  • Java教程20個(gè)非常實(shí)用的Java程序代碼片段

    20個(gè)非常實(shí)用的Java程序代碼片段

    這篇文章主要為大家分享了20個(gè)非常實(shí)用的Java程序片段,對(duì)java開(kāi)發(fā)項(xiàng)目有所幫助,感興趣的小伙伴們可以參考一下 ...

    lijiao5352020-04-06
主站蜘蛛池模板: 极致堕落(高h) | 高清不卡日本v在线二区 | 男人猛激烈吃奶gif动态图 | 免费叼嘿视频 | 欧美人交性视频在线香蕉 | 国自产精品手机在线视频 | 久久视频这有精品63在线国产 | 91精品国产免费久久 | 日韩欧美中文在线 | 国产美女亚洲精品久久久综合 | aaa毛片在线| 日韩xx00| 小小水蜜桃视频高清在线观看免费 | 免费网站直接进入 | 星空无限传媒xk8027穆娜 | 无人区大片免费播放器 | 免费一区在线 | 亚洲人成毛片线播放 | 国产成人免费在线观看 | 午夜小福利 | 麻豆在线观看 | 精品手机在线1卡二卡3卡四卡 | 日本深夜影院 | 亚洲欧美日韩另类在线 | 插入粉嫩 | 疯狂伦交1一6小说 | 日本一区二区三区精品 | 短篇最污的乱淫伦小说全集 | 红怡院欧洲| 日本高清在线播放一区二区三区 | 好男人资源免费播放在线观看 | 成人影院免费看 | 日本69视频在线观看 | 国内自拍网红在综合图区 | 午夜影院费试看黄 | 欧美涩区 | 亚洲日韩精品欧美一区二区 | 999精品视频在线观看热6 | 牛牛色婷婷在线视频播放 | 3黑人巨大vs北岛玲 3d肉浦团在线观看 3d动漫免费 | 免费看国产一级特黄aa大片 |