笔记-第5条 用枚举表示状态、选项、状态码(规范)
1、在以一系列常量来表示错误状态码或可组合的选项时,极宜使用枚举为其命名。
2、枚举只是一种常量命名方式。某个对象所经历的各种状态就可以定义为一个简单的枚举集。
3、定义枚举变量的方式不太简洁,要依如下语法编写:
enum EOCConnectionState state = EOCConnectionStateDisconnection;
若是每次不用敲入 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;
4、还有一种情况应该使用枚举,那就是定义选项的时候。
5、
1. enum 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. }
每个选项均可启用或禁用,使用上述方式来定义枚举值即可保证这一点,因为在每个枚举值所对应的二进制表示中,只有1个二进制位的值是1。用“按位或操作符”可组合多个选项,例如:UIViewAutoResizingFlexibleWidth| UIViewAutoresizingFlexibleHeight
。图1-2列出了每个枚举成员的二进制值,并演示了刚才那两个枚举组合之后的值。用“按位与操作符”(bitwise AND operator)即可判断出是否已启用某个选项:
1. enum UIViewAutoresizing resizing =
2. UIViewAutoresizingFlexibleWidth |
3. UIViewAutoresizingFlexibleHeight;
4. if (resizing & UIViewAutoresizingFlexibleWidth) {
5. // UIViewAutoresizingFlexibleWidth is set
6. }
6、Foundation框架中定义了一些辅助的宏,用这些宏来定义枚举类型时,也可以指定用于保存枚举值的底层数据类型。这些宏具备向后兼容(backward compatibility)能力,如果目标平台的编译器支持新标准,那就使用新式语法,否则改用旧式语法。这些宏是用#define
预处理指令来定义的,其中一个用于定义像 EOCConnectionState
这种普通的枚举类型,另一个用于定义像UIViewAutoresizing
这种包含一系列选项的枚举类型,其用法如下:
1. typedef NS_ENUM(NSUInteger, EOCConnectionState) {
2. EOCConnectionStateDisconnected,
3. EOCConnectionStateConnecting,
4. EOCConnectionStateConnected,
5. };
6.
typedef NS_OPTIONS(NSUInteger, EOCPermittedDirection) {
7. EOCPermittedDirectionUp = 1 << 0,
8. EOCPermittedDirectionDown = 1 << 1,
9. EOCPermittedDirectionLeft = 1 << 2,
10. EOCPermittedDirectionRight = 1 << 3,
11. };
这些宏的定义如下:
1. #if (__cplusplus && __cplusplus >= 201103L&&
2. (__has_extension(cxx_strong_enums) ||
3. __has_feature(objc_fixed_enum))
4. ) ||
5. (!__cplusplus && __has_feature(objc_fixed_enum))
6. #define NS_ENUM(_type, _name)
7. enum _name : _type _name; enum _name : _type
8. #if (__cplusplus)
9. #define NS_OPTIONS(_type, _name)
10. type _name; enum : _type
11. #else
12. #define NS_OPTIONS(_type, _name)
13. enum _name : _type _name; enum _name : _type
14. #endif
15. #else
16. #define NS_ENUM(_type, _name) _type _name; enum
17. #define NS_OPTIONS(_type, _name) _type _name; enum
18. #endif
由于需要分别处理不同情况,所以上述代码用多种方式来定义这两个宏。第一个 #if 用于判断编译器是否支持新式枚举。其中所用的布尔逻辑看上去相当复杂,不过其意思就是想判断编译器是否支持新的枚举特性。如果不支持,那么就用老式语法来定义枚举。
如果持新特性,那么用 NS_ENUM 宏所定义的枚举类型展开之后就是:
1. typedef enum EOCConnectionState : NSUInteger EOCConnectionState;
2. enum EOCConnectionState : NSUInteger {
3. EOCConnectionStateDisconnected,
4. EOCConnectionStateConnecting,
5. EOCConnectionStateConnected,
6. };
7、根据是否要将代码按 C++ 模式编译,NS_OPTIONS 宏的定义方式也有所不同。如果不按 C++ 编译,那么其展开方式就和 NS_ENUM 相同。若按 C++ 编译,则展开后的代码略有不同。原因在于,用按位或运算来操作两个枚举值时,C++ 编译模式的处理办法与非 C++ 模式不一样。而上面已经提到了,作为选项的枚举值经常需要用按位或运算来组合。在用或运算操作两个枚举值时,C++ 认为运算结果的数据类型应该是枚举的底层数据类型,也就是NSUInteger。而且 C++ 不允许将这个底层类型“隐式转换”(implicit cast)为枚举类型本身。我们用 EOCPermittedDirection 来演示一下,假设按 NS_ENUM 方式将其展开:
1. typedef enum EOCPermittedDirection : int EOCPermittedDirection;
2. enum EOCPermittedDirection : int {
3. EOCPermittedDirectionUp = 1 << 0,
4. EOCPermittedDirectionDown = 1 << 1,
5. EOCPermittedDirectionLeft = 1 << 2,
6. EOCPermittedDirectionRight = 1 << 3,
7. };
然后考虑下列代码:
1. EOCPermittedDirection permittedDirections =
2. 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 来定义。
8、最后再讲一种枚举的用法,就是在switch语句里。有时可以这样定义:
1. typedef NS_ENUM(NSUInteger, EOCConnectionState) {
2. EOCConnectionStateDisconnected,
3. EOCConnectionStateConnecting,
4. EOCConnectionStateConnected,
5. };
6.
7. switch (_currentState) {
8. EOCConnectionStateDisconnected:
9. // Handle disconnected state
10. break;
11. EOCConnectionStateConnecting:
12. // Handle connecting state
13. break;
14. EOCConnectionStateConnected:
15. // Handle connected state
16. break;
17. }
我们总习惯在 switch 语句中加上 default 分支。然而,若是用枚举来定义状态机(state machine),则最好不要有default分支。这样的话,如果稍后又加了一种状态,那么编译器就会发出警告信息,提示新加入的状态并未在switch分支中处理。假如写上了default分支,那么它就会处理这个新状态,从而导致编译器不发警告信息。用 NS_ENUM 定义其他枚举类型时也要注意此问题。例如,在定义代表 UI 元素样式的枚举时,通常要确保 switch 语句能正确处理所有样式。
要点
① 应该用枚举来表示状态机的状态、传递给方法的选项以及状态码等值,给这些值起个易懂的名字。
② 如果把传递给某个方法的选项表示为枚举类型,而多个选项又可同时使用,那么就将各选项值定义为 2 的幂,以便通过按位或操作将其组合起来。
③ 用 NS_ENUM 与 NS_OPTIONS 宏来定义枚举类型,并指明其底层数据类型。这样做可以确保枚举是用开发者所选的底层数据类型实现出来的,而不会采用编译器所选的类型。
④ 在处理枚举类型的 switch 语句中不要实现 default 分支。这样的话,加入新枚举之后,编译器就会提示开发者:switch 语句并未处理所有枚举。