Combine 框架，從0到1 —— 1.核心概念

 

本文首發於 Ficow Shen's Blog，原文地址： Combine 框架，從0到1 —— 1.核心概念。

 

 

內容概覽

• 前言
• 核心概念
• RxSwift
• Combine
• 總結
• 參考內容

 

前言

 

未來已來，只是尚未流行！

響應式編程 這個名詞已經久負盛名，但是在實際項目中采用了響應式編程的公司其實不多。如果您有 iOS 開發經歷，那么您多半聽說過 RxSwift，而 Rx 源自微軟。提到Rx，往往也會提到源自微軟的 MVVM模式。不過，本文不會講解 MVVM。如果您對MVVM感興趣，推薦您閱讀：Combine + MVVM 如何構建易測試的 ViewModel？

由於 Combine 借鑒了 Rx 的思想，二者具有基本相同的特性，所以本文會同時討論這兩個大框架。

而且，如果有必要的話，我們可以通過學習開源的 RxSwift 源碼來了解 Combine 的工作原理。您甚至可以這么簡單粗暴的認為：Combine 就是蘋果官方的 RxSwift。😅

 

核心概念

 

簡而言之，Combine 和 Rx 都基於 觀察者模式，當一個對象的狀態發生改變時，所有依賴於它的對象都得到通知並被自動更新。

只不過，這些框架對這個模式進行了一點擴充，在被觀察者與觀察者之間引入了可選的轉換操作(操作符：Operators)。

 

采用響應式編程框架的優勢與劣勢：

優勢：

• 同時支持 一對一、一對多 觀察操作，比 代理、通知中心 易用；
• 常用的操作符可以極大地提高開發效率，如：map, flatMap, filter, reduce, throttle 等；
• 代碼更加優雅、代碼量更少；
• 搭配 MVVM 模式，可以寫出更容易測試的 ViewModel；

劣勢：

• 學習成本略高；
• 調試的難度會提高，有時候甚至需要去閱讀框架的源碼；
• 傳統的MVC模式無法發揮響應式編程框架的最大威力，需要為項目配備合適的架構模式，比如 MVVM；

 

RxSwift

 

在講解 Combine 之前，我想介紹一下 Rx 寶石圖，這個圖可以幫助我們更好地理解某個常用操作符的意圖。

下圖就是一張Rx寶石圖，箭頭線代表一個序列(sequence)，中間的方塊代表操作符(operator)。序列中的豎線代表結束，X代表錯誤。一個序列中可以發射無限個元素，當序列發射完成或者錯誤元素后，序列就不會再繼續發射任何元素。

如果所示，上方的序列(方塊上方的箭頭線)中有各種形狀的元素，經過中間的 flip 操作(方塊)轉換之后，下方的序列接收到了某些元素轉換后的結果。而中間的淡藍色元素在 flip 過程中發生了錯誤，導致了下方的序列接收到的是一個錯誤而不是正常的元素。由此，接收序列停止接收。

如果您感興趣的話，可以參考我的 這篇文章 來學習 RxSwift 以及 RxCocoa。

 

Combine

 

類型定義

如圖所示，這三個協議就是 Combine 的核心。Publisher 負責發布內容，Subscriber 負責接收內容，Subscription 作為中介，協調生產端和消費端的需求。

Publisher(發布者) 的源碼：

