ReactiveSwift源码解析(二) Bag容器的代码实现

今天博客我接着上篇博客的内容来，上篇博客我们详细的看了ReactiveSwift中的Observer已经Event的代码实现。接下来我们来看一下ReactiveSwift中的结构体Bag的实现。Bag：袋子，顾明思议，就是用来装东西的，我们暂且将Bag称之为容器。在ReactiveSwift中的Bag主要是用来存储Signal对象的，我们在后期介绍ReactiveSwift源码时会陆陆续续的看到Bag的身影。

因为Bag这个结构体在ReactiveSwift中比较独立，所以我们本篇博客就来聊一下Bag的具体实现。本篇博客我们会详细的介绍Bag的代码实现，并从Bag代码实现中看一下Swift语言本身的东西，并给出Bag的测试用例。当然，本篇博客我们还会涉及到“迭代器模式”，关于“迭代器模式”更详细的信息，请移步于之前发布的关于设计模式的博客《设计模式(十)：从电影院中认识"迭代器模式"(Iterator Pattern)》。

一、ContiguousArray

在博客的第一部分我们先来看一下ContiguousArray的相关内容。因为结构体Bag就是在ContiguousArray的基础上进行封装的，也就是说袋子中的元素最终是存放在ContiguousArray中的。在Swift中ContiguousArray与Array的用法差不多，下方是官方对ContiguousArray的介绍。

从下方我们可以清楚的知道ContiguousArray、Array还有ArraySlice的大部分属性和方法是共用的。但是在存储Class或者@objc 协议时，使用ContiguousArray效率会更高一些。但是ContiguousArray不能和Objective-C的NSArray进行桥接，并且不能将ContiguousArray传入到Objective-C的API中。

当然从ContiguousArray名字来看，它是占用连续存储空间的数组。具体请看下方的官方介绍。

　　

二、Bag的基本实现

下方是结构体Bag的基本实现，稍后还会介绍Bag的延展以及与其关联的BagElement类型。接下来我们来详细的看一下其实现。当然下方截图中的代码实现，是将ReactiveSwift中的英文注释给删了，添加了一些中文注释。这样看着更舒服一些。

1、RemovalToken

首先我们来看一下RemovalToken，以及看一下RemovalToken这个类在Bag结构体中所扮演的角色。从下方代码片段中我们不难看出，RemovalToken是一个空类，中该类的名字我们可以看出，该类的对象是充当Token用的。也就是说该类的对象可以作为Bag中所存储元素的唯一标示符，并且可以用来删除元素使用。

我们知道，每个类的对象都会有一个唯一的HashValue。其实在Bag中真正使用到的是RemovalToken的对象所对应的HashValue，这个稍后我们会聊到。

2.Bag的基本实现

从下方代码段中，我们可以看出Bag是以结构体的形式存在的，而且后边紧跟了一个Element的泛型类型。紧接着是类型为 ContiguousArray<BagElement<Element>> 的泛型数组，BagElement<Element>这个类型稍后会提到。

insert()方法负责插入元素，从代码实现来看其实就是向elements数组后方append元素，添加的元素类型为BagElement。inser()方法由@discardableResult进行修饰，说明insert()方法所返回的值可以被忽略，也就是说如果没有变量来接收insert()的返回值的话，程序并不会报出警告。而insert()前方的 mutating关键字一般用来修饰Swift中的枚举或者结构体中的方法，被mutating关键字修饰的方法就可以修改枚举或者结构体中的属性了。用法如下所示。

接下来我们来看一下remove()方法，该方法的参数是一个token,其功能就是通过token来删除元素。当然具体代码实现也是比较简单的，就是对elements数组进行遍历，找到元素的token与传入的token一致的话，我们就将其删除。具体实现如下所示。

　　

三、BagElement结构体的实现

接下来，我们来看一下Bag中所存储元素的类型BagElement的实现，代码如下所示。当然实现比较简单，BagElement也是一个泛型结构体，其泛型类型Value其实就是Bag的泛型类型Element。其中有两个属性，一个Value，用来存储值。另一个是token，用来存储该值对应的唯一标示。

紧接着是BagElement的的延展，用来输出描述信息的，如下所示。

　　

 

四、Bag的延展

接下来我们来看一下Bag的延展，代码如下所示。Bag的延展中的相关内容还是比较简单的。首先定义了一个Array<Element>.Index的类型别名Index，其实就是Int类型。然后是startIndex和endIndex两个计算属性，用来获取Bag的第一个元素的索引，和结束位置的索引。

subscript()方法是为Bag结构体添加自定义下标，使其支持下标访问元素的形式。makeIterator()方法则用来创建Bag<Element>所对应的迭代器。关于Bag的迭代器，稍后会进行介绍。

　　

 

五、Bag的迭代器

接下来我我们就来看一下Bag容器的迭代器，其实就是“迭代器模式”的具体应用。下方代码段就是Bag的迭代器的具体实现。从下方代码我们不难看出，BagIterator实现了Swift中的迭代器协议IteratorProtocol，然后给出了迭代器的next()方法的实现。下方我们将会对该迭代器进行测试。

　　

六、Bag的测试用例

下方代码片段中是对Bag的测试用例。首先我们初始化了一个Bag实例，然后指定其泛型类型为String。紧接着我们又创建了一个bagsTokens的数组，用来存储myBags中每个元素所对应的token，便于在移除元素时使用。最后是往myBags中添加值了。每添加一个值我们就记录一下该值所对应的token。

在添加完元素后，我们可以遍历输出一下每个token对象的HashValue。然后我们可以通过token来移除myBags中的元素。

最后我们可以从myBags中获取相应的迭代器，然后使用迭代器访问myBags中的元素。

　　

下方是对Bag中的Token以及Bag中的所有元素进行的输出，如下所示：

　　

今天博客就先到这儿，下篇博客会继续更新ReactiveSwift相关的东西。

上述代码github分享地址：https://github.com/lizelu/TipSwiftForRac