用枚举表示状态、选项、状态码

由于Objective-C是源于C语言,所以C语言的功能它都有。其中一种就是枚举类型enum。系统框架中频繁用到此类型,然而开发者容易忽视它。在以一系列常量来表示错误状态码或可组合的选项时,极易使用枚举为其命名。由于C++11标准扩充了枚举的特性,所以最新系统框架用了“强类型”(strong type)的枚举。没错,Objective-C也得益于C++11标准。
枚举只是一种常量命名方式。某个对象所经历的各种状态就可以定义为简单的一个枚举集(enumeration set)。比如说可以用下列枚举来表示“套接字连接”(socket connection)的状态:

enum EOCConnectionState {
    EOCConnectionStateDisConnected,
    EOCConnectionStateConnecting,
    EOCConnectionStateConnected,
};

由于每种状态都用一个便于理解的值来表示,所以这样写的代码更易读懂。编译器会为枚举分配一个独有的编号,从0开始,每个枚举递增1。实现枚举所用的数据类型取决于编译器,不过其二进制位(bit)的个数必须能完全表示下枚举编号才行。在前列中,由于最大编号是2,所以使用1个字节的char类型即可。
然而定义枚举变量的方式却不太简洁,需依赖如下语法

enum EOCConnectionState state = EOCConnectionStateDisConnected;

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

enum EOCConnectionState {
    EOCConnectionStateDisConnected,
    EOCConnectionStateConnecting,
    EOCConnectionStateConnected,
};
typedef enum EOCConnectionState EOCConnectionState;

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

EOCConnectionState state= EOCConnectionStateDisConnected;

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

enum EOCConnectionStateConnectionState : NSInteger { /* ··· */ }

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

enum EOCConnectionStateConnectionState : NSInteger

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

enum EOCConnectionStateConnectionState {
    EOCConnectionStateDisConnected = 1,
    EOCConnectionStateConnecting,
    EOCConnectionStateConnected,
}

上述代码把EOCConnectionStateDisConnected的值设为1,而不使用编译器所分配的0。如上所述,那么接下来的枚举值都会在上一个的基础上递增1,比如说EOCConnectionState-Connected的值就是3。
还有一种情况应使用枚举类型,那就是定义选项的时候。若这些选项可以彼此组合,那更应该如此。只要枚举定义的对,各选项之间就可以通过“按位或操作符”(bitwise OR operator)来组合。例如,IOS UI框架下有如下枚举类型,用来表示某个视图应该如何在水平或垂直方向上调整大小。

enum UIViewAutoresizing {
    UIViewAutoresizingNone                     = 0,
    UIViewAutoresizingFlexibleLeftMargin       = 1 << 0,
    UIViewAutoresizingFlexibleWidth            = 1 << 1,
    UIViewAutoresizingFlexibleRightMargin      = 1 << 2,
    UIViewAutoresizingFlexibleTopMargin        = 1 << 3,
    UIViewAutoresizingFlexibleHeight           = 1 << 4,
    UIViewAutoresizingFlexibleBottomMargin     = 1 << 5,
}

每个选项均可启用或禁用,使用上述方式来定义枚举值即可保证这一点,因为在每个枚举值所对应的二进制表示中,只有一个二进制位的值是1。用“按位或操作符”可组合多个选项。例如UIViewAutoResizingFlexibleWidth | UIViewAutoResizingFlexbleHeight。

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

-  (void)supportedInterfaceOrientations{
    return UIInterfaceOrientationMaskPortrait | UIInterfaceOrientationMaskLandscapeLeft;
}

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

typedef NS_ENUM (NSUInteger, EOCConnectionState) {
    EOCConnectionStateDisConnected,
    EOCConnectionStateConnecting,
    EOCConnectionStateConnected,
};
typedef NS_OPTIONS (NSUInteger, EOCPermittedDirection) {
    EOCPermittedDirectionUp      =  1 << 0,
    EOCPermittedDirectionDown    =  1 << 1,
    EOCPermittedDirectionRight   =  1 << 2,
    EOCPermittedDirectionLeft    =  1 << 3,
};