@available(OSX 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
public protocol Publisher {

    /// 這個發布者發布的值的類型
    associatedtype Output

    /// 這個發布者可能發布的錯誤的類型
    ///
    /// 如果這個發布者不發布錯誤，就用 `Never`
    associatedtype Failure : Error

    /// 在調用 `subscribe(_:)` 方法時，這個方法會被觸發，並連接指定的 `Subscriber 到這個發布者
    ///
    /// - SeeAlso: `subscribe(_:)`
    /// - Parameters:
    ///     - subscriber: 被連接到這個發布者上的訂閱者。連接后，訂閱者就可以開始接收值
    func receive<S>(subscriber: S) where S : Subscriber, Self.Failure == S.Failure, Self.Output == S.Input
}

Subscriber(訂閱者) 的源碼：

@available(OSX 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
public protocol Subscriber : CustomCombineIdentifierConvertible {

    /// 這個訂閱者要接收的值的類型
    associatedtype Input

    /// 這個訂閱者可能接收到的錯誤的類型
    ///
    /// 如果這個訂閱者不會接收到錯誤，使用 `Never`
    associatedtype Failure : Error

    /// 告知訂閱者成功訂閱了發布者，並且可以獲取發布項
    ///
    /// 使用收到的 `Subscription` 來向發布者請求內容
    /// - Parameter subscription: 訂閱，代表發布者和訂閱者之間的連接
    func receive(subscription: Subscription)

    /// 告知訂閱者，發布者已經發布了一個元素
    ///
    /// - Parameter input: 發布了的元素
    /// - Returns: 命令，指明訂閱者還期望接收多少元素
    func receive(_ input: Self.Input) -> Subscribers.Demand

    /// 告知訂閱者，發布者已經結束了發布，可能是正常結束，也可能是因為發生了錯誤
    ///
    /// - Parameter completion: 完成，指明發布結束是正常結束還是由於錯誤而結束
    func receive(completion: Subscribers.Completion<Self.Failure>)
}

Subscription(訂閱) 的源碼：

public protocol Subscription : Cancellable, CustomCombineIdentifierConvertible {
    /// 通知發布者，它可以向訂閱者發送一個或多個值
    func request(_ demand: Subscribers.Demand)
}

 

交互流程

1. Subscriber 被綁定到 Publisher 上；
2. Publisher 創建訂閱對象(subscription)，並將訂閱對象發送給 Subscriber；
3. Subscriber 通過訂閱對象將需求發送給 Publisher；
4. Publisher 根據需求，將內容發送給 Subscriber；
5. Subscriber 通過訂閱對象來向 Publisher 請求取消訂閱；
6. Publisher 向 Subscriber 發送完成內容；

 

實例

 

** 實例項目的 Github 倉庫地址： ** Ficow-Combine-SwiftUI

 

現在，讓我們使用 Combine 來寫一個發起網絡請求的示例：

class CombineDemo {

    var cancellable: AnyCancellable?

    func makeRequest() {
        let url = URL(string: "https://ficow.cn")!
        let dataTaskPublisher = URLSession.shared.dataTaskPublisher(for: url)

        cancellable = dataTaskPublisher.sink(
            receiveCompletion: { completion in
                // 發布結束的時候會被調用一次
                switch completion {
                case .failure(let error):
                    print(error)
                case .finished:
                    print("success")
                }
            }, receiveValue: { value in
                // 每次接收到發布者發送的值都會被調用一次
                // 因為發起的是網絡請求，所以這里只會被調用一次
                print(value.data)
                print(value.response)
            })
    }

}

dataTaskPublisher 是系統提供的方法，它會返回一個發布者（Publisher）。然后我們可以對這個 publisher 調用 sink（此處應翻譯為：接收）方法，以此創建一個基於閉包的訂閱者（Subscriber）。

sink 方法也有一個返回值，類型為 AnyCancellable，我們可以用這個值來取消訂閱。當這個值在內存中被銷毀時，訂閱也會被自動取消。所以，如果我們不希望這個訂閱在 makeRequest() 方法執行結束時停止，就要在實例中強引用這個 cancellable。

如果你想提前結束訂閱，可以對這個 cancellable 調用 cancel 方法：

cancellable?.cancel()

此時，我們還沒有用到操作符。現在，對上面的示例稍作調整：

        cancellable = dataTaskPublisher
            .delay(for: .seconds(2), scheduler: DispatchQueue.global()) // 在后台線程中去延時執行
            .receive(on: RunLoop.main) // 在主線程上接收發布的內容
            .sink(receiveCompletion: { completion in

如果使用傳統的GCD，這里的代碼就會變成兩個閉包：

        DispatchQueue.global().asyncAfter(deadline: .now() + 2) {
            // 發起網絡請求操作
            dataTask() { (response) in
                DispatchQueue.main.async {
                    // 切換到主線程
                }
            }
        }

可以看到，使用 Combine 之后，代碼變得簡潔優雅，非常清晰易懂！不過，如果只是這樣，也許還不夠過癮。

 

接下來，我們研究一下官方提供的一個基於 AppKit 的示例，我稍微做了一些處理以適應UIKit。如下所示：

class OfficialDemo {

    class MyViewModel {
        var filterString = ""
    }

    private let filterField = UITextField()
    private let myViewModel = MyViewModel()
    private var subscription: AnyCancellable?

    func bind() {
        subscription = NotificationCenter.default
            .publisher(for: UITextField.textDidChangeNotification, object: filterField)
            .map( { (($0.object as! UITextField).text ?? "") } )
            .filter( { $0.unicodeScalars.allSatisfy({CharacterSet.alphanumerics.contains($0)}) } )
            .debounce(for: .milliseconds(500), scheduler: RunLoop.main)
            .receive(on: RunLoop.main)
            .assign(to:\MyViewModel.filterString, on: myViewModel)
    }
}

 

bind 方法中的代碼完成了很多任務：

• 通過通知中心來訂閱輸入框 filterField 的 textDidChangeNotification 通知；
• 通過 map 將接收到的內容轉換為輸入框中的文本；
• 通過 filter 來過濾掉無效的文本內容，阻止內容繼續沿着訂閱鏈往后傳遞；
• 通過 debounce(for:scheduler:) 來控制內容往后傳遞的頻率（收到內容之后的500毫秒后執行后續操作，如果在這個時間段內收到了新內容，則重新計時500毫秒再執行后續操作）；
• 通過 receive(on:) 來指定執行后續操作的調度器（線程）；
• 通過 assign(to:on:) 來使用 keypath 為指定的對象賦值（每次收到內容就會執行一次）；

如果不使用 Combine，上面這一系列的任務可能需要寫非常多的代碼才能完成。而且代碼的組織結構將會變得很龐大，你可能需要寫很多方法來封裝這些操作。

 

如果您想學習非常詳細的用法，可以參考這個網頁的內容：Using Combine。

 

總結

 

學習 Combine 有一定的成本，但是這是非常值得的，因為它可以幫助你：

• 改善代碼質量、減小代碼量、提升工作效率；
• 更好地學習 SwiftUI，畢竟 SwiftUI 中需要大量使用 Combine 的特性；
• 更好地應用 MVVM 模式，這是蘋果的目標，當然也是我們的目標；
• 寫出更容易測試的代碼（聚焦於輸入與輸出）；

 

推薦繼續閱讀：Combine 框架，從0到1 —— 2.通過 ConnectablePublisher 控制何時發布

 

參考內容

 

Combine - Customize handling of asynchronous events by combining event-processing operators.
ReactiveX - An API for asynchronous programming with observable streams
RxSwift - Reactive Programming in Swift
Patterns - WPF Apps With The Model-View-ViewModel Design Pattern
Rx Marbles - Interactive diagrams of Rx Observables
Using Combine
Combine Essentials - Receiving and Handling Events with Combine