Combine 是 Swift 在 2019 年推出的一个框架,它提供了声明式的 API,用来处理随时间而变化的值。
它的主要概念分为两大类:Publisher、Subscriber。下面就来详细介绍一下这两种类型。
Publisher
Publisher 即发布者。当上游的值发生改变的时候,它负责对值进行处理(处理值的这一过程由 Operator 来实现),然后再下发给下游(下游即 Subscriber)。
下面是它的源码:
public protocol Publisher<Output, Failure> {
associatedtype Output
associatedtype Failure : Error
func receive<S>(subscriber: S) where S : Subscriber, Self.Failure == S.Failure, Self.Output == S.Input
}
首先,可以看到 Publisher 是一个协议。它有两个泛型参数:Output 代表输出的数据,Failure 代表失败。
它还有一个 receive 的函数,用来接受一个对象。该对象要遵守 Subscriber 协议,且该对象的 Failure 要与 Publisher 的 Failure 类型一致;该对象的 Input 类型要与 Publisher 的 Output 类型一致。
Tips:Publisher 的 extension 还有许多关于 Operator 的实现,代码太多就不放上来了,这块放到专门讲 Operator 的地方讲。
介绍完 Publisher,接下来就轮到 Subscriber 了。
Subscriber
Subscriber 即接受者。它接受 Publisher 传递过来的值。下面是它的源码:
public protocol Subscriber<Input, Failure> : CustomCombineIdentifierConvertible {
associatedtype Input
associatedtype Failure : Error
func receive(subscription: Subscription)
func receive(_ input: Self.Input) -> Subscribers.Demand
func receive(completion: Subscribers.Completion<Self.Failure>)
}
它与 Publisher 一样,也是一个协议。有两个泛型参数:Input 和 Failure。
Input 用来接受上游传递的值,Failure 用来接受上游传递的错误。
它还有三个函数,用来进行 Subscriber 和 Publisher 之间的交互。
基本使用
假设,我们现在在做一个从网络加载数据,UI 显示的需求。首先,我们要导入该框架:
import Combine
接着定义一个数据加载完毕的通知名字,定义一个接受网络数据的结构体,定义一个展示数据的标签:
extension Notification.Name {
static let dataLoaded = Notification.Name("data_loaded")
}
struct Item {
let title: String
}
private let titleLabel = UILabel()
声明一个 publisher 的对象,声明一个 subscriber 的对象,再将两个对象绑定:
let publisher = NotificationCenter.Publisher(center: .default, name: .dataLoaded)
let subscriber = Subscribers.Assign(object: self.titleLabel, keyPath: \.text)
publisher.subscribe(subscriber)
上面的代码你会发现编译报错,原因就是 publisher 的 Output 和 subscribe 的 Input 类型不一致。这个需要借助 operator 来进行类型转换:
let publisher = NotificationCenter.Publisher(center: .default, name: .dataLoaded)
.map { noti -> String? in
return (noti.object as? Item)?.title
}
最后,我们通过 touchesBegan 来模拟网络数据加载完成:
override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
let data = Item(title: "我是一个标题")
NotificationCenter.default.post(name: .dataLoaded, object: data)
print(titleLabel.text ?? "")
}
运行项目,点击屏幕之后,就可以看到调试区打印:我是一个标题。
代码优化
上面的声明 subscriber 与 publisher 进行绑定的代码可以替换成下面的代码:
let subscriber = Subscribers.Assign(object: self.titleLabel, keyPath: \.text)
publisher.subscribe(subscriber)
// 替换为
private var cancel: AnyCancellable?
self.cancel = publisher.assign(to: \.text, on: self.titleLabel)
assign 操作符的作用就是将 publisher 的值赋值给绑定对象的属性。
需要注意的是:使用 assign 必须使用 AnyCancellable 类型的对象引用,否则不起作用。
当我们不需要 Subscribe 的时候,需要调用 cancel() 将内存释放掉。