什麼是枚舉Enum

枚舉 Enum是在眾多語言中都有的一種數據類型，JavaScript中還沒有（TypeScript有）。用來表示一些特定類別的常量數據，如性別、學歷、方向、賬戶狀態等，項目開發中是很常用的。

如上表中的性別枚舉結構，前端頁面上顯示文字男、女，代碼中一般使用編碼key，後端資料庫存儲可能會用編碼key，也可能用數字value值。用數字存儲，占用空間會更小，還能用位運算存儲多個值（算是稍微高級一點的玩法了）。

前端應用場景

表格數據綁定時，需要顯示性別的文字信息，而後端返回的JSON數據中可能是key/value值。

Element 的 table組件 支持綁定一個格式化函數formatter來轉換數據，函數定義：Function(row, column, cellValue, index)。
表單中提供用戶的性別選項，如下拉框、單選按鈕組等。

Element 的下拉框<el-select>通過v-for 來綁定生成 <el-option>選項：

<el-select v-model="value" placeholder="請選擇">
	<el-option
		v-for="item in options"
		:key="item.value"
		:label="item.label"
		:value="item.value">
	</el-option>
</el-select>

封裝Enum數據結構

枚舉數據的使用、綁定是比較常見的，針對Element UI組件進行簡單封裝一下，讓枚舉數據的使用、綁定更輕鬆。

• 新建一個管理枚舉數據的JS文件：enums.js
• 定義一個枚舉工廠構造函數EnumFactory，用來封裝枚舉結構的基礎方法，詳見註釋。
• 工廠方法中通過 Object.defineProperty(obj, prop, descriptor) 添加屬性/方法，該方法添加的預設是不能被枚舉、修改的。
• 申明項目中公共枚舉數據，並導出。
• 枚舉元數據結構：
  • 支持 {key , text} 結構：{ male: '男', female: '女', other: '其他' }
  • 也支持 {key :{text, value }}結構：{ male: { text: '男', value: 1 }, female: { text: '女', value: 2 } }

//枚舉構造器，提供的屬性：
// keys：枚舉的key集合[key]
// texts：枚舉的文本text集合[text]
// values：枚舉的數值value集合[value]
// entries：枚舉的key、text、value集合[{key,text,value}]
// tableFormater：element中表格綁定枚舉數據文本的formatter函數
function EnumFactory(enumObj) {
    //複製（繼承）enumObj
    Object.assign(this, enumObj);

    // keys：枚舉的key集合[key]
    Object.defineProperty(this, 'keys', {
        value: Object.keys(enumObj)
    });
    //處理texts、values、entries    
    let values = [], texts = [], entries = [];
    const vobjs = Object.values(enumObj);
    if (typeof vobjs[0] === 'string') {
        texts = vobjs;
        vobjs.forEach((item, index) => {
            entries.push({ key: this.keys[index], text: texts[index] });
        })
    }
    else {
        vobjs.forEach((item, index) => {
            texts.push(item.text);
            values.push(item.value);
            entries.push({ key: this.keys[index], text: item.text, value: item.value });
        })
    }

    // texts：枚舉的文本text集合[text]
    Object.defineProperty(this, 'texts', { value: texts });

    // values：枚舉的數值value集合[value]
    Object.defineProperty(this, 'values', { value: values });

    // entries：枚舉的key、text、value集合[{key,text,value}]
    Object.defineProperty(this, 'entries', { value: entries });

    // tableFormater：element中表格綁定枚舉數據文本的formatter函數
    Object.defineProperty(this, 'tableFormater', {
        value: function (r, c, value) {
            return entries.filter(v => v.key === value || v.value === value)[0]?.text || 'notfound';
        }
    });

    //枚舉定義的數據都是常量，不可修改，凍結一下
    Object.freeze(this);
}

//********************** 定義項目公共枚舉 ********************** */

//性別枚舉：key、text模式
// const enumSex = new EnumFactory({ male: '男', female: '女', other: '其他' });
//性別枚舉：key、text、value模式
const enumSex = new EnumFactory({ male: { text: '男', value: 1 }, female: { text: '女', value: 2 } });
//水平對齊
const enumAlign = new EnumFactory({ left: '左對齊', center: '居中', right: '右對齊' });
//用戶狀態
const enumUserStatus = new EnumFactory({ default: '正常', delete: '刪除', lock: '鎖定' });

//**********************  export  ********************** */
export { enumSex, enumAlign, enumUserStatus }

//test
console.log(enumSex.keys);
console.log(enumSex.texts);
console.log(enumSex.values);
console.log(JSON.stringify(enumSex.entries));

// ['male', 'female']
// ['男', '女']
// [1, 2]
// [{"key":"male","text":"男","value":1},{"key":"female","text":"女","value":2}]

Element中使用

表格綁定formatter：

<el-table :data="list" :row-class-name="handleRowClass" border>
	<el-table-column prop="name" width="atuo" label="姓名"></el-table-column>
	<el-table-column prop="sex" width="100px" label="性別" align="center" :formatter="enumSex.tableFormater"></el-table-column>
	<el-table-column prop="score" width="150px" label="分數" label-class-name="header-score" align="center"></el-table-column>
	<el-table-column label="操作" align="center" width="120px" class-name="link-btton-col">
		<template slot-scope="scope">
			<el-link @click="handleDelete(scope.row,$event)" type="primary" title="修改">修改</el-link>
			<el-link @click="handleDelete(scope.row,$event)" type="primary" title="查看">查看</el-link>
			<el-link @click="handleDelete(scope.row,$event)" type="danger" title="刪除">刪除</el-link>
		</template>
	</el-table-column>
</el-table>

表單選型組件綁定選項：

<el-form-item label="性別">
	<el-select v-model="seach.sex">
		<el-option v-once v-for="item in enumSex.entries" :key="item.key" :value="item.key" :label="item.text"></el-option>
	</el-select>
</el-form-item>
<el-form-item label="性別">
	<el-radio-group v-model="seach.sex">
		<el-radio-button v-for="item in enumSex.entries" :key="item.key" :label="item.key">{{item.text}}</el-radio-button>
	</el-radio-group>
</el-form-item>

©️版權申明：版權所有@安木夕(kanding)，本文內容僅供學習，歡迎指正、交流，轉載請註明出處！
原文編輯地址：https://www.yuque.com/kanding