簡介
Combine是Apple在2019年WWDC上推出的一個新框架。該框架提供了一個聲明性的Swift API,用于隨時間處理值。這些值可以表示多種異步事件。
Publisher協議聲明了一種可以隨時間傳遞一系列值的類型。Operators根據從upstream publishers接受到的值采取行動,并重新發布這些值。
在publishers鏈的末尾,Subscriber在接收元素時對其進行操作。Publisher僅在Subscriber明確請求時才會發出值。
通過采用Combine,通過集中事件處理代碼并消除嵌套閉包和基于約定的回調等麻煩的技術,使代碼更易于閱讀和維護。
Combine 是基于泛型實現的,是類型安全的。它可以無縫地接入已有的工程,用來處理現有的 Target/Action、Notification、KVO、callback/closure 以及各種異步網絡請求。
在 Combine 中,有幾個重要的組成部分:
發布者:Publiser
訂閱者:Subscriber
操作符:Operator
Publisher
在 Combine 中,Publisher 相當于RxSwift中的 Observable,并且可以通過組合變換(Operator)重新生成新的 Publisher。
public protocol Publisher {
/// The kind of values published by this publisher.
associatedtype Output
/// The kind of errors this publisher might publish.
///
/// Use `Never` if this `Publisher` does not publish errors.
associatedtype Failure : Error
/// This function is called to attach the specified `Subscriber` to this `Publisher` by `subscribe(_:)`
///
/// - SeeAlso: `subscribe(_:)`
/// - Parameters:
/// - subscriber: The subscriber to attach to this `Publisher`.
/// once attached it can begin to receive values.
func receive<S>(subscriber: S) where S : Subscriber, Self.Failure == S.Failure, Self.Output == S.Input
}
在 Publisher 的定義中,Output 代表數據流中輸出的值,值的更新可能是同步,也可能是異步,Failure 代表可能產生的錯誤,也就是說 Pubslier 最核心的是定義了值與可能的錯誤。Publisher 通過 receive(subscriber:) 用來接受訂閱,并且要求 Subscriber 的值和錯誤類型要一致來保證類型安全。
看一個例子:
let justPubliser = Just("Hello")
justPubliser 會給每個訂閱者發送一個 "Hello" 消息,然后立即結束(這個數據流只包含一個值)。
Combine提供了一個 enum Publishers,包括:
struct Empty : 一個從不發布任何值的publisher,并且可以選擇立即完成。
struct Fail : 立即使用指定錯誤終止的publisher。
struct Once: 只有一次向每個訂閱者發布輸出然后完成的publisher,或者在沒有生成任何元素的情況下立即失敗的publisher。
struct Optional : 如果可選值具有值,則publisher僅向每個訂閱者發布一次可選值。
struct Sequence : 發布給定元素序列的publisher。
struct Deferred : 在運行提供的閉包之前等待訂閱的發布者,以便為新訂閱者創建發布者。
...
Subscriber
Subscriber相當于RxSwift中的Observer。
public protocol Subscriber : CustomCombineIdentifierConvertible {
/// The kind of values this subscriber receives.
associatedtype Input
/// The kind of errors this subscriber might receive.
///
/// Use `Never` if this `Subscriber` cannot receive errors.
associatedtype Failure : Error
/// Tells the subscriber that it has successfully subscribed to the publisher and may request items.
///
/// Use the received `Subscription` to request items from the publisher.
/// - Parameter subscription: A subscription that represents the connection between publisher and subscriber.
func receive(subscription: Subscription)
/// Tells the subscriber that the publisher has produced an element.
///
/// - Parameter input: The published element.
/// - Returns: A `Demand` instance indicating how many more elements the subcriber expects to receive.
func receive(_ input: Self.Input) -> Subscribers.Demand
/// Tells the subscriber that the publisher has completed publishing, either normally or with an error.
///
/// - Parameter completion: A `Completion` case indicating whether publishing completed normally or with an error.
func receive(completion: Subscribers.Completion<Self.Failure>)
}
可以看出,Publisher 在自身狀態改變時,調用 Subscriber 的三個不同方法(receive(subscription), receive(_:Input), receive(completion:))來通知 Subscriber。
這里也可以看出,Publisher 發出的通知有三種類型:
Subscription:Subscriber 成功訂閱的消息,只會發送一次,取消訂閱會調用它的 Cancel 方法來釋放資源
Value(Subscriber 的 Input,Publisher 中的 Output):真正的數據,可能發送 0 次或多次
Completion:數據流終止的消息,包含兩種類型:.finished 和 .failure(Error),最多發送一次,一旦發送了終止消息,這個數據流就斷開了,當然有的數據流可能永遠沒有終止
大部分場景下我們主要關心的是后兩種消息,即數據流的更新和終止。
Combine 內置的 Subscriber 有三種:
- Sink
- Assign
- Subject
Sink 是非常通用的 Subscriber,我們可以自由的處理數據流的狀態。
let once: Publishers.Once<Int, Never> = Publishers.Once(100)
let observer: Subscribers.Sink<Int,Never> = Subscribers.Sink(receiveCompletion: {
print("completed: \($0)")
}, receiveValue: {
print("received value: \($0)")
})
once.subscribe(observer)
Assign 可以很方便地將接收到的值通過 KeyPath 設置到指定的 Class 上(不支持 Struct)
class Student {
let name: String
var score: Int
init(name: String, score: Int) {
self.name = name
self.score = score
}
}
let student = Student(name: "Jack", score: 90)
print(student.score)
let observer = Subscribers.Assign(object: student, keyPath: \.score)
let publisher = PassthroughSubject<Int, Never>()
publisher.subscribe(observer)
publisher.send(91)
print(student.score)
publisher.send(100)
print(student.score)
一旦 publisher 的值發生改變,相應的,student 的 score 也會被更新。
PassthroughSubject 這里是 Combine 內置的一個 Publisher。
Subject
有些時候我們想隨時在 Publisher 插入值來通知訂閱者,在 Rx 中也提供了一個 Subject 類型來實現。Subject 通常是一個中間代理,即可以作為 Publisher,也可以作為 Subscriber。Subject 的定義如下:
public protocol Subject : AnyObject, Publisher {
/// Sends a value to the subscriber.
///
/// - Parameter value: The value to send.
func send(_ value: Self.Output)
/// Sends a completion signal to the subscriber.
///
/// - Parameter completion: A `Completion` instance which indicates whether publishing has finished normally or failed with an error.
func send(completion: Subscribers.Completion<Self.Failure>)
}
作為 Subscriber 的時候,可以通過 Publisher 的 subscribe(_:Subject) 方法訂閱某個 Publisher。
作為 Publisher 的時候,可以主動通過 Subject 的兩個 send 方法,我們可以在數據流中隨時插入數據。目前在 Combine 中,有三個已經實現對 Subject: AnySubject,CurrentValueSubject 和 PassthroughSubject 。
CurrentValueSubject : 包含單個值并且當值改變時發布新元素的subject
let a = CurrentValueSubject<Int, NSError>(1)
a.sink(receiveCompletion: {
print("11\($0)")
}, receiveValue: {
print("22\($0)")
})
a.value = 2
a.value = 3
a.send(4)
a.send(completion: Subscribers.Completion<NSError>.finished)
// a.send(completion: Subscribers.Completion<NSError>.failure(NSError(domain: "domain", code: 500, userInfo: ["errorMsg":"error"])))
a.value = 5
當subject send completion后(不管是finished還是failure),subject不再發出元素
PassthroughSubject與CurrentValueSubject類似,只是設置初始值,也不會保存任何值。
let a = PassthroughSubject<Int,NSError>()
a.sink(receiveCompletion: {
print("11\($0)")
}, receiveValue: {
print("22\($0)")
})
a.send(4)
a.send(completion: Subscribers.Completion<NSError>.finished)
// a.send(completion: Subscribers.Completion<NSError>.failure(NSError(domain: "domain", code: 500, userInfo: ["errorMsg":"error"])))
a.send(5)
AnyPublisher、AnySubscriber、AnySubject
通用類型,任意的 Publisher、Subscriber、Subject 都可以通過 eraseToAnyPublisher()、eraseToAnySubscriber()、eraceToAnySubject() 轉化為對應的通用類型。
let name = Publishers.Sequence<[String], Never>(sequence: ["1","2"]).eraseToAnyPublisher()
Cancellable
可以取消活動或操作的協議。
public protocol Cancellable {
/// Cancel the activity.
/// Calling `cancel()` frees up any allocated resources. It also stops side effects such as timers, network access, or disk I/O.
func cancel()
}
Operator
操作符是 Combine 中非常重要的一部分,通過各式各樣的操作符,可以將原來各自不相關的邏輯變成一致的(unified)、聲明式的(declarative)的數據流。
轉換操作符:
- map/mapError
- flatMap
- replaceNil
- scan
- setFailureType
過濾操作符:
- filter
- compactMap
- removeDuplicates
- replaceEmpty/replaceError
reduce 操作符:
- collect
- ignoreOutput
- reduce
運算操作符:
- count
- min/max
匹配操作符:
- contains
- allSatisfy
序列操作符:
- drop/dropFirst
- append/prepend
- prefix/first/last/output
組合操作符:
- combineLatest
- merge
- zip
錯誤處理操作符:
- assertNoFailure
- catch
- retry
時間控制操作符:
- measureTimeInterval
- debounce
- delay
- throttle
- timeout
其他操作符:
- encode/decode
- switchToLatest
- share
- breakpoint/breakpointOnError
- handleEvents
未完待續