前端枚舉類型的應(yīng)用

后端中經(jīng)常會定義大量的枚舉值enum,而前端往往收到后端給的枚舉值后店溢,僅僅寫個注釋睡扬,前端代碼中到處都是status > 1type === 3之類的魔法代碼谬哀,有些人連注釋都沒有比吭,讓接手者面對直接這些條件判斷一頭霧水。所以前端定義枚舉類型是一定要做的姨涡。

1. JAVA枚舉示例

public enum UserStatusEnum {
    /**
     * 用戶狀態(tài)枚舉
     */
    UNKNOW(0, "未知"),
    NORMAL(1, "正常"),
    ;
    private int status;
    private String description;

    UserStatusEnum(int status, String description) {
        this.status = status;
        this.description = description;
    }
}

public enum ActivityEnum {
    // 活動
    KILL("10", "秒殺"),
    FLASH_SALE("11", "限時優(yōu)惠"),
    ;

    private String activity;
    private String remark;

    ActivityEnum(String activity, String remark) {
        this.activity = activity;
        this.remark = remark;
    }
}

2. 前端枚舉探索

肯定要定義一個枚舉文件衩藤,沒必要像后端一樣,一個枚舉一個文件涛漂。前端可以將所有枚舉放到一個文件中赏表,除非枚舉太多,可進行拆分成多個文件匈仗。

2.1 創(chuàng)建枚舉文件

創(chuàng)建在/src/common目錄下enum.js文件

2.2 將項目中用到的所有枚舉寫在enum.js文件中
export const SmsTypeEnum = {
  REGISTER: { name: 'REGISTER', label: '注冊驗證碼' },
  FORGET_PASSWORD: { name: 'FORGET_PASSWORD', label: '忘記密碼驗證碼' },
  UPDATE_PHONE: { name: 'UPDATE_PHONE', label: '修改手機驗證碼' },
}

export const FlashSaleSceneEnum = {
  HOME: 0,
  MENU: 1,
  PAGE: 2,
}

export const ActivityEnum = {
  // 活動
  KILL: '10', // "秒殺"),
  FLASH_SALE: '11', // "限時優(yōu)惠"),
}

export const PromotionEnum = {
  // 優(yōu)惠
  COUPON: '40', // "優(yōu)惠券"),
  COIN_REWARD: '41', // "積分獎勵"),
  COIN_DEDUCTION: '42', // "積分抵扣"),
  ALLOWANCE: '43', // "購物津貼"),
  CONCESSION: '44', // "滿減"),
  PACKAGES: '45', // "套餐"),
}

export const FreightTypeEnum = {
  WEIGHT: 0,
  COUNT: 1,
}

2.3 枚舉的使用
import { ActivityTypeEnum } from '@/common/enum.js'

<div v-if="item.status < ActivityTypeEnum.DISABLED">編輯</div>

if(item.status < ActivityTypeEnum.DISABLED){
    console.log("沒作廢瓢剿,可編輯")
}

3. 使用過程中遇到的問題

枚舉是否要和后端一樣,定義值value和描述label悠轩?

export const ActivityStatusEnum = {
  ACTIVE: {value: 1, label: "進行中"},
  DISABLED: {value: 2, label: "已禁用"},
}

一開始使用時间狂,覺得應(yīng)該要和后端一樣,定義值value和描述label火架,但后來在實踐過程中發(fā)現(xiàn)代碼有點冗長,并且label往往用不到

item.status < ActivityTypeEnum.DISABLED.value

所以后來全部就采用精簡的枚舉定義鉴象,只取值。但會在值后面寫上注釋

export const ActivityStatusEnum = {
  ACTIVE: 1, // 進行中
  DISABLED: 2, // 已禁用
}

item.status < ActivityTypeEnum.DISABLED

當(dāng)需要進行枚舉值的描述的映射時何鸡,可以再定義一個ActivityStatusList

export const ActivityStatusList = [
  '',
  '進行中',
  '已禁用'
]

當(dāng)枚舉值特別大時纺弊,可以定義一個ActivityStatusMap

