TypeScript 枚举

　　我们常常会有这样的场景，比如与后端开发约定订单的状态开始是0，未结账是1，运输中是2，运输完成是3，已收货是4。这样的纯数字会使得代码缺乏可读性。枚举就用于这样的场景。枚举可以让我们定义一些名字有意义的常量。使用枚举可以清晰地表达我们的意图。TypeScript支持基于数字枚举和字符串的枚举。

 

⒈数字枚举

　　首先我们举例来看数字枚举

enum OrderStatus{
    Start = 1,
    Unpaid,
    Shipping,
    Shipped,
    Complete,
}

　　就像上面这样，我们通过数字来表达了订单状态。在实际的代码编写时，我们就直接使用OrderStatus.Start来代替原本的数字1，这就使得代码具备了相当的可读性，甚至可以免去冗余的注释。

　　在上面的代码中还使用了一个小技巧，当只写Start = 1时，后面的枚举变量就是递增的，当我们不在乎成员的值的时候，这种自增长的行为是很有用处的，但是要注意每个枚举成员的值都是不同的，但你也可以明确地写出每个枚举变量的数字，这取决于具体的业务场景。

　　当我们连第一个枚举变量的值都不写的时候，初始值将会为0，后面的枚举类型再依次递增。

enum OrderStatus{
    Start,
    Unpaid,
    Shipping,
    Shipped,
    Complete,
}

　　现在OrderStatus.Start的值为0，通常情况下，在使用这样的写法时，我们其实是不在乎成员变量的具体值的，我们只知道这些值是不同的。

　　枚举类型中的值必须是确定的，比如，像下面这样的写法是不被允许的。

enum Example{
    A = hello(),
    b,
}

　　类似这样没有给出确定值的写法在TypeScript中都是不被允许的。

 

⒉字符串枚举

　　字符串枚举的概念与数字枚举有一些细微的差别

　　在一个字符串枚举中，所有成员必须都是字符串字面量，且字符串枚举没有递增的含义，字符串枚举的成员都必须手动初始化。　

enum OrderStatus{
    Start = 'Start',
    Unpaid = 'Unpaid',
    Shipping = 'Shipping',
    Shipped = 'Shipped',
    Complete = 'Complete',
}

　　虽然字符串枚举显得繁琐，但相比数字枚举，由于字符串枚举没有自增长的行为，因此字符串枚举能进一步提升可读性，如果你正在调试并且必须要读一个数字枚举的运行时的值，这个值通常是很难读的，即使读取出来它也并不能表达有用的信息，而字符串枚举允许你提供一个运行时有意义的并且可读的值，独立于枚举成员的名字。这使得调试变得更容易。所以在实际的开发中，大家更喜欢使用字符串枚举。

 

⒊异构枚举

　　从技术的角度来说，枚举可以混合字符串和数字成员，但是似乎你并不会这么做，除非你真的想要利用JavaScript运行时的行为，否则我们不建议这样做。

enum OrderStatus{
    Start = 'Start',
    Unpaid = 1,
    Shipping,
    Shipped,
    Complete,
}

⒋枚举成员的值

　　每个枚举成员都带有一个值，它可以是 常量或 经过计算出来的。

　　当满足如下条件时，枚举成员被当作是常量：

　　　　1.当前枚举成员是枚举的第一个成员且没有初始化器，这种情况下它将被赋予常量值 0：

enum OrderStatus{
    Start,  //OrderStatus.Start is 0
    Unpaid,
    Shipping,
    Shipped,
    Complete,
}

　　　　2.当前枚举成员不带有初始化器且它之前的枚举成员的值是一个 数字常量。 这种情况下，当前枚举成员的值为它上一个枚举成员的值加1。

enum OrderStatus{
    Start = 0, 
    Unpaid, //OrderStatus.Unpaid is 1
    Shipping,
    Shipped,
    Complete,
}

　　　　3.枚举成员使用 常量枚举表达式初始化。 常数枚举表达式是TypeScript表达式的子集，它可以在编译阶段求值。 当一个表达式满足下面条件之一时，它就是一个常量枚举表达式：

• • 一个枚举表达式字面量（主要是字符串字面量或数字字面量）
  • 一个对之前定义的常量枚举成员的引用（可以是在不同的枚举类型中定义的）
  • 带括号的常量枚举表达式
  • 一元运算符 +, -, ~其中之一应用在了常量枚举表达式
  • 常量枚举表达式做为二元运算符 +, -, *, /, %, <<, >>, >>>, &, |, ^的操作对象。 若常数枚举表达式求值后为 NaN或 Infinity，则会在编译阶段报错。

　　当以上的条件均不满足的情况下，枚举成员被当作是需要计算得出的值：

