Assign

在 Combine 框架中，Assign 是一个特殊的 Subscriber，它可以将 Publisher 发布的值直接分配到对象的属性上。这个操作常用于将异步流的数据绑定到 UI 元素或其他对象的状态。

Assign 通常用于将 Publisher 发出的值自动赋值给指定的 KeyPath，使得它非常适合与 UI 组件（如标签、文本框、进度条等）进行绑定。

基本用法

Assign 允许你指定一个对象和一个属性（通过 KeyPath）来将 Publisher 发出的值赋给该属性。它会在每次接收到新值时更新该属性。

示例：将 Publisher 的值赋给 UI 组件

import Combine

class ViewModel {
    @Published var counter = 0
}

let viewModel = ViewModel()

// 创建一个Publisher，这里使用一个定时器作为例子
let publisher = Timer.publish(every: 1, on: .main, in: .common).autoconnect()
    .map { _ in Int.random(in: 0...100) }

// 使用Assign将publisher的值赋给viewModel的counter属性
let subscription = publisher
    .assign(to: \.counter, on: viewModel)

// 查看效果
DispatchQueue.main.asyncAfter(deadline: .now() + 5) {
    print("Final counter value: \(viewModel.counter)")
}

输出：

Final counter value: <随机数>

在这个示例中，Assign 将 publisher 发出的值自动赋给 viewModel.counter 属性。每秒钟，publisher 会发出一个随机数，Assign 会把这个随机数赋给 counter 属性。

Assign 初始化方法

Assign 有两种常用的初始化方法：

1. 将 Publisher 的值分配到对象的属性（KeyPath）

init<Root>(_ keyPath: KeyPath<Root, Output>, on object: Root) where Root: AnyObject

• keyPath: 要赋值的目标属性的 KeyPath，比如 \MyClass.property。

• object: 被赋值的对象，通常是一个 UIView 或者其他自定义的类。

1. 将 Publisher 的值分配到对象的属性，并支持处理错误

init<Root>(_ keyPath: KeyPath<Root, Output>, on object: Root) where Root: AnyObject

示例：将错误值分配给对象的属性

import Combine

enum MyError: Error {
    case somethingWentWrong
}

class MyObject {
    var statusMessage: String = "OK"
}

let myObject = MyObject()

let publisher = Future<String, MyError> { promise in
    // Simulating an error
    promise(.failure(.somethingWentWrong))
}

let subscription = publisher
    .map { result in "Success: \(result)" }
    .catch { error -> Just<String> in
        Just("Error: \(error)")  // 提供一个默认值来处理错误
    }
    .assign(to: \.statusMessage, on: myObject)

print(myObject.statusMessage)  // Output: Error: somethingWentWrong

重要的注意事项

• Assign 是 只写的 订阅者，这意味着它仅仅是为了将值赋给对象的属性，不能接收来自 Publisher 的其他事件（如完成或错误）。

• 如果你在使用 Assign 时，目标对象或属性是 nil 或者不可用，Assign 会自动忽略更新。

常见使用场景

1. UI 更新： 当你需要将模型的数据绑定到界面控件（如 UILabel, UITextField, UIProgressView 等）时，Assign 是一个非常简单且有效的解决方案。

2. 自动化状态更新： 将从网络请求或其他异步操作获取的结果自动赋给类的属性，自动更新视图或模型状态。

3. 简化代码： Assign 会自动处理值的赋值，而无需手动写下每一次值的更新代码。

结论

• Assign 是一个非常简洁而强大的工具，可以将来自 Publisher 的值直接赋给一个对象的属性，特别适用于 UI 组件的状态绑定。

• 它可以减少手动更新界面的代码，并使得响应式编程更加流畅和清晰。

• 由于 Assign 只关注赋值，它不会处理错误或完成事件，因此它并不适合处理需要更复杂错误处理的场景。