第5条:用枚举表示状态、选项、状态码

本条要点：（作者总结）

• 应该用枚举来表示状态机的状态、传递给方法的选项以及状态码等值，给这些值起个易懂的名字。
• 如果把传递给某个方法的选项表示为枚举类型，而多个选项又可同时使用，那么就将各选项定义为 2 的幂，以便通过按位或操作将其组合起来。
• 用 NS_ENUM 与 NS_OPTIONS 宏来定义枚举类型，并指明其底层数据类型。这样做可以确保枚举是用开发者所选的底层数据类型实现出来的，而不会采用编译器所选的类型。
• 在处理枚举类型的 switch 语句中不要实现 default 分支。这样的话，加入新枚举之后，编译器就会提示开发者：switch 语句并未处理所有枚举。

由于 Objective-C 基于 C 语言，所以 C 语言有的功能它都有。其中之一就是枚举类型:enum。系统框架中频繁使用此类型，然而开发者容易忽视它。在以一系列常量来表示错误状态码或可组合的选项时，极易使用枚举为其命名。由于 C++11 标准扩充了枚举的特性（一个字节含有 8 个二进制位，所以至多能表示可取 256 种（2 的 8 次方个）枚举（编号为 0～255）的枚举常量），所以最新版系统框架使用了“强类型”（strong type）的枚举。没错，Objective-C 也能得益于 C++11 标准。

枚举只是一种常量命名方式。某个对象所经历的各种状态就可以定义一个简单的枚举集（enumeration set）。比如说，可以用下列枚举表示“套接字连接”（socket connection）的状态:

1 enum EOCConnectionState {
2     EOCConnectionStateDisconnected,
3     EOCConnectionStateConnecting,
4     EOCConnectionStateConnected,
5 };

由于每种状态都用一个便于理解的值来表示，所以这样写出来的代码更易读懂。编译器会为枚举分配一个独有的编号，从 0 开始，每个枚举值递增 1 。实现枚举所用的数据类型取决于编译器，不过其二进制位（bit）的个数必须能完全表示下枚举编号才行。在前例中，由于最大编号是 2，所以使用 1 个字节的 char 类型即可。

然而定义枚举变量的方式却不太简洁，要依如下语法编写：

1 enum EOCConnectionState state = EOCConnectionStateDisconnected;

若是每次不用敲入 enum 而只需要写 EOCConnectionState 就好了。要想这样，则需要使用 typedef 关键字重新定义枚举类型:

1 enum EOCConnectionState {
2     EOCConnectionStateDisconnected,
3     EOCConnectionStateConnecting,
4     EOCConnectionStateConnected,
5 };
6 typedef enum EOCConnectionState EOCConnectionState;

现在可以用简写的 EOCConnectionState 来代替完整的 enum EOCConnectionState 了:

1 EOCConnectionState state = EOCConnectionStateDisconnected;

C++11 标准修订了枚举的某些特性。其中一项改动是:可以指明用何种“底层数据类型”（underlying type）来保存枚举类型的变量。这样的好处是，可以向前声明枚举变量了。若不指定底层数据类型，则无法向前声明枚举类型，因为编译器不清楚底层数据类型的大小，所以在用到此枚举类型时，也就不知道究竟该给变量分配多少空间。

指定底层数据类型所用的语法是:

1 enum EOCConnectionStateConnectionState : NSInteger { /* ... */ };

上面这行代码确保枚举的底层数据类型是 NSInteger。也可以在向前声明时指定底层数据类型:

1 enum EOCConnectionStateConnectionState: NSInteger;

还可以不使用编译器所分配的序号，而是手工指定某个枚举成员所对应的值。语法如下:

1 enum EOCConnectionState {
2     EOCConnectionStateDisconnected = 1,
3     EOCConnectionStateConnecting,
4     EOCConnectionStateConnected,
5 };

上述代码把 EOCConnectionStateDisconnected 的值设为 1 ，而不使用编译器所分配的 0 。如前所述，接下来几个枚举的值都会在上一个的基础上递增 1 。比如说，EOCConnectionStateConnected 的值就是 3。

还有一种情况应该使用枚举类型，那就是定义选项的时候。若这些选项可以彼此组合，则更应如此。只要枚举定义得对，各选项之间就可以通过“按位或操作符”（bitwise OR operator）来组合。例如，iOS UI 框架中有如下枚举类型，用来表示某个视图应该如何在水平或垂直方向上调整大小:

