解读 TypeScript 枚举Enum

发布于:2025-05-18 ⋅ 阅读:(20) ⋅ 点赞:(0)

TypeScript 枚举通过命名常量、类型安全和结构化组织,显著提升代码质量。使用时需根据场景选择合适的类型(数字、字符串或常量枚举),并权衡性能与动态访问需求。掌握其特性和使用的场景,能在复杂项目中有效提升代码的可维护性和健壮性。接下来我会通过案例,深入解读Enum。

一、枚举的核心作用

  1. 替代魔法值 用有意义的名称取代硬编码数字或字符串,减少代码歧义。

    enum StatusCode { Success = 200, NotFound = 404 }
    if (response.status === StatusCode.Success) { ... } // 比直接判断200更清晰
  2. 类型安全 限制变量只能使用枚举成员,编译器会在赋值或比较时检查类型。

    enum Direction { Up, Down }
    let dir: Direction = Direction.Up; // 正确
    dir = 3; // 错误:不能将数字直接赋值给枚举类型
  3. 组织相关常量 将逻辑关联的常量归类,便于维护和扩展。

    enum LogLevel { Info, Warn, Error }

二、枚举的类型与语法

1. 数字枚举(默认)

  • 成员默认从 0 开始自增,也可手动赋值。
  • 支持反向映射:通过值获取名称(仅数字枚举)。
    enum Direction {
      Up = 1,     // 显式赋值
      Down,       // 自动递增为2
      Left = 4,
      Right,      // 自动递增为5
    }
    console.log(Direction.Down);    // 输出: 2
    console.log(Direction[2]);      // 输出: "Down"(反向映射)

2. 字符串枚举

  • 成员必须显式初始化字符串值。
  • 无反方向映射,适用于需明确语义的场景。
    enum LogLevel {
      Info = "INFO",
      Warn = "WARN",
      Error = "ERROR"
    }
    console.log(LogLevel.Info); // 输出: "INFO"

3. 常量枚举(const enum

  • 编译时被完全内联,无运行时对象
  • 提升性能,但无法反射或动态访问。
    const enum Size { Small, Medium }
    let size = Size.Small; // 编译后:let size = 0;

4. 异构枚举(不推荐)

  • 混合数字和字符串成员,易引发混乱。
    enum BooleanLikeEnum {
      No = 0,
      Yes = "YES",
    }

5. 同名枚举合并 

多个同名的 Enum 结构会自动合并。

enum Foo {
  A,
}
enum Foo {
  B = 1,
}
enum Foo {
  C = 2,
}
// 等同于
enum Foo {
  A,
  B = 1,
  C = 2
}

三、枚举的高级特性

1. 计算成员与常量成员

  • 常量成员:值在编译时确定(字面量、其他常量成员引用)。
  • 计算成员:值在运行时计算(需显式初始化后续成员)。
    enum FileAccess {
      None,                   // 常量成员 0
      Read = 1 << 1,          // 计算成员 2
      Write = 1 << 2,         // 计算成员 4
      ReadWrite = Read | Write, // 计算成员 6
      // 后续成员必须显式初始化
      Execute = 8
    }

2. 枚举作为类型

  • 限制变量或参数只能为枚举成员值,这是枚举的一个缺点。
    enum UserRole { Admin, Guest }
    function setRole(role: UserRole) { ... }
    setRole(UserRole.Admin); // 正确
    setRole(2); // 错误:类型不符

四、枚举的优缺点对比

优点 缺点
提升代码可读性 编译后生成额外代码(非 const enum)
编译时类型检查 字符串枚举不支持反向映射
支持反向映射(数字枚举) 异构枚举易导致逻辑混乱
便于统一管理常量 动态访问可能绕过类型检查(数字枚举)

五、使用场景

  1. 优先使用字符串枚举 提高代码自描述性,避免数字枚举的隐式歧义。

  2. 性能敏感场景用 const enum 减少生成代码量,但需确保无需动态访问枚举。

  3. 替代方案考量

    • 联合类型:适用于简单且无需反向映射的场景。
      type LogLevel = 'INFO' | 'WARN' | 'ERROR';
    • 对象常量:需手动冻结对象防止修改,无类型约束。
      const LogLevel = { Info: 'INFO' } as const;

 引用一个例子:Enum 结构比较适合的场景是,成员的值不重要,名字更重要,从而增加代码的可读性和可维护性。

enum Operator {
  ADD,
  DIV,
  MUL,
  SUB
}
function compute(
  op:Operator,
  a:number,
  b:number
) {
  switch (op) {
    case Operator.ADD:
      return a + b;
    case Operator.DIV:
      return a / b;
    case Operator.MUL:
      return a * b;
    case Operator.SUB:
      return a - b;
    default:
      throw new Error('wrong operator');
  }
}
compute(Operator.ADD, 1, 3) // 4

 上面示例中,Enum 结构Operator的四个成员表示四则运算“加减乘除”。代码根本不需要用到这四个成员的值,只用成员名就够了。

六、示例对比

枚举 vs 联合类型

枚举方案

enum Theme { Dark = 'dark', Light = 'light' }
function setTheme(theme: Theme) { ... }
setTheme(Theme.Dark);

联合类型方案

type Theme = 'dark' | 'light';
function setTheme(theme: Theme) { ... }
setTheme('dark');

对比

  • 枚举集中管理常量,修改时只需调整枚举定义。
  • 联合类型无需生成额外代码,适合简单场景。

网站公告

今日签到

点亮在社区的每一天
去签到