萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JavaScript 模擬 Enum (列舉) 的多種模式與最佳實踐

為什麼 JS 需要模擬 Enum?

JS 無原生 enum 關鍵字,但透過物件凍結、Symbol、TypeScript 等手段可實現類型安全、語意清晰、除錯友善的列舉。

模式一:凍結物件 (最常用、可序列化)

const WeekDay = Object.freeze({
    Sunday: 0,
    Monday: 1,
    Tuesday: 2,
    Wednesday: 3,
    Thursday: 4,
    Friday: 5,
    Saturday: 6
});

// 反向映射 (值 -> 名稱)
WeekDay[0] = 'Sunday'; // ❌ Object.freeze 禁止新增屬性
// 正確做法:建立獨立反向映射
const WeekDayNames = Object.freeze(Object.fromEntries(
    Object.entries(WeekDay).map(([k, v]) => [v, k])
));

// 使用
if (today === WeekDay.Monday) { ... }
console.log(WeekDayNames[today]); // 'Monday'

模式二:Symbol 唯一值 (類型安全、不可序列化)

const Color = Object.freeze({
    Red: Symbol('Color.Red'),
    Green: Symbol('Color.Green'),
    Blue: Symbol('Color.Blue')
});

// 唯一性保證
Color.Red === Color.Red; // true
Color.Red === 'Red';     // false (避免字串混淆)
Color.Red === Color.Green; // false

// JSON 序列化會忽略 Symbol,需自訂 toJSON
const payload = { color: Color.Red };
JSON.stringify(payload); // '{}' 除非加上 replacer

模式三:字串 Enum (可序列化、可除錯、API 友善)

const HttpStatus = Object.freeze({
    OK: 'OK',
    CREATED: 'CREATED',
    BAD_REQUEST: 'BAD_REQUEST',
    UNAUTHORIZED: 'UNAUTHORIZED',
    NOT_FOUND: 'NOT_FOUND',
    SERVER_ERROR: 'SERVER_ERROR'
});

// 直接用於 API 回傳、localStorage、URL 參數
fetch('/api', { 
    method: 'POST', 
    body: JSON.stringify({ status: HttpStatus.CREATED }) 
});

模式四:類別基礎 Enum (含方法、位元旗標)

class Permission {
    static READ   = 1 << 0; // 1
    static WRITE  = 1 << 1; // 2
    static EXEC   = 1 << 2; // 4
    static ADMIN  = Permission.READ | Permission.WRITE | Permission.EXEC; // 7
    
    static has(flags, check) { return (flags & check) === check; }
    static add(flags, ...adds) { return adds.reduce((f, a) => f | a, flags); }
    static remove(flags, ...removes) { return removes.reduce((f, r) => f & ~r, flags); }
    
    static toArray(flags) {
        const all = [Permission.READ, Permission.WRITE, Permission.EXEC];
        return all.filter(p => (flags & p) === p).map(p => Object.keys(Permission).find(k => Permission[k] === p));
    }
}

const userPerm = Permission.ADD(Permission.READ, Permission.WRITE); // 3
Permission.has(userPerm, Permission.READ); // true
Permission.toArray(userPerm); // ['READ', 'WRITE']

模式五:TypeScript 原生 enum (編譯期類型檢查)

// TypeScript
enum Direction { Up = 1, Down, Left, Right }
enum HttpCode { OK = 200, NotFound = 404 }

// 編譯為 JS (預設數值枚舉)
var Direction;
(function(Direction) {
    Direction[Direction.Up = 1] = 'Up';
    Direction[Direction.Down = 2] = 'Down';
    // ... 反向映射自動生成
})(Direction || (Direction = {}));

// const enum (內聯常數,無執行期物件)
const enum Status { Active, Inactive } // 編譯時直接替換為 0/1

進階工具函式

// 建立雙向映射 Enum
function createEnum(obj) {
    const forward = Object.freeze({ ...obj });
    const reverse = Object.freeze(Object.fromEntries(
        Object.entries(forward).map(([k, v]) => [v, k])
    ));
    return Object.freeze({ ...forward, $reverse: reverse, $keys: Object.keys(forward), $values: Object.values(forward) });
}

const OrderStatus = createEnum({
    Pending: 0,
    Paid: 1,
    Shipped: 2,
    Completed: 3,
    Cancelled: -1
});

OrderStatus.Pending;        // 0
OrderStatus.$reverse[1];    // 'Paid'
OrderStatus.$values;        // [0,1,2,3,-1]

選型建議

場景推薦模式理由
一般業務狀態碼字串 Enum可序列化、日誌可讀、API 直通
內部邏輯分支、位元旗標數值 Enum / 類別位運算高效、記憶體小
需絕對類型安全、避免字串碰撞Symbol Enum唯一性保證、不可被字串意外匹配
TypeScript 專案TS enum / const enum編譯期型別檢查、IDE 自動完成、重構安全
copyright © 萬盛學電腦網 all rights reserved