Swift 源码解读 - Sequence.swift

在 Map.swift 源码解读 中，多处涉及到 Sequence 的内容，今天抽时间来阅读下 Sequence.swift 的源码。

Sequence 协议

首先我们大概过一次 Sequence 协议的内容：

public protocol Sequence {
  /// 元素
  associatedtype Element

  /// 迭代器
  associatedtype Iterator : IteratorProtocol where Iterator.Element == Element

  /// 子序列
  associatedtype SubSequence : Sequence = AnySequence<Element>
    where Element == SubSequence.Element,
          SubSequence.SubSequence == SubSequence

  /// 返回当前迭代器
  func makeIterator() -> Iterator
 
  var underestimatedCount: Int { get }

  // 下面是 Sequence extension方法
  func map<T>(
    _ transform: (Element) throws -> T
  ) rethrows -> [T]
  func filter(
    _ isIncluded: (Element) throws -> Bool
  ) rethrows -> [Element]
  func forEach(_ body: (Element) throws -> Void) rethrows

  // 下面还有一大串的方法，但都是扩展方法，这里不一一列举了
}

Sequence 协议中，主要有两个参数， 一个是 Element，也即是 sequence 里的元素，别一个则是 Iterator（迭代器），Iterator 是实现 IteratorProtocol 协议并且迭代器的元素和 sequence 的元素是相同类型（Iterator.Element == Element）。

首先我们先看下 IteratorProtocol 源码：

public protocol IteratorProtocol {
  
  associatedtype Element

  mutating func next() -> Element?
}

IteratorProtocol 的核心是 next() 方法，这个方法在每次被调用时返回序列中的下一个值。当序列下一个值为空时，next() 应该返回 nil。这里我们自定义一个 iterator：

struct CustomIterator: IteratorProtocol {
    mutating func next() -> Int? {
        return 1
    }
}

var iter = CustomIterator()
print(iter.next())   // Optional(1)

首先这里先了解下关键字 mutating，在 swift 中，struct 和 enum 可以定义自己的方法，但是默认情况下，实例方法中是不可以修改值类型的属性，如果需要修改，则需要添加 mutating 关键字。上面的例子并没有修改类型的属性，所以说 mutating 可写也可以不写， xcode 默认提示是带上的。这里再来一个标准点的写法：

struct CustomIterator: IteratorProtocol {
    var num = 0
    mutating func next() -> Int? {
        num += 1
        if num == 10 {
            return nil
        }
        return num
    }
}

var iter = CustomIterator()
while let num = iter.next() {
    print(num)  // 1,2,3,4,5,6,7,8,9
}

大概了解 Iterator 之后，我们再回到 Sequence，我们如果需要自定义一个 sequence 时，其实只需要实现 makeIterator 方法就可以了，如：

struct CustomIterator: IteratorProtocol {
    var num = 0
    mutating func next() -> Int? {
        num += 1
        if num == 10 {
            return nil
        }
        return num
    }
}

struct CustomSequence: Sequence {
    func makeIterator() -> CustomIterator {
        return CustomIterator()
    }
}

let sequence = CustomSequence()
for item in sequence {
    print(item)   // 1,2,3,4,5,6,7,8,9
}

关于 Sequence 最基本的内容大概就是这一些了，而 Sequence 里面定义了一大串的方法，如果 map、dropFirst、dropLast 等等，Swift 中通过协议扩展的形式来实现，如果在自定义 sequence 时需要修改相应的方法，就需要我自己重写，如果无需修改，直接使用则可。这里不一一细说，建议有时间可以完整读下，欢迎交流学习。