MK
摩柯社区 - 一个极简的技术知识社区
AI 面试

Objective-C关联枚举（NS_ENUM与NS_OPTIONS）

2021-07-054.3k 阅读

一、Objective-C 中的枚举概念基础

在 Objective-C 编程中，枚举（Enumeration）是一种用户自定义的数据类型，它允许我们定义一组命名的整型常量。传统的 C 风格枚举在 Objective-C 中同样可用，其基本语法如下：

typedef enum {
    Monday,
    Tuesday,
    Wednesday,
    Thursday,
    Friday,
    Saturday,
    Sunday
} Weekday;

在上述代码中，我们定义了一个名为 Weekday 的枚举类型。枚举成员 Monday 到 Sunday 实际上是整型常量，默认情况下，Monday 的值为 0，后续成员的值依次递增 1。也就是说，Tuesday 的值为 1，Wednesday 的值为 2，以此类推。

我们可以像使用其他数据类型一样使用这个枚举类型，例如定义变量：

Weekday today = Wednesday;
if (today == Wednesday) {
    NSLog(@"It's Wednesday!");
}

然而，传统的 C 风格枚举存在一些局限性。例如，当在 Objective-C 的面向对象编程环境中使用时，它缺乏一些与对象相关的特性和安全性。这就引出了 NS_ENUM 和 NS_OPTIONS，它们是在 Foundation 框架中定义的宏，为枚举提供了更多的功能和安全性。

二、NS_ENUM 详解

2.1 NS_ENUM 的定义与基本语法

NS_ENUM 是一个宏，用于定义一个类型安全的枚举。它的语法如下：

NS_ENUM(枚举类型, 枚举名称) {
    枚举成员1,
    枚举成员2,
    //...
    枚举成员N
};

其中，“枚举类型”通常是一个整型类型，如 NSInteger 或 NSUInteger，它指定了枚举成员的底层存储类型。“枚举名称”是我们为这个枚举定义的类型名，而大括号内则是枚举的各个成员。

例如，我们定义一个表示方向的枚举：

typedef NS_ENUM(NSInteger, Direction) {
    DirectionNorth,
    DirectionSouth,
    DirectionEast,
    DirectionWest
};

这里我们使用 NS_ENUM 定义了一个名为 Direction 的枚举，其底层存储类型为 NSInteger。默认情况下，DirectionNorth 的值为 0，DirectionSouth 的值为 1，依此类推。

2.2 NS_ENUM 的类型安全性

与传统 C 风格枚举相比，NS_ENUM 提供了更好的类型安全性。在传统 C 风格枚举中，由于枚举值本质上是整型，所以可以很容易地将一个不相关的整型值赋给枚举变量，而编译器不会发出警告。例如：

typedef enum {
    ColorRed,
    ColorGreen,
    ColorBlue
} Color;

Color myColor = 100; // 编译器不会报错，但 100 并非我们定义的颜色枚举值

而使用 NS_ENUM 时，这种赋值会更加严格。假设我们有如下代码：

typedef NS_ENUM(NSInteger, Color) {
    ColorRed,
    ColorGreen,
    ColorBlue
};

Color myColor = 100; // 编译器会发出警告，提示类型不匹配

这样就可以在编译阶段发现潜在的错误，提高代码的健壮性。

2.3 NS_ENUM 在方法参数和返回值中的应用

当我们在方法中使用枚举作为参数或返回值时，NS_ENUM 的类型安全性优势更加明显。例如，我们定义一个根据方向移动的方法：

@interface Mover : NSObject
- (void)moveInDirection:(Direction)direction;
@end

@implementation Mover
- (void)moveInDirection:(Direction)direction {
    switch (direction) {
        case DirectionNorth:
            NSLog(@"Moving north");
            break;
        case DirectionSouth:
            NSLog(@"Moving south");
            break;
        case DirectionEast:
            NSLog(@"Moving east");
            break;
        case DirectionWest:
            NSLog(@"Moving west");
            break;
        default:
            NSLog(@"Invalid direction");
    }
}
@end

在调用这个方法时，编译器会确保传入的参数是 Direction 枚举类型的值：

Mover *mover = [[Mover alloc] init];
[mover moveInDirection:DirectionEast]; // 正确调用
[mover moveInDirection:100]; // 编译器会报错，类型不匹配

