6. TypeScript的枚举类型

在TypeScript中，枚举（Enum）是一种特殊的数据类型，它允许为一组数值赋予友好的名字。枚举类型在处理一组相关常量时非常有用，比如状态码、方向、月份等。本文将从多个方面深入探讨TypeScript中枚举类型的使用，包括基本用法、异构枚举、常量枚举、反向映射、枚举成员类型和枚举的高级应用等。

基本用法

在TypeScript中定义一个枚举非常简单，使用enum关键字即可。

enum Direction {
  Up,
  Down,
  Left,
  Right
}

默认情况下，枚举的第一个成员的值为0，后续成员的值依次递增。你也可以手动指定成员的数值。

enum StatusCode {
  Success = 200,
  NotFound = 404,
  ServerError = 500
}

异构枚举

TypeScript允许枚举包含字符串和数字成员，这种枚举被称为异构枚举。

enum BooleanLikeHeterogeneousEnum {
  No = 0,
  Yes = "YES",
}

虽然这种用法不是很常见，但在某些特殊情况下可能会有用。

常量枚举

使用const关键字定义的枚举称为常量枚举。常量枚举在编译阶段会被完全删除，它们的成员会在使用的地方被内联进来。

const enum Directions {
  Up,
  Down,
  Left,
  Right
}

let directions = [Directions.Up, Directions.Down];

常量枚举的优点是在编译后的代码中可以减少额外的代码量。

字符串枚举

字符串枚举是一种枚举类型，它的每个成员都必须用字符串字面量或另一个字符串枚举成员进行初始化。

enum Message {
  Success = "Congratulations!",
  Fail = "Try again!"
}

字符串枚举没有反向映射（从枚举值到枚举名的映射），这是它与数字枚举的一个主要区别。

反向映射

TypeScript的数值枚举具有反向映射的特性，即你可以从枚举值访问到枚举名。

enum Enum {
  A
}
let a = Enum.A;
let nameOfA = Enum[a]; // "A"

枚举成员的值

枚举成员可以是常量或计算得出的值。常量枚举成员在枚举定义时就已经确定了值，而计算所得枚举成员的值则是在运行时计算得出。

enum FileAccess {
  // 常量成员
  None,
  Read    = 1 << 1,
  Write   = 1 << 2,
  ReadWrite  = Read | Write,
  // 计算得出的成员
  G = "123".length
}

同名枚举的合并

TypeScript的枚举类型支持声明合并，即同名的枚举类型会被合并为单一类型。

enum BoxSize {
  Small,
  Medium
}

enum BoxSize {
  Large = 2,
  XLarge,
  XXLarge
}

// BoxSize 现在包含：Small, Medium, Large, XLarge, XXLarge

这种合并行为允许你将一个枚举类型分散到多个位置定义，TypeScript编译器会将它们合并为一个枚举。

keyof运算符

keyof运算符可以与枚举一起使用，以获取枚举的所有键的联合类型。

enum UserResponse {
  No = 0,
  Yes = 1,
}

type UserResponseKeys = keyof typeof UserResponse;
// UserResponseKeys 的类型是 "No" | "Yes"

这种模式在需要根据枚举的键来约束某些值时非常有用。

枚举的类型安全性

使用枚举可以提高代码的类型安全性。当你尝试将任意值赋给枚举类型的变量时，TypeScript会进行类型检查。

enum Status {
  Active,
  Inactive,
  Paused
}

let currentStatus: Status = Status.Active;

// 错误：不能将类型“number”分配给类型“Status”
currentStatus = 123;

枚举的高级应用

枚举类型在实际开发中的应用非常广泛，比如用于状态管理、配置项的定义、权限控制等。通过枚举，我们可以使代码更加清晰和易于维护。

使用枚举进行状态管理

enum LoginState {
  BeforeLogin,
  Success,
  Failure
}

function login(): LoginState {
  // 登录逻辑
  return LoginState.Success; // 假设登录成功
}

let state = login();
if (state === LoginState.Success) {
  console.log("登录成功！");
}

使用枚举定义配置项

enum LogLevel {
  Error,
  Warn,
  Info,
  Debug
}

function log(message: string, level: LogLevel) {
  // 日志记录逻辑
}

log("This is an error message", LogLevel.Error);

枚举类型是TypeScript中一个非常有用的特性，它可以帮助我们以类型安全的方式处理一组相关的值，并且更加容易阅读和理解，代码也更加优雅。