Swift 中的 Sequence(一)

Swift 是一门可以让你按照自己喜欢的方式写代码的语言,它有很强的扩展能力,而它众多的 Collection Protocols 则是这种扩展能力的提供者之一。

本文介绍一下 Sequence 和 Iterator 的基本概念,及如何实现一个 Sequence。

撰写本文时的 Swift 版本是 Swift 3.1。

Sequence

Sequence 是一系列相同类型的值的集合,并且提供对这些值的迭代能力。

迭代一个 Sequence 最常见的方式就是 for-in 循环,如下:

for element in someSequence {
    doSomething(with: element)
}

我们经常把 for-in 循环用在 Array、Dictioanry、Set 等数据结构上,因为他们都实现了 Sequence 协议。

Sequence 协议的定义:

protocol Sequence {
    associatedtype Iterator: IteratorProtocol
    func makeIterator() -> Iterator
}

Sequence 协议只有一个必须实现的方法 makeIterator()

makeIterator() 需要返回一个 Iterator,它是一个 IteratorProtocol 类型。

也就是说只要提供一个 Iterator 就能实现一个 Sequence,那么 Iterator 又是什么呢?

Iterator

Iterator 在 Swift 3.1 标准库中即为 IteratorProtocol,它用来为 Sequence 提供迭代能力。对于 Sequence,我们可以用 for-in 来迭代其中的元素,其实 for-in 的背后是 IteratorProtocol 在起作用。

IteratorProtocol 的定义如下:

public protocol IteratorProtocol {
    associatedtype Element
    public mutating func next() -> Self.Element?
}

其中仅声明了一个 next() 方法,用来返回 Sequence 中的下一个元素,或者当没有下一个元素时返回 nil
associatedtype 声明了元素的类型。

举个例子,创建一个动物的数组,对齐进行循环遍历:

let animals = ["Antelope", "Butterfly", "Camel", "Dolphin"]
for animal in animals {
    print(animal)
}
// 打印结果:
Antelope
Butterfly
Camel
Dolphin

实际上编译器会把以上代码转换成下面的代码:

var animalIterator = animals.makeIterator()
while let animal = animalIterator.next() {
    print(animal)
}
  1. 获取到 animals 数组的 Iterator
  2. 在一个 while 循环中,通过 Iterator 不断获取下一个元素,并对元素进行操作
  3. next() 返回 nil 时,退出循环

Iterator 实现举例

举例1:最简单的 Iterator

最简单的 Iterator 实现就是在 next() 中返回 nil,代码如下:

struct SimplestIterator: IteratorProtocol {
    typealias Element = Int
    mutating func next() -> Int? {
        return nil
    }
}

这时这个 Iterator 不会迭代出任何元素,确切的说,这个 Interator 在迭代时仅调用一次 next() 就结束了。

举例2:常量 Iterator

next() 返回一个值,也是一种简单的实现,例如下面代码:

struct ConstantIterator: IteratorProtocol {
    typealias Element = Int
    mutating func next() -> Int? {
        return 1
    }
}

上面这个例子实现了一个只返回 1 的 Iterator。

举例3:斐波那契数列 Iterator

再看一个复杂一点的例子,斐波那契数列的实现:

struct FibsIterator: IteratorProtocol {
    var state = (0, 1)
    mutating func next() -> Int? {
        let upcomingNumber = state.0
        state = (state.1, state.0 + state.1)
        return upcomingNumber
    }
}
  1. state 具有一个初始值 (0, 1),用元组表示
  2. 每次调用 next() 时,�返回 state 元组中的第一个元素,然后更新 state 为 (第二个元素的值,第一个元素 + 第二个元素的和)

在实现 Iterator 时可以省略 Element 的类型声明,Swift 会通过 next() 的返回值类型来自动推导出 Element 的类型。不过对于实现比较复杂的 Iterator,往往还是会加上类型声明这一句,提高代码可读性。

实现一个 Sequence

实现一个 Sequence 首先要实现一个 Iterator。

我们准备实现这样的一个 Iterator:它接收一个字符串数组,并可以迭代这个数组中所有字符串的首字母。
当数组中的最后一个字符串迭代完毕后,退出迭代。

代码如下:

struct FirstLetterIterator: IteratorProtocol {
    let strings: [String]
    var offset: Int
    
    init(strings: [String]) {
        self.strings = strings
        offset = 0
    }
    
    mutating func next() -> String? {
        guard offset < strings.endIndex else { return nil }
        let string = strings[offset]
        offset += 1
        return string.substring(to: string.index(string.startIndex, offsetBy: 1))
    }
}
  1. 这个 Iterator 的需要输入一个字符串数组
  2. �在 next() 中,判断边界,并返回�数组中索引为 offset 的字符串的首字母,并把 offset 加 1

这里省去了 Element 类型的声明,编译器可以根据 next() 的返回值类型推断出 Element 的类型。

有了已经实现好的 Iterator,就可以很简单的用它实现 Sequence,在 makeIterator() 中返回这个 Iterator 即可。

struct FirstLetterSequence: Sequence {
    let strings: [String]
    
    func makeIterator() -> FirstLetterIterator {
        return FirstLetterIterator(strings: strings)
    }
}

现在 Sequence 已经实现好了,可以测试一下效果。
我们可以创建一个 FirstLetterSequence,并用 for-in 循环对其迭代:

for letter in FirstLetterSequence(strings: ["apple", "banana", "orange"]) {
    print(letter)
}
/* 打印结果:
a
b
o
*/

结果为打印出了数组中每个字符串的首字母。

参考资料

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

推荐阅读更多精彩内容