2.4 NS_ENUM 与位运算（非位掩码场景）

虽然 NS_ENUM 主要用于定义普通的离散枚举值，但在某些情况下，我们可能会在枚举值上进行位运算。不过需要注意的是，这种用法在 NS_ENUM 中并非最佳实践，因为 NS_ENUM 定义的枚举值通常不是设计用于位掩码操作的。例如，我们定义一个表示动物类型的枚举：

typedef NS_ENUM(NSInteger, AnimalType) {
    AnimalTypeDog,
    AnimalTypeCat,
    AnimalTypeBird
};

如果我们尝试对这些枚举值进行位运算，如 AnimalType combined = AnimalTypeDog | AnimalTypeCat;，虽然语法上可能不会报错（因为枚举值本质是整型），但这种操作并没有实际意义，因为 AnimalTypeDog、AnimalTypeCat 和 AnimalTypeBird 是离散的类型，不应该进行位组合。

三、NS_OPTIONS 详解

3.1 NS_OPTIONS 的定义与基本语法

NS_OPTIONS 同样是一个宏，它专门用于定义可以进行位掩码操作的枚举。其语法与 NS_ENUM 类似：

NS_OPTIONS(枚举类型, 枚举名称) {
    枚举成员1 = 1 << 0,
    枚举成员2 = 1 << 1,
    //...
    枚举成员N = 1 << (N - 1)
};

这里的“枚举类型”同样通常是 NSInteger 或 NSUInteger。每个枚举成员的值都是通过位移动操作 1 << n 来定义的，这样每个枚举成员都对应一个唯一的位。例如，我们定义一个表示文件权限的枚举：

typedef NS_OPTIONS(NSUInteger, FilePermissions) {
    FilePermissionsRead = 1 << 0,
    FilePermissionsWrite = 1 << 1,
    FilePermissionsExecute = 1 << 2
};

在这个例子中，FilePermissionsRead 的值为 1（二进制 001），FilePermissionsWrite 的值为 2（二进制 010），FilePermissionsExecute 的值为 4（二进制 100）。

3.2 NS_OPTIONS 的位掩码操作

NS_OPTIONS 的主要目的是支持位掩码操作。位掩码允许我们通过位运算组合多个枚举值。例如，一个文件可能同时具有读取和写入权限，我们可以这样表示：

FilePermissions filePerms = FilePermissionsRead | FilePermissionsWrite;

这里通过按位或操作 | 将 FilePermissionsRead 和 FilePermissionsWrite 组合在一起，filePerms 的值为 3（二进制 011）。

我们还可以使用按位与操作 & 来检查某个权限是否存在：

if (filePerms & FilePermissionsRead) {
    NSLog(@"The file has read permission");
}

3.3 NS_OPTIONS 在方法参数和返回值中的应用

与 NS_ENUM 类似，NS_OPTIONS 定义的枚举在方法参数和返回值中也有重要应用。例如，我们定义一个设置文件权限的方法：

@interface FileManager : NSObject
- (void)setPermissions:(FilePermissions)permissions forFile:(NSString *)fileName;
@end

@implementation FileManager
- (void)setPermissions:(FilePermissions)permissions forFile:(NSString *)fileName {
    // 实际的权限设置逻辑
    NSLog(@"Setting permissions %lu for file %@", (unsigned long)permissions, fileName);
}
@end

在调用这个方法时，可以传入组合的权限值：

FileManager *fileMgr = [[FileManager alloc] init];
[fileMgr setPermissions:FilePermissionsRead | FilePermissionsWrite forFile:@"example.txt"];

3.4 NS_OPTIONS 与 NS_ENUM 的区别在实际应用中的体现

假设我们有一个场景，需要表示一个人的兴趣爱好。如果每个爱好是独立的，不能同时存在多个，那么使用 NS_ENUM 更合适：

typedef NS_ENUM(NSInteger, Hobby) {
    HobbyReading,
    HobbyPainting,
    HobbySwimming
};

但如果一个人可以有多个兴趣爱好，并且我们需要以一种紧凑的方式表示这些爱好的组合，那么 NS_OPTIONS 就更合适：

