电脑知识|欧美黑人一区二区三区|软件|欧美黑人一级爽快片淫片高清|系统|欧美黑人狂野猛交老妇|数据库|服务器|编程开发|网络运营|知识问答|技术教程文章 - 好吧啦网

您的位置:首頁(yè)技術(shù)文章
文章詳情頁(yè)

Spring:如何使用枚舉參數(shù)

瀏覽:59日期:2023-06-25 18:48:34
目錄 枚舉參數(shù)確認(rèn)需求定義枚舉Converter 和 ConverterFactory加載配置測(cè)試總結(jié) 枚舉參數(shù)

接口開(kāi)發(fā)過(guò)程中不免有表示類型的參數(shù),比如 0 表示未知,1 表示男,2 表示女。通常有兩種做法,一種是用數(shù)字表示,另一種是使用枚舉實(shí)現(xiàn)。

使用數(shù)字表示就是通過(guò)契約形式,約定每個(gè)數(shù)字表示的含義,接口接收到參數(shù),就按照約定對(duì)類型進(jìn)行判斷,接口維護(hù)成本比較大。

在 Spring 體系中,使用枚舉表示,是借助 Spring 的 Converter 機(jī)制,可以將數(shù)字或字符串對(duì)應(yīng)到枚舉的序號(hào)或者 name,然后將前端的輸入轉(zhuǎn)換為枚舉類型。

在場(chǎng)景不復(fù)雜的場(chǎng)景中,枚舉可以輕松勝任。

于是,迅速實(shí)現(xiàn)邏輯,準(zhǔn)備提測(cè)。這個(gè)時(shí)候需求變了,不允許選擇未知性別,只能選男或女,就沒(méi)有 0 值。這樣,因?yàn)槿≈凳菑?1 開(kāi)始,而枚舉的序號(hào)是從 0 開(kāi)始,就會(huì)產(chǎn)生沖突。

還有一些不太多的場(chǎng)景,就是前端不期望類型都是用數(shù)字,可能期望用一些有意義的字符串表示。但是按照前端規(guī)范,需要用小寫或者駝峰命名。但是后端的規(guī)范中,枚舉必須是大寫,又是沖突。

需求合不合理暫且不論,我們要保存對(duì)技術(shù)的探索精神。

確認(rèn)需求

首先確認(rèn)需求。我們期望定義一個(gè)枚舉類作為參數(shù),接口訪問(wèn)的時(shí)候,可以是 int 類型的 id,id 取值不限于枚舉的序號(hào);也可以是 String 類型的 code,code 取值不限于枚舉的 name。換句話說(shuō),這個(gè)枚舉有個(gè) id 和 code,隨意定義,只要接口傳過(guò)來(lái)匹配上,就能夠自動(dòng)轉(zhuǎn)成枚舉類型。

既然這樣,我們就規(guī)范下 id 和 code 取值。為了擴(kuò)展,定義三個(gè)接口:IdBaseEnum、CodeBaseEnum 以及 IdCodeBaseEnum。

public interface IdBaseEnum { Integer getId();}public interface CodeBaseEnum { String getCode();}public interface IdCodeBaseEnum extends IdBaseEnum, CodeBaseEnum {}

接下來(lái)就該定義我們的主角了。

定義枚舉

前面定義了三個(gè)接口,分別是單獨(dú) id、單獨(dú) code,和有 id 和 code 的。這樣,我們就可以定義三種枚舉,分別對(duì)應(yīng)三個(gè)接口。三種方式類似,所以就不在文中重復(fù)列舉了。感興趣的可以關(guān)注公眾號(hào)「看山的小屋」回復(fù) spring 獲取源碼。

我們定義一個(gè)性別枚舉,枚舉包含 id 和 code 兩個(gè)屬性。

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; }}

這里需要注意一點(diǎn),id 和 code 不能重復(fù)。

1.id 與 id、code 與 code 不能重復(fù),比如 MAIL 定義 id 是 1,F(xiàn)AMLE 就不能定義 id 是 1 了。

2.id 與 code 之間也不能重復(fù),比如,MALE 定義 id 是 1001,F(xiàn)EMALE 定義 code 是 1001。

這是由于 Spring 在轉(zhuǎn)換參數(shù)的時(shí)候,將輸入?yún)?shù)全部視為 String 類型。雖然我們定義 id 和 code 類型不同,但是在匹配的時(shí)候,都是按照字符串匹配的。如果存在相同值,就會(huì)產(chǎn)生歧義。

