Swift Combine 通过包装基于 delegate 的 API 创建重复发布者从入门到精通十八

最新推荐文章于 2024-11-04 13:17:52 发布

AI架构师易筋

最新推荐文章于 2024-11-04 13:17:52 发布

阅读量983

点赞数 25

分类专栏： iOS 文章标签： swift 开发语言 ios combine

本文链接：https://blog.csdn.net/zgpeace/article/details/136133972

版权

iOS 专栏收录该内容

146 篇文章 19 订阅

订阅专栏

本文详细介绍了SwiftCombine从基础到进阶的内容，包括发布者、订阅者、操作符、生命周期管理，以及如何包装CoreLocationAPI，使用Future处理异步请求，处理网络受限和用户输入等。通过实例展示了如何在UIKit中集成和使用SwiftCombine进行开发。

摘要由CSDN通过智能技术生成

Combine 系列

1. 通过包装基于 delegate 的 API 创建重复发布者

目的: 将 Apple delegate API 之一包装为 Combine 管道来提供值。

Future 发布者非常适合包装现有代码以发出单个请求，但它不适用于产生冗长或可能无限量输出的发布者。

Apple 的 Cocoa API 倾向于使用对象/代理模式，你可以选择接收任意数量的不同回调（通常包含数据）。其中一个例子是在 CoreLocation 库中，提供了许多不同的数据源。

如果你想在管道中使用此类 API 之一提供的数据，你可以将对象包装起来，并使用 passthroughSubject 来暴露发布者。下面的示例代码显示了一个包装 CoreLocation 中 CLManager 的对象并通过 UIKit 的 ViewController 消费其数据的示例。
在这里插入图片描述

UIKit-Combine/LocationHeadingProxy.swift

import Foundation
import Combine
import CoreLocation

final class LocationHeadingProxy: NSObject, CLLocationManagerDelegate {

    let mgr: CLLocationManager  // 1
    private let headingPublisher: PassthroughSubject<CLHeading, Error>  // 2
    var publisher: AnyPublisher<CLHeading, Error>  // 3

    override init() {
        mgr = CLLocationManager()
        headingPublisher = PassthroughSubject<CLHeading, Error>()
        publisher = headingPublisher.eraseToAnyPublisher()

        super.init()
        mgr.delegate = self  // 4
    }

    func enable() {
        mgr.startUpdatingHeading()  // 5
    }

    func disable() {
        mgr.stopUpdatingHeading()
    }
    // MARK - delegate methods

    /*
     *  locationManager:didUpdateHeading:
     *
     *  Discussion:
     *    Invoked when a new heading is available.
     */
    func locationManager(_ manager: CLLocationManager, didUpdateHeading newHeading: CLHeading) {
        headingPublisher.send(newHeading)  // 6
    }

    /*
     *  locationManager:didFailWithError:
     *  Discussion:
     *    Invoked when an error has occurred. Error types are defined in "CLError.h".
     */
    func locationManager(_ manager: CLLocationManager, didFailWithError error: Error) {
        headingPublisher.send(completion: Subscribers.Completion.failure(error))  // 7
    }
}

CLLocationManager 作为 CoreLocation 的一部分，是被包装的核心。因为要使用该框架，它有其他方法需要被调用，因此我将它暴露为一个 public 的只读属性。这对于先请求用户许可然后使用位置 API 很有用，框架将该位置 API 暴露为一个在 CLLocationManager 上的方法。
使用一个具有我们要发布的数据类型的 private 的 PassthroughSubject 实例，来提供我们的类内部访问以转发数据。
一个 public 的属性 publisher 将来自上面的 subject 的发布者暴露给外部以供订阅。
其核心是将该类指定为 CLLocationManager 实例的代理，在该实例初始化的尾端进行设置。
CoreLocation API 不会立即开始发送信息。有些方法需要调用才能启动（并停止）数据流，这些方法被包装并暴露在此 LocationHeadingProxy 对象上。大多数发布者都设置为订阅并根据订阅驱动消费，因此这有点不符合发布者如何开始生成数据的规范。
在定义代理和激活 CLLocationManager 后，数据将通过在 CLLocationManagerDelegate 上定义的回调提供。我们为这个包装的对象实现了我们想要的回调，并在其中使用 passthroughSubject.send() 将信息转发给任何现有的订阅者。
虽然没有严格要求，但代理提供了 Error 上报回调，因此我们也将其包括在示例中通过 passthroughSubject 转发。