typedef NS_OPTIONS(NSUInteger, Hobbies) {
    HobbiesReading = 1 << 0,
    HobbiesPainting = 1 << 1,
    HobbiesSwimming = 1 << 2
};

然后我们可以这样表示一个人同时喜欢阅读和绘画：

Hobbies myHobbies = HobbiesReading | HobbiesPainting;

四、NS_ENUM 和 NS_OPTIONS 的内存占用与性能

4.1 内存占用

无论是 NS_ENUM 还是 NS_OPTIONS，它们的内存占用取决于所指定的底层存储类型。如果我们指定 NSInteger 作为底层类型，在 32 位系统上，NSInteger 是 4 字节（32 位），在 64 位系统上，NSInteger 是 8 字节（64 位）。如果使用 NSUInteger，情况也是类似的，只是它是无符号整型。

对于 NS_ENUM 定义的离散枚举，每个枚举变量在内存中占用的空间就是底层存储类型的大小。例如，对于上述 Direction 枚举，定义的 Direction 类型变量占用 NSInteger 大小的内存。

对于 NS_OPTIONS 定义的用于位掩码的枚举，虽然每个枚举成员通过位移动操作有不同的值，但实际用于存储位掩码组合的变量同样占用底层存储类型的大小。例如，FilePermissions 枚举类型的变量占用 NSUInteger 大小的内存，无论它表示的是单个权限还是多个权限的组合。

4.2 性能

在性能方面，NS_ENUM 和 NS_OPTIONS 本身并不会引入显著的性能开销。由于它们本质上是对传统枚举的封装，其性能主要取决于底层的整型操作。

对于 NS_ENUM，在进行比较等操作时，与传统枚举的性能基本相同。例如，在 switch 语句中匹配 NS_ENUM 枚举值，编译器可以进行优化，使得匹配过程效率较高。

对于 NS_OPTIONS，位运算操作（如按位或 |、按位与 & 等）在现代处理器上是非常高效的操作。因此，在处理位掩码相关的逻辑时，NS_OPTIONS 定义的枚举可以高效地进行组合和检查操作。

然而，需要注意的是，如果在代码中过度使用复杂的位掩码操作，可能会导致代码可读性下降，从而间接影响维护和开发效率。所以在实际应用中，需要在性能和代码可读性之间进行权衡。

五、在不同场景下选择 NS_ENUM 还是 NS_OPTIONS

5.1 离散值场景

当枚举值表示离散的、互斥的状态或选项时，应选择 NS_ENUM。例如，前面提到的表示一周中各天的 Weekday 枚举，一天只能是周一到周日中的某一天，不存在同时是两天的情况；再比如表示性别的枚举：

typedef NS_ENUM(NSInteger, Gender) {
    GenderMale,
    GenderFemale
};

这里 GenderMale 和 GenderFemale 是互斥的，只能选择其一，使用 NS_ENUM 是合适的选择。

5.2 可组合值场景

当枚举值需要支持组合，即可以同时存在多个选项时，应选择 NS_OPTIONS。除了前面提到的文件权限、兴趣爱好等例子外，还有比如表示 UI 视图的显示属性。一个视图可能同时具有可点击、可滚动、透明等多个属性，我们可以这样定义枚举：

typedef NS_OPTIONS(NSUInteger, ViewAttributes) {
    ViewAttributesClickable = 1 << 0,
    ViewAttributesScrollable = 1 << 1,
    ViewAttributesTransparent = 1 << 2
};

然后可以通过位运算组合这些属性：

ViewAttributes myViewAttrs = ViewAttributesClickable | ViewAttributesTransparent;

5.3 代码可读性与维护性考量

在选择 NS_ENUM 还是 NS_OPTIONS 时，代码的可读性和维护性也是重要因素。如果使用 NS_OPTIONS 进行复杂的位掩码操作，虽然在某些情况下可以实现高效的功能，但代码可能会变得难以理解和维护。例如，如果在代码中频繁出现类似 myFlags = myFlags & ~SomeOption; 这样的复杂位操作，对于不熟悉位运算的开发者来说，理解代码意图会比较困难。

因此，在保证性能的前提下，应优先选择使代码更易读、易维护的方式。如果离散值场景下使用了 NS_OPTIONS，虽然语法上可行，但会让代码的意图不清晰，因为 NS_OPTIONS 通常暗示可以进行位掩码组合。同样，如果可组合值场景下使用 NS_ENUM，则无法实现位掩码组合的功能，并且代码逻辑会变得复杂。