Converter 和 ConverterFactory

根據(jù)規(guī)范,接下來(lái)定義一下 Converter 和 ConverterFactory。這些是 Spring 留給我們的擴(kuò)展口,按照規(guī)范定義即可。

Converter 類:

public class IdCodeToEnumConverter<T extends IdCodeBaseEnum> implements Converter<String, T> { private final Map<String, T> idEnumMap = Maps.newHashMap(); private final Map<String, T> codeEnumMap = Maps.newHashMap(); public IdCodeToEnumConverter(Class<T> enumType) {Arrays.stream(enumType.getEnumConstants()).forEach(x -> { idEnumMap.put(x.getId().toString(), x); codeEnumMap.put(x.getCode(), x);}); } @Override public T convert(String source) {return Optional.of(source).map(codeEnumMap::get).orElseGet(() -> Optional.of(source).map(idEnumMap::get).orElseThrow(() -> new CodeBaseException(ErrorResponseEnum.PARAMS_ENUM_NOT_MATCH))); }}

ConverterFactory 類:

public class IdCodeToEnumConverterFactory implements ConverterFactory<String, IdCodeBaseEnum> { @SuppressWarnings('rawtypes') private static final Map<Class, Converter> CONVERTERS = Maps.newHashMap(); @Override public <T extends IdCodeBaseEnum> Converter<String, T> getConverter(Class<T> targetType) {//noinspection uncheckedConverter<String, T> converter = CONVERTERS.get(targetType);if (converter == null) { converter = new IdCodeToEnumConverter<>(targetType); CONVERTERS.put(targetType, converter);}return converter; }}

這兩個(gè)就是轉(zhuǎn)換的核心了,我們只要將他們裝配到 Spring 的類型轉(zhuǎn)換器中,就能夠?qū)崿F(xiàn)枚舉類型的自動(dòng)轉(zhuǎn)化了。

加載配置

將我們定義的 Converter 和 ConverterFactory 注冊(cè)到 Spring 的類型轉(zhuǎn)換器中。

@Configurationpublic class WebConfig implements WebMvcConfigurer { @Override public void addFormatters(FormatterRegistry registry) {registry.addConverterFactory(new IdCodeToEnumConverterFactory());registry.addConverterFactory(new CodeToEnumConverterFactory());registry.addConverterFactory(new IdToEnumConverterFactory()); }}

至此,核心定義全部結(jié)束。

測(cè)試

寫一個(gè) Controller 作為測(cè)試入口:

@RestController@RequestMapping('echo')public class EchoController { @GetMapping('gender-id-code') public String genderIdCode(@RequestParam('gender') GenderIdCodeEnum gender) {return gender.name(); }}

準(zhǔn)備測(cè)試用例測(cè)試:

@SpringBootTest(classes = SpringEnumParamApplication.class)@AutoConfigureMockMvcclass EchoControllerTest { @Autowired private MockMvc mockMvc; @ParameterizedTest @ValueSource(strings = {'MALE', 'male', '1'}) void genderIdCode(String gender) throws Exception {final String result = mockMvc.perform(MockMvcRequestBuilders.get('/echo/gender-id-code').param('gender', gender)).andExpect(MockMvcResultMatchers.status().isOk()).andDo(MockMvcResultHandlers.print()).andReturn().getResponse().getContentAsString();Assertions.assertEquals('MALE', result); }}總結(jié)

實(shí)現(xiàn)枚舉參數(shù)并不難,只要按照 Spring 的擴(kuò)展規(guī)范實(shí)現(xiàn)即可。需要注意的是,注意枚舉類中唯一的 id 和 code。

本文是應(yīng)用,下篇說(shuō)一下原理。以及 http body 形式請(qǐng)求的枚舉轉(zhuǎn)換邏輯。

本篇文章就到這里了,希望能給你帶來(lái)幫助,也希望您能夠多多關(guān)注好吧啦網(wǎng)的更多內(nèi)容!

標(biāo)簽: Spring
相關(guān)文章:
主站蜘蛛池模板: 天津试验仪器-电液伺服万能材料试验机,恒温恒湿标准养护箱,水泥恒应力压力试验机-天津鑫高伟业科技有限公司 | 不锈钢钢格栅板_热浸锌钢格板_镀锌钢格栅板_钢格栅盖板-格美瑞 | 东莞精密模具加工,精密连接器模具零件,自動機零件,冶工具加工-益久精密 | 深圳南财多媒体有限公司介绍| 执业药师报名时间,报考条件,考试时间-首页入口 | 科研ELISA试剂盒,酶联免疫检测试剂盒,昆虫_植物ELISA酶免试剂盒-上海仁捷生物科技有限公司 | 深圳市超时尚职业培训学校,培训:月嫂,育婴,养老,家政;化妆,美容,美发,美甲. | 探鸣起名网-品牌起名-英文商标起名-公司命名-企业取名包满意 | atcc网站,sigma试剂价格,肿瘤细胞现货,人结肠癌细胞株购买-南京科佰生物 | 安全光栅|射频导纳物位开关|音叉料位计|雷达液位计|两级跑偏开关|双向拉绳开关-山东卓信机械有限公司 | 深圳市宏康仪器科技有限公司-模拟高空低压试验箱-高温防爆试验箱-温控短路试验箱【官网】 | 电主轴,车床电磨头,变频制动电机-博山鸿达特种电机 | 上海办公室装修公司_办公室设计_直营办公装修-羚志悦装 | 钢托盘,铁托盘,钢制托盘,镀锌托盘,饲料托盘,钢托盘制造商-南京飞天金属13260753852 | led冷热冲击试验箱_LED高低温冲击试验箱_老化试验箱-爱佩百科 | 袋式过滤器,自清洗过滤器,保安过滤器,篮式过滤器,气体过滤器,全自动过滤器,反冲洗过滤器,管道过滤器,无锡驰业环保科技有限公司 | 一体化污水处理设备-一体化净水设备-「山东梦之洁水处理」 | 蒸压釜-陶粒板隔墙板蒸压釜-山东鑫泰鑫智能装备有限公司 | 硅PU球场、篮球场地面施工「水性、环保、弹性」硅PU材料生产厂家-广东中星体育公司 | 水成膜泡沫灭火剂_氟蛋白泡沫液_河南新乡骏华消防科技厂家 | 免联考国际MBA_在职MBA报考条件/科目/排名-MBA信息网 | 济南网站建设_济南网站制作_济南网站设计_济南网站建设公司_富库网络旗下模易宝_模板建站 | 光照全温振荡器(智能型)-恒隆仪器 | 磁力去毛刺机_去毛刺磁力抛光机_磁力光饰机_磁力滚抛机_精密金属零件去毛刺机厂家-冠古科技 | 带压开孔_带压堵漏_带压封堵-菏泽金升管道工程有限公司 | 济宁工业提升门|济宁电动防火门|济宁快速堆积门-济宁市统一电动门有限公司 | 非甲烷总烃分析仪|环控百科 | 密封圈_泛塞封_格莱圈-[东莞市国昊密封圈科技有限公司]专注密封圈定制生产厂家 | 通信天线厂家_室分八木天线_对数周期天线_天线加工厂_林创天线源头厂家 | 食品无尘净化车间,食品罐装净化车间,净化车间配套风淋室-青岛旭恒洁净技术有限公司 | 河南橡胶接头厂家,河南波纹补偿器厂家,河南可曲挠橡胶软连接,河南套筒补偿器厂家-河南正大阀门 | 团建-拓展-拓展培训-拓展训练-户外拓展训练基地[无锡劲途] | 首页-瓜尔胶系列-化工单体系列-油田压裂助剂-瓜尔胶厂家-山东广浦生物科技有限公司 | 石家庄装修设计_室内家装设计_别墅装饰装修公司-石家庄金舍装饰官网 | X光检测仪_食品金属异物检测机_X射线检测设备_微现检测 | 齿轮减速机电机一体机_齿轮减速箱加电机一体化-德国BOSERL蜗轮蜗杆减速机电机生产厂家 | 光谱仪_积分球_分布光度计_灯具检测生产厂家_杭州松朗光电【官网】 | sus630/303cu不锈钢棒,440C/430F/17-4ph不锈钢研磨棒-江苏德镍金属科技有限公司 | CPSE安博会| 微学堂-电动能源汽车评测_电动车性能分享网 | 散热器-电子散热器-型材散热器-电源散热片-镇江新区宏图电子散热片厂家 |