enum OrderStatus{
    None,
    Read = 1 << 1,
    Write = 1 << 2,
    ReadWrite  = Read | Write,
    G = "123".length
}

⒌枚举成员类型和联合枚举类型

　　如果一个枚举里所有成员的值都是字面量类型的值，那么这个枚举的每个成员和枚举本身都可以作为类型来使用。字面量枚举成员需满足以下条件：

• • 不带初始值的枚举成员，例如 enum E { A }
  • 值为字符串字面量，例如 enum E { A = 'hello' }
  • 值为数字字面量，或者带有一元 - 符号的数字字面量，例如 enum E { A = 1 }，enum E { A = -1 }

　　1.枚举成员类型

　　把符合条件的枚举成员作为类型来使用，例子：

enum ShapeKind {
  Circle,
  Square
}

interface Circle {
  kind: ShapeKind.Circle // 使用 ShapeKind.Circle 作为类型，指定接口须有 kind 字段，且类型为 ShapeKind.Circle
  radius: number
}

interface Square {
  kind: ShapeKind.Square // 同上
  sideLength: number
}

let c: Circle = {
  kind: ShapeKind.Square, // Error! 因为接口 Circle 的 kind 被指定为 ShapeKind.Circle类型，所以这里会报错
  radius: 100
}

　　interface是定义接口，现在简单了解即可。

　　2.联合枚举类型

　　符合条件的枚举本身可以看作是一个包含所有成员的联合类型，下面例子：

// 枚举 Status 里有两个状态
enum Status {
  Off,
  On
}

// 枚举 Animal 里有两个动物
enum Animal {
  Cat,
  Dog
}

// 接口 Light 中定义 status字段，它是 Status 类型，可以是 Off 或者 On 状态
interface Light {
  status: Status
}

let lg1: Light = {
  status: Status.Off // 正确
}

let lg2: Light = {
  status: Animal.Cat // error 不能将类型 Animal.Cat 分配给类型 Status
}

⒍运行时的枚举

　　枚举是在运行时真正存在的对象，可以把枚举当作对象使用:

enum E {
  A,
  B
}

function func(obj: { A: number }): number {
  return obj.A
}

console.log(func(E)) // 0

　　代码中，声明了一个函数 func，它的参数是一个对象，且必须包含属性名为 A 的属性，A 的值为数值类型。当调用函数 func 时，把枚举 E 当作符合条件的实参传入，正确运行。

⒎反向映射

　　反向映射是数字枚举的一个技巧，这得益于TypeScript在实现数字枚举时的代码编译。

　　例如当我们设定了如下一个枚举时：

enum OrderStatus{
    A
}

　　TypeScript编译器将这段代码编译到JavaScript时是这样的：

var Enum;
(function (Enum) {
    Enum[Enum["A"] = 0] = "A";
})(Enum || (Enum = {}));

　　生成的代码中，枚举类型被编译成一个对象，它包含了正向映射（ key -> value）和反向映射（ value -> key）。所以我们既可以通过属性名获取属性值，也可以通过属性值获取属性名。

let a = OrderStatus.A;
let b = OrderStatus[0];
console.log(a);　　//0
console.log(b);　　//A

　　注意：字符串编译后并没有这样的特性，因此，在字符串枚举中没有反向映射。

⒏const 枚举

　　定义的枚举，在经过编译器编译后是一个对象，这个对象我们可以在程序运行时使用，前面有说到。但有时定义枚举可能只是为了让程序可读性更好，而不需要编译后的代码，即不需要编译成对象。typescript中考虑到这种情况，所以加入了 const enum (完全嵌入的枚举)。typescript官网有一个在线编译器，来看看下面的例子：

enum Status{
    Off,
    On
}

const enum Animal{
    Dog,
    Cat
}

const status = Status.On
const animal = Animal.Dog

　　这段代码编译成JavaScript后是这样的：

var Status;
(function (Status) {
    Status[Status["Off"] = 0] = "Off";
    Status[Status["On"] = 1] = "On";
})(Status || (Status = {}));
var status = Status.On;
var animal = 0 /* Dog */;

　　可以看到编译后的代码中并没有像创建Status一样创建了Animal，而是直接把 Animal 中 Dog 值 0 替换到表达式中 Animal.Dog 的位置，这样就节省了生成代码的开销。

⒐外部枚举

　　外部枚举用来描述已经存在的枚举类型的形状。

declare enum Enum {
    A = 1,
    B,
    C = 2
}

　　外部枚举和非外部枚举之间有一个重要的区别，在正常的枚举里，没有初始化方法的成员被当成常数成员。 对于非常数的外部枚举而言，没有初始化方法时被当做需要经过计算的。

 

　　借鉴文章：https://www.cnblogs.com/wjaaron/p/11672764.html