5.4 与其他 API 的兼容性

在实际开发中，还需要考虑与其他现有 API 的兼容性。如果项目中已经存在一些使用特定枚举方式（NS_ENUM 或 NS_OPTIONS）的 API，为了保持一致性，新定义的枚举也应尽量采用相同的方式。例如，如果项目中大部分关于权限相关的枚举都使用 NS_OPTIONS，那么新的权限相关枚举也使用 NS_OPTIONS，这样可以使代码风格统一，降低开发和维护成本。

六、在 iOS 开发中的常见应用场景

6.1 UI 控件相关枚举

在 iOS 开发中，UIKit 框架广泛使用了 NS_ENUM 和 NS_OPTIONS。例如，UIView 的 contentMode 属性，它定义了视图内容的显示模式，使用 NS_ENUM 来表示离散的模式选项：

typedef NS_ENUM(NSInteger, UIViewContentMode) {
    UIViewContentModeScaleToFill,
    UIViewContentModeScaleAspectFit,
    UIViewContentModeScaleAspectFill,
    //... 其他模式
};

这里每个模式是互斥的，视图只能采用一种内容显示模式。

而对于 UIButton 的 UIControlState，它表示按钮的各种状态，如正常、高亮、禁用等，使用 NS_OPTIONS 定义，因为按钮可以同时处于多种状态（例如，按钮可以同时处于禁用和高亮状态）：

typedef NS_OPTIONS(NSUInteger, UIControlState) {
    UIControlStateNormal       = 0,
    UIControlStateHighlighted  = 1 << 0,
    UIControlStateDisabled     = 1 << 2,
    //... 其他状态
};

6.2 动画相关枚举

在 iOS 动画开发中，CAAnimation 的 CAAnimationRepeatCount 相关的枚举使用 NS_ENUM 来表示动画的重复模式：

typedef NS_ENUM(NSInteger, CAAnimationRepeatCount) {
    kCAAnimationRepeatCountIndefinitely = HUGE_VALF,
    // 其他具体的重复次数相关枚举值
};

这里的重复模式是离散的，只能选择一种。

而 CAAnimation 的 CAAnimationTimingFunction，用于定义动画的时间函数，使用 NS_ENUM 表示不同的时间函数类型，如线性、ease-in、ease-out 等，也是离散的选项。

6.3 设备方向相关枚举

UIDevice 类中用于表示设备方向的枚举使用 NS_ENUM：

typedef NS_ENUM(NSInteger, UIDeviceOrientation) {
    UIDeviceOrientationUnknown,
    UIDeviceOrientationPortrait,
    UIDeviceOrientationPortraitUpsideDown,
    UIDeviceOrientationLandscapeLeft,
    UIDeviceOrientationLandscapeRight,
    //... 其他方向
};

设备在某一时刻只能处于一种方向，所以使用 NS_ENUM 来定义。

6.4 权限相关枚举

在处理设备权限时，如相机权限、麦克风权限等，通常使用 NS_OPTIONS 来表示权限的状态组合。例如，假设我们自定义一个表示应用多种权限状态的枚举：

typedef NS_OPTIONS(NSUInteger, AppPermissions) {
    AppPermissionsCamera = 1 << 0,
    AppPermissionsMicrophone = 1 << 1,
    AppPermissionsLocation = 1 << 2
};

这样可以方便地通过位运算来检查和设置应用的各种权限状态。

七、常见错误与注意事项

7.1 枚举值重复定义

无论是 NS_ENUM 还是 NS_OPTIONS，都不应该重复定义枚举值。例如：

// 错误示例
typedef NS_ENUM(NSInteger, ErrorCode) {
    ErrorCodeNotFound = 1,
    ErrorCodePermissionDenied = 2,
    ErrorCodeNotFound = 3 // 重复定义 ErrorCodeNotFound，编译器会报错
};

在实际开发中，这种错误可能在大型项目中由于多人协作或代码重构不彻底而出现，需要仔细检查枚举定义。

7.2 错误使用位运算

对于 NS_ENUM 定义的离散枚举，不应该进行位运算。例如：