export const ActivityStatusMap = {
  10003: '進行中',
  10004: '已禁用'
}

當(dāng)枚舉值需要作為select,radio,checkbox的選項時,可以定義一個ActivityStatusOption

export const ActivityStatusOption = [
  {value: 1, label: "進行中"},
  {value: 2, label: "已禁用"},
]

3. 前端枚舉命名規(guī)則

枚舉對象命名:
ActivityStatusEnum骡男、ActivityStatusList淆游、ActivityStatusMapActivityStatusOption

  • XxxEnum: 表示值value的枚舉
  • XxxList: 表示數(shù)組label的枚舉
  • XxxMap: 表示對象label的枚舉
  • XxxOption: 表示數(shù)組對象的value-label枚舉

枚舉對象中的鍵key命名:
全大寫

export const ActivityStatusEnum = {
  ACTIVE: 1, // 進行中
  DISABLED: 2, // 已禁用
}

命名規(guī)范的好處隔盛,讓人直接知道此對象的作用犹菱;ide全局搜索時,可以快速定位此對象吮炕;ide有智能提示已亥,直接點擊能跳轉(zhuǎn)到定義處等;

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末来屠,一起剝皮案震驚了整個濱河市虑椎,隨后出現(xiàn)的幾起案子震鹉,更是在濱河造成了極大的恐慌,老刑警劉巖捆姜,帶你破解...
    沈念sama閱讀 207,113評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件传趾,死亡現(xiàn)場離奇詭異,居然都是意外死亡泥技,警方通過查閱死者的電腦和手機浆兰,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評論 2 381
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來珊豹,“玉大人簸呈,你說我怎么就攤上這事〉瓴瑁” “怎么了蜕便?”我有些...
    開封第一講書人閱讀 153,340評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長贩幻。 經(jīng)常有香客問我轿腺,道長,這世上最難降的妖魔是什么丛楚? 我笑而不...
    開封第一講書人閱讀 55,449評論 1 279
  • 正文 為了忘掉前任族壳,我火速辦了婚禮,結(jié)果婚禮上趣些,老公的妹妹穿的比我還像新娘仿荆。我一直安慰自己,他們只是感情好坏平,可當(dāng)我...
    茶點故事閱讀 64,445評論 5 374
  • 文/花漫 我一把揭開白布赖歌。 她就那樣靜靜地躺著,像睡著了一般功茴。 火紅的嫁衣襯著肌膚如雪庐冯。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,166評論 1 284
  • 那天坎穿,我揣著相機與錄音展父,去河邊找鬼。 笑死玲昧,一個胖子當(dāng)著我的面吹牛栖茉,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播孵延,決...
    沈念sama閱讀 38,442評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼吕漂,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了尘应?” 一聲冷哼從身側(cè)響起惶凝,我...
    開封第一講書人閱讀 37,105評論 0 261
  • 序言:老撾萬榮一對情侶失蹤吼虎,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后苍鲜,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體思灰,經(jīng)...
    沈念sama閱讀 43,601評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,066評論 2 325
  • 正文 我和宋清朗相戀三年混滔,在試婚紗的時候發(fā)現(xiàn)自己被綠了洒疚。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,161評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡坯屿,死狀恐怖油湖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情领跛,我是刑警寧澤乏德,帶...
    沈念sama閱讀 33,792評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站隔节,受9級特大地震影響鹅经,放射性物質(zhì)發(fā)生泄漏寂呛。R本人自食惡果不足惜怎诫,卻給世界環(huán)境...
    茶點故事閱讀 39,351評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望贷痪。 院中可真熱鬧幻妓,春花似錦、人聲如沸劫拢。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,352評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽舱沧。三九已至妹沙,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間熟吏,已是汗流浹背距糖。 一陣腳步聲響...
    開封第一講書人閱讀 31,584評論 1 261
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留牵寺,地道東北人悍引。 一個月前我還...
    沈念sama閱讀 45,618評論 2 355
  • 正文 我出身青樓,卻偏偏與公主長得像帽氓,于是被迫代替她去往敵國和親趣斤。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,916評論 2 344

推薦閱讀更多精彩內(nèi)容