2. UIKit-Combine/HeadingViewController.swift

import UIKit
import Combine
import CoreLocation

class HeadingViewController: UIViewController {

    var headingSubscriber: AnyCancellable?

    let coreLocationProxy = LocationHeadingProxy()
    var headingBackgroundQueue: DispatchQueue = DispatchQueue(label: "headingBackgroundQueue")

    // MARK - lifecycle methods

    @IBOutlet weak var permissionButton: UIButton!
    @IBOutlet weak var activateTrackingSwitch: UISwitch!
    @IBOutlet weak var headingLabel: UILabel!
    @IBOutlet weak var locationPermissionLabel: UILabel!

    @IBAction func requestPermission(_ sender: UIButton) {
        print("requesting corelocation permission")
        let _ = Future<Int, Never> { promise in  // 1
            self.coreLocationProxy.mgr.requestWhenInUseAuthorization()
            return promise(.success(1))
        }
        .delay(for: 2.0, scheduler: headingBackgroundQueue) // 2
        .receive(on: RunLoop.main)
        .sink { _ in
            print("updating corelocation permission label")
            self.updatePermissionStatus()  // 3
        }
    }

    @IBAction func trackingToggled(_ sender: UISwitch) {
        switch sender.isOn {
        case true:
            self.coreLocationProxy.enable()  // 4
            print("Enabling heading tracking")
        case false:
            self.coreLocationProxy.disable()
            print("Disabling heading tracking")
        }
    }

    func updatePermissionStatus() {
        let x = CLLocationManager.authorizationStatus()
        switch x {
        case .authorizedWhenInUse:
            locationPermissionLabel.text = "Allowed when in use"
        case .notDetermined:
            locationPermissionLabel.text = "notDetermined"
        case .restricted:
            locationPermissionLabel.text = "restricted"
        case .denied:
            locationPermissionLabel.text = "denied"
        case .authorizedAlways:
            locationPermissionLabel.text = "authorizedAlways"
        @unknown default:
            locationPermissionLabel.text = "unknown default"
        }
    }

    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.

        // request authorization for the corelocation data
        self.updatePermissionStatus()

        let corelocationsub = coreLocationProxy
            .publisher
            .print("headingSubscriber")
            .receive(on: RunLoop.main)
            .sink { someValue in  // 5
                self.headingLabel.text = String(someValue.trueHeading)
            }
        headingSubscriber = AnyCancellable(corelocationsub)
    }

}

CoreLocation 的特点之一是要向用户请求访问数据的许可。启动此请求的 API 将立即返回，但即使用户允许或拒绝请求，它并不提供任何详细信息。 CLLocationManager 类包括信息，并在想要获取信息时将其作为类方法暴露给外部，但未提供任何信息来了解用户何时或是否响应了请求。由于操作不提供任何返回信息，我们将整数提供给管道作为数据，主要表示已发出请求。
由于没有明确的方法来判断用户何时会授予权限，但权限是持久的，因此在尝试获取数据之前，我们简单地使用了 delay 操作符。此使用只会将值的传递延迟两秒钟。
延迟后，我们调用类方法，并尝试根据当前提供的状态的结果更新界面中的信息。
由于 CoreLocation 需要调用方法来明确启用或禁用数据，因此将我们发布者 proxy 的方法连接到了一个 UISwitch 的 IBAction 开关上。
方位数据在本 sink 订阅者中接收，在此示例中，我们将其写到文本 label 上。