typescript 中的枚举类型

背景

TypeScript 是一种强类型的超集，枚举类型使得代码更加可读和易于维护。枚举提供了一种定义一组命名常量的方式，通常用于表示状态、选项等。

枚举类型定义

要定义一个枚举，可以使用 enum 关键字。下面是一个简单的例子：

1
2
3
4
5
6
enum Direction {
    Up,
    Down,
    Left,
    Right
}

在这个例子中，Direction 是一个枚举类型，包含四个可能的值：Up, Down, Left, Right。默认情况下，这些值从 0 开始递增。

自定义枚举值

可以为枚举中的每个成员指定自定义值：

1
2
3
4
5
enum HttpStatus {
    OK = 200,
    NotFound = 404,
    InternalServerError = 500
}

这里，HttpStatus 枚举明确了 HTTP 状态码的含义，便于理解和使用。

字符串枚举

TypeScript 支持字符串枚举，可以更清晰地表示常量值：

1
2
3
4
5
enum LogLevel {
    Info = "INFO",
    Warn = "WARNING",
    Error = "ERROR"
}

字符串枚举在调试时更具可读性，因为其直接显示了对应的字符串，而不是数字。

使用场景对比

特性 数字枚举 字符串枚举
默认值 从 0 开始递增 手动指定
可读性 一般 较高
调试友好性 不如字符串枚举 好

注意事项

  • 枚举成员不能重复：如果有多个成员具有相同的值，将会导致冲突。
  • 使用时要保持一致性，尽量避免使用数字与字符串混合。

示例代码及参数说明

以下是如何使用上述定义的枚举：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
function getHttpStatusMessage(status: HttpStatus): string {
    switch (status) {
        case HttpStatus.OK:
            return "Request was successful.";
        case HttpStatus.NotFound:
            return "Resource not found.";
        case HttpStatus.InternalServerError:
            return "Something went wrong on the server.";
        default:
            return "Unknown status.";
    }
}

// 调用示例
const message = getHttpStatusMessage(HttpStatus.NotFound);
console.log(message); // 输出: Resource not found.

在此示例中，getHttpStatusMessage 函数接受一个类型为 HttpStatus 的参数，并根据不同状态返回相应的信息。这种方式提高了代码的可读性，同时减少了出错概率。