TypeScript 数据类型——枚举 (Enum)

如 TypeScript 官方文档所说，枚举类型是对 JavaScript 标准数据类型集的扩充。对于熟悉 C# 的开发者来说，枚举类型并不陌生，它能够给一系列数值集合提供友好的名称，也就是说枚举表示的是一个命名元素的集合，因而它能够使您的程序避免因硬编码的值而显杂乱且难以维护。

今天，我们将围绕枚举类型展开以下几个内容：

• 枚举基础
• 背后的 JavaScript 及其可扩充性
• 常量枚举
• 最佳实践

枚举基础

默认情况下，枚举是基于 0 的，也就是说第一个值是 0，后面的值依次递增。不要担心，当中的每一个值都可以显式指定，只要不出现重复即可，没有被显式指定的值，都会在前一个值的基础上递增。

enum Color {Red, Green, Blue}
let c: Color = Color.Green;  // 1

或

enum Color {Red = 1, Green, Blue = 4}
let c: Color = Color.Green;  // 2

枚举有一个很方便的特性，就是您也可以向枚举传递一个数值，然后获取它对应的名称值。举个例子，如果我们有一个值 2，但是不清楚在 Color 枚举中与之对应的名称是什么，我们就可以通过以下的方式来进行检索：

enum Color {Red = 1, Green, Blue}
let colorName: string = Color[2];  // 'Green'

但是像上面的这种写法不是太好，因为如果您给定的数值没有与之对应的枚举项，那么结果就是 undefined。所以，如果您想要得到指定枚举项的字符串名称，可以使用类似这样的写法：

let colorName: string = Color[Color.Green];  // 'Green'

背后的 JavaScript

不知道大家有没有好奇过，既然 JavaScript 中没有枚举类型，那么 TypeScript 是怎么编译枚举类型的，以使其成为一个合法的 JavaScript 数据类型。现在，我们就以上面提到的枚举的特性一步步分析：

1. 我们可以通过 . 号访问枚举的内容，这与访问对象属性的方式一样，那么我们是否可以将其认为一个对象，这样就可以得到以下的结构：

var Color = {
  Red: 0,
  Green: 1,
  Blue: 2
};

2. 我们也可以通过具体的数值获取其对象的名称，这种操作和数组非常相似，传递索引值，提取具体索引位的值，这样顺理成章得出以下的结构：

var Color = ['Red', 'Green', 'Blue'];

3. 现在将上面提到的两个想法合并起来，那么现在很多人可能傻眼了，#1 推导出来的是对象，#2 推导出来的是数组，这两者怎么结合起来？不要着急，想一想，数组可是一种特殊的对象，我们将推导写在下面的代码中：

// 因为数组也是一种对象，那么全部都用对象表示
var Color = {};

// 换一种方式改写 #1 中的对象
Color['Red'] = 0;
Color['Green'] = 1;
Color['Blue'] = 2;

// 换一种方式改写 #2 中的数组
Color[0] = 'Red';
Color[1] = 'Green';
Color[2] = 'Blue';

4. 看完上面的代码，是否感觉豁然开朗，现在我们继续将上面的代码精简一下：

var Color = {};
Color[Color['Red'] = 0] = 'Red';
Color[Color['Green'] = 1] = 'Green';
Color[Color['Blue'] = 2] = 'Blue';

5. 现在我们看一下，如果是 TypeScript，它会将 enum Color {Red, Green, Blue} 编译为什么样的 JavaScript 代码：

var Color;
(function (Color) {
    Color[Color["Red"] = 0] = "Red";
    Color[Color["Green"] = 1] = "Green";
    Color[Color["Blue"] = 2] = "Blue";
})(Color || (Color = {}));

枚举的可扩充性

注意到上面生成的代码最后一行有没有：(Color || (Color = {}))，这就意味着，如果您代码运行的当前作用域中已经存在了 Color 变量，那么就会直接在当前 Color 变量上面扩展（如果我们是以模块的方式组织代码，就不用担心此种情况）。

基于这个特性，我们可以在多个文件中分散声明我们的枚举类型，比如：

enum Color {
  Red,
  Green,
  Blue
}

enum Color {
  DarkRed = 3,
  DarkGreen,
  DarkBlue
}

编译后：

var Color;
(function (Color) {
    Color[Color["Red"] = 0] = "Red";
    Color[Color["Green"] = 1] = "Green";
    Color[Color["Blue"] = 2] = "Blue";
})(Color || (Color = {}));
(function (Color) {
    Color[Color["DarkRed"] = 3] = "DarkRed";
    Color[Color["DarkGreen"] = 4] = "DarkGreen";
    Color[Color["DarkBlue"] = 5] = "DarkBlue";
})(Color || (Color = {}));