typedef NS_ENUM(NSInteger, Fruit) {
    FruitApple,
    FruitBanana,
    FruitOrange
};

Fruit combinedFruits = FruitApple | FruitBanana; // 错误，NS_ENUM 不适合位运算，虽然语法可能不报错，但逻辑错误

这可能导致难以调试的逻辑错误，因为这种操作不符合 NS_ENUM 的设计初衷。

7.3 未正确初始化位掩码枚举

对于 NS_OPTIONS 定义的位掩码枚举，在初始化时应注意正确使用位运算。例如：

typedef NS_OPTIONS(NSUInteger, FeatureFlags) {
    FeatureFlagsOnline = 1 << 0,
    FeatureFlagsOffline = 1 << 1
};

FeatureFlags myFlags; // 未初始化
if (myFlags & FeatureFlagsOnline) { // 未初始化的变量进行位运算，结果未定义
    NSLog(@"Online feature is enabled");
}

正确的做法是在使用前先初始化 myFlags，例如 myFlags = FeatureFlagsOnline;。

7.4 与其他类型的隐式转换问题

虽然 NS_ENUM 和 NS_OPTIONS 提供了一定的类型安全性，但在某些情况下，仍可能会出现与其他类型的隐式转换问题。例如，将枚举值直接赋值给 NSNumber 时需要注意：

typedef NS_ENUM(NSInteger, Status) {
    StatusSuccess,
    StatusFailure
};

Status currentStatus = StatusSuccess;
NSNumber *statusNumber = @(currentStatus); // 正确，通过字面量语法进行转换

NSNumber *wrongNumber = [NSNumber numberWithInt:currentStatus]; // 虽然能编译通过，但这种方式不推荐，容易引发类型混淆

使用字面量语法 @(enumValue) 更加清晰和安全，而直接使用 numberWithInt: 方法可能会掩盖类型信息，导致在后续使用中出现潜在的类型错误。

八、总结 NS_ENUM 和 NS_OPTIONS 的关键要点

  1. 用途区别：NS_ENUM 用于定义离散的、互斥的枚举值，而 NS_OPTIONS 用于定义可进行位掩码操作、可组合的枚举值。
  2. 语法特点：NS_ENUM 和 NS_OPTIONS 语法类似，都需要指定底层存储类型和枚举名称，但 NS_OPTIONS 的枚举成员通常通过位移动操作 1 << n 来定义值，以支持位掩码操作。
  3. 类型安全性：两者都提供了一定的类型安全性，在方法参数和返回值使用时，编译器会检查类型匹配，减少错误发生的可能性。
  4. 内存与性能：内存占用取决于底层存储类型，性能方面，NS_ENUM 的离散值操作和 NS_OPTIONS 的位运算操作在现代处理器上都较为高效，但复杂的位掩码操作可能影响代码可读性。
  5. 场景选择：根据实际场景，如表示性别、星期几等离散状态选择 NS_ENUM，表示文件权限、视图属性等可组合状态选择 NS_OPTIONS，同时要考虑代码的可读性、维护性以及与现有 API 的兼容性。
  6. 注意事项：避免枚举值重复定义，不对位运算不适用的 NS_ENUM 进行位运算，正确初始化 NS_OPTIONS 位掩码枚举，注意与其他类型的隐式转换问题。

通过深入理解 NS_ENUM 和 NS_OPTIONS 的这些方面，开发者能够在 Objective-C 编程中更准确、高效地使用枚举，编写出健壮、可读且易于维护的代码。无论是在 iOS 开发还是其他基于 Objective-C 的项目中，合理运用这两种枚举定义方式都是提升代码质量的重要手段。在实际开发过程中，不断积累经验，根据具体需求灵活选择，将有助于打造出优秀的应用程序。同时，随着编程技术的不断发展和 Objective-C 语言的演进，对枚举的使用和理解也可能会有新的变化和要求，开发者需要持续关注和学习，以跟上技术的步伐。

希望以上详细的介绍和示例能帮助你全面掌握 Objective-C 中 NS_ENUM 和 NS_OPTIONS 的使用，在实际项目中能够运用自如，提升开发效率和代码质量。在日常开发中，多留意优秀开源项目中对枚举的使用方式，借鉴其经验，也能不断提升自己对这一重要编程概念的应用能力。