1 typedef NS_OPTIONS(NSUInteger, UIViewAutoresizing) {
2     UIViewAutoresizingNone                 = 0,
3     UIViewAutoresizingFlexibleLeftMargin   = 1 << 0,
4     UIViewAutoresizingFlexibleWidth        = 1 << 1,
5     UIViewAutoresizingFlexibleRightMargin  = 1 << 2,
6     UIViewAutoresizingFlexibleTopMargin    = 1 << 3,
7     UIViewAutoresizingFlexibleHeight       = 1 << 4,
8     UIViewAutoresizingFlexibleBottomMargin = 1 << 5
9 };

每个选项均可启用或禁用，使用上述方式来定义枚举值即可保证这一点，因为在每个枚举值（UIViewAutoresizingNone 除外，它点值是 0，对应的二进制值是 0，其中没有值为 1 的二进制位）所对应的二进制表示中，只有一个二进制位的值是 1。用“按位或操作符”可组合多个选项，例如: UIViewAutoResizingFlexibleWidth | UIViewAutoresizingFlexibleHeight。图列出了每个枚举成员的二进制值，并演示了刚才那两个枚举组合之后的值。用“按位与操作符”（bitwise AND operator）即可判断出是否已启用某个选项:

1     enum UIViewAutoresizing resizing = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
2     if (resizing & UIViewAutoresizingFlexibleWidth) {
3         // UIViewAutoresizingFlexibleWidth is set
4     }

1     UIViewAutoresizingFlexibleLeftMargin 000001
2     UIViewAutoresizingFlexibleWidth 000010
3     UIViewAutoresizingFlexibleRightMargin 000100
4     UIViewAutoresizingFlexibleTopMargin 001000
5     UIViewAutoresizingFlexibleHeight 010000
6     UIViewAutoresizingFlexibleBottomMargin 100000
7     
8     UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight 010010

每个枚举值的二进制表示，以及对其中两个枚举值执行按位或操作之后对二进制值。

系统库中频繁使用这个方法。iOS UI 框架中的 UIKit 里面还有个例子，用枚举值告诉系统视图所支持的设备显示方向。这个枚举类型叫做 UIInterfaceOrientationMask，开发者需要实现一个名为 supportedInterfaceOrientations 的方法，将视图所支持的显示方向高速系统:

1 - (UIInterfaceOrientationMask)supportedInterfaceOrientations {
2     return  UIInterfaceOrientationMaskPortrait | UIInterfaceOrientationMaskLandscapeLeft;
3 }

Foundation 框架中定义了一些辅助的宏，用这些宏来定义枚举类型时，也可以指定用于保存枚举值的底层数据类型。这些宏具备向后兼容（backward compatibility）能力，如果目标平台的编译器支持新标准，那就使用新式语法，否则改用旧式语法。这些宏是用 #define 预处理指令来定义的，其中一个用于定义像 EOCConnectionState 这种普通的枚举类型，另一个用于定义像 UIViewAutoresizing 这种包含一系列选项的枚举类型，其用法如下:

1 typedef NS_ENUM(NSUInteger, EOCConnectionState) {
 2     EOCConnectionStateDisconnected,
 3     EOCConnectionStateConnecting,
 4     EOCConnectionStateConnected,
 5 };
 6 
 7 typedef NS_OPTIONS(NSUInteger, EOCPermittedDirection) {
 8     EOCPermittedDirectionUP = 1 << 0,
 9     EOCPermittedDirectionDown = 1 << 1,
10     EOCPermittedDirectionLeft = 1 << 2,
11     EOCPermittedDirectionRight = 1 << 3,
12 };

这些宏的定义如下:

1 #define NS_ENUM(...) CF_ENUM(__VA_ARGS__)
2 #define NS_OPTIONS(_type, _name) CF_OPTIONS(_type, _name)

由于需要分别处理不同的情况，所以上述代码用很多种方式来定义这两个宏。第一个 #if 用于判断编译器是否支持新式枚举。其中所用的布尔逻辑看上去相当复杂，不过其意思就是想判断编译器是否支持新的枚举特性。如果不支持，那么就用老式语法来定义枚举。