这些宏定义如下:

#if ((__cplusplus && __cplusplus >= 201103L && (__has_extension(cxx_strong_enums) || __has_feature(objc_fixed_enum))) || (!__cplusplus && __has_feature(objc_fixed_enum))) && __has_attribute(ns_error_domain)
#define __NS_NAMED_ERROR_ENUM(_domain, _name)     enum _name : NSInteger _name; enum __attribute__((ns_error_domain(_domain))) _name : NSInteger
#define __NS_ANON_ERROR_ENUM(_domain)             enum __attribute__((ns_error_domain(_domain))) : NSInteger
#else
#define __NS_NAMED_ERROR_ENUM(_domain, _name) NS_ENUM(NSInteger, _name)
#define __NS_ANON_ERROR_ENUM(_domain) NS_ENUM(NSInteger)
#endif

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

typedef enum EOCConnectionState :NSUInteger EOCConnectionState;
enum EOCConnectionState : NSUInteger {
    EOCConnectionStateDisConnected,
    EOCConnectionStateConnecting,
    EOCConnectionStateConnected,
};

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

typedef enum EOCPermittedDirection :int EOCPermittedDirection;
enum  EOCPermittedDirection :int {
    EOCPermittedDirectionUp     = 1 << 0,
    EOCPermittedDirectionDown   = 1 << 1,
    EOCPermittedDirectionLeft   = 1 << 2,
    EOCPermittedDirectionRight  = 1 << 3,
};

然后考虑下列代码:

EOCPermittedDirection permittedDirections = EOCPermittedDirectionLeft | EOCPermittedDirectionUp

若编译器按照C++模式编译(也可能是按照Objective-C++模式编译),则会给出下列错误信息:

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

若想编译这行代码,就要将按位或操作的结果“显示转换”(explicit cast)为EOCPermittedDirection,所以在C++模式下应该用另一种方式定义NS_OPTIONS宏,以便省去类型转换操作。鉴于此,凡是需要以按位或操作组合的枚举都应使用NS_OPTIONS来定义。如枚举不需要互相组合,则需要使用NS_ENUM来定义。
能用到枚举的情况还有很多。前面已经提到,枚举可以表示选项与状态,然而还有许多东西能有枚举来表示。比如状态码就是个好例子。可以把逻辑含义相似的人一组状态码放入同一个枚举集里,而不要用#define预处理指令或者常量来定义。以枚举来表示“样式”(style)也很适宜。假如创建某个UI元素时可以使用不同样式,那么在这种情况下最应该把样式声明为枚举类型了。
最后再讲一种枚举用法,就是在switch语句里,有时可以这样定义:

typedef NS_ENUM (NSUInteger, EOCConnectionState) {
    EOCConnectionStateDisConnected,
    EOCConnectionStateConnecting,
    EOCConnectionStateConnected,
}

switch (_currentState) {
    EOCConnectionStateDisConnected :
       //handle disConnected state
        break;
    EOCConnectionStateConnecting :
       //handle connecting state
        break;
    EOCConnectionStateDisConnected :
       //handle connected state
        break;
}

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

要点:

应使用枚举来表示状态机的状态,传递给方法的选项,状态码等值,给这些值七个易懂的名字

如果把传递给某个方法的选项表示为枚举类型,而多个选项又可以同时使用,那么将个选值定义为2的幂,以便通过按位或操作将其组合起来。

用NS_ENUM与NS_OPTIONS宏来定义枚举类型。并指明底层数据类型。这样做可以确保枚举使用开发者所选的底层数据类型实现出来的,而不会采用编译器所选的类型。

在处理枚举类型的switch语句中,不要实现default分支。这样的话,加入新枚举,编译器就会提示开发者,switch语句并未处理所有枚举

此文章是读《Effective Objective-C 2.0 编写高质量iOS与OS X代码的52个有效方法》学习笔记:
第五条:多用类型常量,少用#define预处理指令

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容