如果我们采用此种写法，千万要注意每一部分枚举项值的设置，以防止值冲突的出现。

常量枚举

如果我们在声明枚举类型的时候，前面加上 const 关键字，那么这个枚举就是常量枚举。但是此种枚举类型与上面提到的不一样，不一样在哪里呢？看下面代码及编译后的结果：

const enum Color {
  Red,
  Green,
  Blue
}

let c: Color = Color.Green;

编译后：

var c = 1 /* Green */;

哇，只剩下简单的一行代码了，Color 变量没了！也就是，编译器针对此种枚举类型做出了如下处理：

• 内联所有的枚举使用（也就是直接内联此枚举项的值）。
• 不为枚举类型生成其对应的 JavaScript 代码（在这里也就是不再生成 Color 变量并为其初始化）。

使用常量枚举，还有一点需要注意的是，我们没法像 Color[Color.Green] 这样获取此枚举项的字符串名称，这也归咎于没有枚举类型的 JavaScript 代码所导致的。

最佳实践

1. 首个枚举项值设置为 1

我们现在都知道，首个枚举项的默认值为 0。这点值得注意，在 JavaScript 中，0 是一个假值，那么就会出现一个问题，如果我想要判断一个枚举值是否存在怎么办？我能直接 if (c) { ... } 这样判断吗？显然是不可靠的，请看下面代码：

enum Color {Red, Green, Blue}

let c: Color;
if (!c) {
  console.log('Yes, I am not defined.');
}

c = Color.Red;
if (!c) {
  console.log('Oops, I have a valid value, but seems I am undefined!');
}

是不是，问题显而易见，如果我们想要对此枚举类型变量值进行判断，我们还得这么写：typeof(c) !== 'undefined'，非常繁琐。而如果将首个枚举项的值设置为 1，我们就可以放心地直接将变量放在条件判断语句中进行判断了。

2. 尽量不要为枚举项手动设置值

好像这一点与上面说的很矛盾啊，其实这一条的重点是，不要为多个枚举项设置值，特别是在枚举项特别多的情况下，因为这很容易出错，如下面代码所示：

enum Color {
  Red,
  Orange = 2,
  Yellow,
  Green,
  Blue,
  Indigo = 5,
  Purple
}

console.log(Color.Blue !== Color.Indigo ? 'yes' : 'no');  // 'no'

很不幸的是，您原本认为这两个值不一样，可结果是一样的，这是由于您的疏忽而导致的（如果 TypeScript 能够为此提供审查的机制，并在编译时报错，我们就很大程度上避免犯这样的错）。我们可以继续看一下编译后的结果：

var Color;
(function (Color) {
    Color[Color["Red"] = 0] = "Red";
    Color[Color["Orange"] = 2] = "Orange";
    Color[Color["Yellow"] = 3] = "Yellow";
    Color[Color["Green"] = 4] = "Green";
    Color[Color["Blue"] = 5] = "Blue";
    Color[Color["Indigo"] = 5] = "Indigo";
    Color[Color["Purple"] = 6] = "Purple";
})(Color || (Color = {}));

同样，Color[5] 获取的值也具有歧义，程序的稳定性也因此受到影响，所以如果不是出于某种特殊目的，就不要手动去设置值了。

3. 不要为枚举项设置字符串数据类型

您可能会好奇了，难道除了数字类型，还能设置字符串类型？是的，的确可以。但是我为什么不推荐这么做呢？我们看一下下面代码编译后的结果就知道了：

enum Color {
  Red,
  Green,
  Blue = 'Blue Color'
}

编译后：

var Color;
(function (Color) {
    Color[Color["Red"] = 0] = "Red";
    Color[Color["Green"] = 1] = "Green";
    Color["Blue"] = "Blue Color";
})(Color || (Color = {}));

不难发现，我们没法像 Color[1] 这样使用 Color['Blue Color'] 了，这样就导致行为结果与预期的不一致性，其次，如果像下面这样写，TypeScript 还会报错，因为下面的值没法根据上面的字符串值继续递增或推导了：

enum Color {
  Red,
  Green = 'Green Color',
  Blue  // error: Enum member must have initializer.
}

所以这里强烈不建议将枚举项的值设置为字符串类型。

参考资料

• TypeScript - Basic Types
• TypeScript Deep Dive - Enums