如果支持新特性，那么用 NS_ENUM 宏所定义的枚举类型展开之后就是:

1 typedef enum EOCConnectionState : NSUInteger EOCConnectionState;
2 enum EOCConnectionState : NSUInteger {
3     EOCConnectionStateDisconnected,
4     EOCConnectionStateConnecting,
5     EOCConnectionStateConnected,
6 };

根据是否要将代码按 C++ 模式编译，NS_OPTIONS 宏的定义方式有所不同。如果不按 C++ 编译，那么其展开方式就和 NS_ENUM 相同。若按 C++ 编译，则展开后的代码略有不同。原因在于，用按位或运算来操作两个枚举值时，C＋＋ 编译模式的处理办法与非 C++ 模式不一样。而上面已经提到了，作为选项的枚举值经常需要用按位或运算来组合。在用或运算操作两个枚举值时，C++ 认为运算结果的数据类型应该是枚举的底层数据类型，也就是NSUInteger。而且 C++ 不允许将这个底层类型“隐式转换”（implicit cast）为枚举类型本身。我们用 EOCPermittedDirection 来演示一下，假设按 NS_ENUM 方式将其展开:

1 typedef enum EOCPermittedDirection : int EOCPermittedDirection;
2 
3 enum EOCPermittedDirection : int {
4     EOCPermittedDirectionUP = 1 << 0,
5     EOCPermittedDirectionDown = 1 << 1,
6     EOCPermittedDirectionLeft = 1 << 2,
7     EOCPermittedDirectionRight = 1 << 3,
8 };

然后考虑下列代码:

1 EOCPermittedDirection permittedDirections = EOCPermittedDirectionLeft | EOCPermittedDirectionUP;

若编译器按 C++ 模式编译（也可能是按 Objective-C 模式编译），则会给出下列错误信息:

1 error: cannot initialize a variable of type
2 'EOCPermittedDirection' with an rvalue of type 'int'

如果想编译这行代码，就要将按位或操作的结果显示转换（explicit cast）为 EOCPermittedDirection。所以，在C＋＋ 模式下应该用另一种方式定义 NS_OPTIONS 宏，以便省去类型转换操作。鉴于此，凡是需要以按位或操作来组合的枚举都应该使用 NS_OPTIONS 定义。若是枚举不需要互相组合，则应使用 NS_ENUM 来定义。

能够用到枚举的情况还有很多。前面已经提到，枚举可以表示选项与状态，然而还有许多东西也能用枚举表示。比如状态码就是个好例子。可以把逻辑含义相似的一组状态码放入同一个枚举集里，而不要用 #define 预处理指令或常量来定义。以枚举来表示样式（style）也很合宜。假设创建某个 UI 元素时可以使用不同的样式，那么在这种情况下就最应该把样式声明为枚举类型了。

最后再讲一种枚举的用法，就是在 switch 语句里，有时可以这样定义:

1 typedef NS_ENUM(NSUInteger, EOCConnectionState) {
 2     EOCConnectionStateDisconnected,
 3     EOCConnectionStateConnecting,
 4     EOCConnectionStateConnected,
 5 };
 6 
 7 
 8     switch (_currentState) {
 9         case EOCConnectionStateDisconnected:
10         {
11              // Handle disconnected state
12         }
13             break;
14             case EOCConnectionStateConnecting:
15         {
16             // handle connecting state
17         }
18             break;
19             case EOCConnectionStateConnected:
20         {
21             // handle connected state
22         }
23             break;
24     }

我们总是习惯在 switch 语句中加上 default 分支。然而，若是用枚举来定义状态机（state machine）,则最好不要有 default 分支。这样的话，如果稍后又加了一种状态，那么编译器就会发出警告信息，提示新加入的状态并未在 switch 分支中处理。假如写上了 default 分支，那么它就会处理这个新状态，从而导致编译器不发出警告信息。用 NS_ENUM 定义其他枚举类型时也要注意此问题。例如，在定义代表 UI 元素的枚举时，通常要确保 switch 语句能正确处理所有样式。

END
原文链接: https://www.cnblogs.com/chmhml/p/7011698.html

欢迎关注

微信关注下方公众号，第一时间获取干货硬货；公众号内回复【pdf】免费获取数百本计算机经典书籍