RxSwift Queue 队列的实现

在 RxSwift 的框架中,在 Queue.swift 文件中使用数组实现了一个队列(先进先出FIFO)。在操作次数达到 N 时,入栈和出栈的复杂度为 O(1),获取第一个出栈元素的复杂度也为 O(1)。

下面是根据源码,梳理的实现原理:

Queue 的内部使用数组 _storage 来保存队列中的元素,_storage 的初始容量在 Queue 的初始化方法中传入。

init(capacity: Int) {
    _initialCapacity = capacity
    _storage = ContiguousArray<T?>(repeating: nil, count: capacity)
}

随着元素进队列和出队列,数组 _storage 的容量可能会改变,所以用 _initialCapacity 来记录数组的初始化容量。

当有元素进入队列时,就从数组 _storage 的索引为 0 处向后保存。入队列的元素保存在数组 _storage 中的索引,使用属性 _pushNextIndex 来表示。当有元素出队列时,就从数组 _storage 的索引为 0 处向后获取,使用 dequeueIndex 属性来表示首先要出栈的元素在数组 _storage 中的索引。在元素入队列和出队列的过程中,使用属性 _count 来记录当前栈中元素的数量。

当有元素入队列时,如果队列中的元素数量 _count 小于数组 _storage 的容量 _storage.count,也就是说数组中还有空间可以继续存储新的队列元素。这时如果 _pushNextIndex 小于 _storage.count,则将 _pushNextIndex 不断增加,如果 _pushNextIndex 大于等于 _storage.count,则说明队列中有的元素已经出栈,在数组的开头处空出了位置,则将进入队列的索引 _pushNextIndex 指向数组的索引为 0 处,继续向后添加元素。
所以数组中的元素排布可能为以下两种情况:

  • dequeueIndex 在 _pushNextIndex 的左边,dequeueIndex = _pushNextIndex - _count
  • dequeueIndex 在 _pushNextIndex 的右边,dequeueIndex = _pushNextIndex + _storage.count - _count
元素在数组中的分布情况

所以 dequeueIndex 可以通过 _pushNextIndex 和 _count 推导出,代码如下:

private var dequeueIndex: Int {
    let index = _pushNextIndex - count
    return index < 0 ? index + _storage.count : index
}

当有元素进入队列时,如果队列中的元素数量 _count 等于数组 _storage 的容量(_storage.count)时,也就是说数组中已经存满了队列的元素,这时就需要一个更大的数组来存放队列元素。新的数组的容量通过原来数组的容量(数组的容量大于0时)乘以系数 _resizeFactor 计算获得。

// 元素进入队列的方法
mutating func enqueue(_ element: T) {
    // _storage 存储满了
    if count == _storage.count {
        // 将数组容量扩充至 Swift.max(_storage.count, 1) * _resizeFactor
        resizeTo(Swift.max(_storage.count, 1) * _resizeFactor)
    }
    
    _storage[_pushNextIndex] = element
    _pushNextIndex += 1
    _count += 1
    
    // _pushNextIndex 大于 _storage.count,将 _pushNextIndex 指向数组的开头
    if _pushNextIndex >= _storage.count {
        _pushNextIndex -= _storage.count
    }
}

怎样对保存队列元素的数组进行扩容呢?分成两步:

  1. 创建一个容量合适的新数组
  2. 将原来数组中的元素复制到新的数组中。

创建新的数组简单,我们应该怎样将原来数组中的元素拷贝到新的数组中。我们再次看队列元素在数组中的可能出现的分布情况:

元素在数组中的分布情况

可以将数组中的元素分成两块,第一块是出栈位置 dequeueIndex 到数组末尾的元素,第二块是数组开头到队列的结尾的元素。

第一种情况:这种情况的第二块的元素个数为0。

第二种情况

接下来计算两块的元素的数量。计算数组容量和出栈的位置 dequeueIndex 之间的间隔 spaceToEndOfQueue,则第一块的元素个数为 spaceToEndOfQueue 和 _count 中较小的一个,用 countElementsInFirstBatch 表示。第二块的元素个数为元素的个数 _count 减去 countElementsInFirstBatch 的数量,用 numberOfElementsInSecondBatch 表示。
接下来,只需要将第一段内的元素拷贝至新元素的开头,将第二段拷贝至新数组中第一段元素的末尾。

// 1.
mutating private func resizeTo(_ size: Int) {
    // 申请新数组
    var newStorage = ContiguousArray<T?>(repeating: nil, count: size)
    // 拷贝原来的元素到新的数组
    let count = _count
    let dequeueIndex = self.dequeueIndex
    let spaceToEndOfQueue = _storage.count - dequeueIndex

    // first batch is from dequeue index to end of array
    // 第一段为 dequeue 的索引到数组的末尾
    let countElementsInFirstBatch = Swift.min(count, spaceToEndOfQueue)
    // second batch is wrapped from start of array to end of queue
    // 第二段为数组的开始到队列的末尾
    let numberOfElementsInSecondBatch = count - countElementsInFirstBatch

    newStorage[0 ..< countElementsInFirstBatch] = _storage[dequeueIndex ..< (dequeueIndex + countElementsInFirstBatch)]
    newStorage[countElementsInFirstBatch ..< (countElementsInFirstBatch + numberOfElementsInSecondBatch)] = _storage[0 ..< numberOfElementsInSecondBatch]
    
    _count = count
    _pushNextIndex = count
    _storage = newStorage
}

在元素出队列的过程中,可能会出现数组中的容量远远大于队列中元素的数量,这时为了减少占用的内存空间,则需要缩小数组的大小。所以在有元素出队列时,需要根据条件判断是否需要缩小数组的大小。如果需要调整数组容量,则申请一个新的小容量数组,再将元素拷贝至新的数组中。将数组容量调小的方法和将数组调大的方法相同(都是通过调用 resizeTo(_) 方法)。

// 出栈
private mutating func dequeueElementOnly() -> T {
    precondition(count > 0)
    
    let index = dequeueIndex

    defer {
        _storage[index] = nil
        _count -= 1
    }

    return _storage[index]!
}

/// Dequeues element or throws an exception in case queue is empty.
///
/// - returns: Dequeued element.
mutating func dequeue() -> T? {
    if self.count == 0 {
        return nil
    }

    defer {
        // 判断是否需要调整数组容量
        let downsizeLimit = _storage.count / (_resizeFactor * _resizeFactor)
        if _count < downsizeLimit && downsizeLimit >= _initialCapacity {
            resizeTo(_storage.count / _resizeFactor)
        }
    }

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 一、基础知识:1、JVM、JRE和JDK的区别:JVM(Java Virtual Machine):java虚拟机...
    杀小贼阅读 2,369评论 0 4
  • 时间:20151130 晚文:本慈---正文: 书中所属章节:第三章:蹒跚学步(1993-1995) 片段一:发展...
    本慈阅读 1,954评论 0 1
  • 竹枝词 臭豆腐 小车载满几只缸, 游走村落与镇乡。 不上台面穷人菜, 美食名曰大青方。
    老爸的杂拌儿糖阅读 635评论 17 47
  • 2017年5月9日 一天,小明跟小黄说,他能够分辨出可口可乐和百事可乐。小黄第一反应就是不信,因为他觉得可口可乐和...
    晓健周阅读 16,187评论 0 7