在 Objective-C 2.0 中提供了快速枚举的语法,它是我们遍历集合元素的首选方法,因为它具有以下优点:
- 比直接使用
NSEnumerator
更高效; - 语法非常简洁;
- 如果集合在遍历的过程中被修改,它会抛出异常;
- 可以同时执行多个枚举。
那么问题来了,它是如何做到的呢?我想,你应该也跟我一样,对 Objective-C 中快速枚举的实现原理非常感兴趣,事不宜迟,让我们来一探究竟吧。
解析 NSFastEnumeration 协议
在 Objective-C 中,我们要想实现快速枚举就必须要实现 NSFastEnumeration 协议,在这个协议中,只声明了一个必须实现的方法:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
其中,结构体 NSFastEnumerationState
的定义如下:
1 2 3 4 5 6 |
|
说实话,刚开始看到这个方法的时候,其实我是拒绝的,原因你懂的。好吧,先不吐槽了,言归正传,下面,我们将对这个方法进行全方位的剖析:
首先,我们需要了解的最重要的一点,那就是这个方法的目的是什么?概括地说,这个方法就是用于返回一系列的 C 数组,以供调用者进行遍历。为什么是一系列的 C 数组呢?因为,在一个 for/in
循环中,这个方法其实会被调用多次,每一次调用都会返回一个 C 数组。至于为什么是 C 数组,那当然是为了提高效率了。
既然要返回 C 数组,也就意味着我们需要返回一个数组的指针和数组的长度。是的,我想你应该已经猜到了,数组的长度就是通过这个方法的返回值来提供的,而数组的指针则是通过结构体 NSFastEnumerationState
的 itemsPtr
字段进行返回的。所以,这两个值就一起定义了这个方法返回的 C 数组。
通常来说,NSFastEnumeration
允许我们直接返回一个指向内部存储的指针,但是并非所有的数据结构都能够满足内存连续的要求。因此,NSFastEnumeration
还为我们提供了另外一种实现方案,我们可以将元素拷贝到调用者提供的一个 C 数组上,即 stackbuf
,它的长度由参数 len
指定。
在本文的开头,我们提到了如果集合在遍历的过程中被修改的话,NSFastEnumeration
就会抛出异常。而这个功能就是通过 mutationsPtr
字段来实现的,它指向一个这样的值,这个值在集合被修改时会发现改变。因此,我们就可以利用它来判断集合在遍历的过程中是否被修改。
现在,我们还剩下 NSFastEnumerationState
中的 state
和 extra
字段没有进行介绍。实际上,它们是调用者提供给被调用者自由使用的两个字段,调用者根本不关心这两个字段的值。因此,我们可以利用它们来存储任何对自身有用的值。
揭密快速枚举的内部实现
说了这么多,感觉好像 NSFastEnumeration
是你设计的一样,你到底是怎么知道的呢?额,我说我是瞎猜的,你信么?好了,不开玩笑了。接下来,我们就一起来探究一下快速枚举的内部实现。假设,我们有一个 main.m
文件,其中的代码如下:
1 2 3 4 5 6 7 8 9 10 11 12 |
|
接着,我们使用下面的 clang 命令将 main.m
文件重写成 C++ 代码:
1
|
|
得到 main.cpp
文件,其中 main
函数的代码如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
|
如上代码所示,快速枚举其实就是用两层 do/while
循环来实现的,外层循环负责调用 - countByEnumeratingWithState:objects:count:
方法,获取 C 数组,而内层循环则负责遍历获取到的 C 数组。同时,我想你应该也注意到了它是如何利用 mutationsPtr
来检测集合在遍历过程中的突变的,以及使用 objc_enumerationMutation 函数来抛出异常。
正如我们前面提到的,在快速枚举的实现中,确实没有用到结构体 NSFastEnumerationState
中的 state
和 extra
字段,它们只是提供给 - countByEnumeratingWithState:objects:count:
方法的实现者自由使用的字段。
值得一提的是,我特意在 main.m
中加入了 continue
和 break
语句。因此,我们有机会看到了在 for/in
语句中是如何利用 goto 来实现 continue
和 break
语句的。
实现 NSFastEnumeration 协议
看到这里,我相信你对 Objective-C 中快速枚举的实现原理已经有了一个比较清晰地认识。下面,我们就一起来动手实现一下 NSFastEnumeration
协议。
我们前面已经提到了,NSFastEnumeration
在设计上允许我们使用两种不同的方式来实现它。如果集合中的元素在内存上是连续的,那么我们可以直接返回这段内存的首地址;如果不连续,比如链表,就只能使用调用者提供的 C 数组 stackbuf
了,将我们的元素拷贝到这个 C 数组上。
接下来,我们将通过一个自定义的集合类 Array
,来演示这两种不同的实现 NSFastEnumeration
协议的方式。注:完整的项目代码可以在这里找到。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
|
我已经在上面的代码中添加了必要的注释,相信你理解起来应该没有什么难度。不过,值得一提的是,在第二种方式的实现中,我们用到了 ARC 下不同所有权对象之间的相互转换,代码如下:
1 2 |
|
其实,这里面涉及到两次类型转换,第一次是从 __strong NSNumber *
类型转换到 __unsafe_unretained const id *
类型,第二次是从 __unsafe_unretained const id *
类型转换到 id __unsafe_unretained *
类型,更多信息可以查看 AutomaticReferenceCounting 中的 4.3.3 小节。
另外,我在前面的文章《ReactiveCocoa v2.5 源码解析之架构总览》中,已经有提到过,ReactiveCocoa 中的 RACSequence 类其实是实现了 NSFastEnumeration
协议的。因为 RACSequence
中的元素在内存上并不连续,所以它采用的是第一种实现方式。对此感兴趣的同学,可以去看看它的实现源码,这里不再赘述。
总结
本文从 NSFastEnumeration
协议的定义出发,解析了 - countByEnumeratingWithState:objects:count:
方法中的返回值以及各个参数的含义;接着,我们使用 clang -rewrite-objc
命令探究了快速枚举的内部实现;最后,通过一个自定义的集合类 Array
演示了两种实现 NSFastEnumeration
协议的方式,希望本文能够对你有所帮助。
参考链接
https://www.mikeash.com/pyblog/friday-qa-2010-04-16-implementing-fast-enumeration.html https://zh.wikipedia.org/wiki/Objective-C#.E5.BF.AB.E9.80.9F.E6.9E.9A.E4.B8.BE https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/Collections/Articles/Enumerators.html#//apple_ref/doc/uid/20000135-SW1