Swift Combine — Subject Publishers（PassthroughSubject CurrentValueSubject）

news2024/12/23 17:36:22

本文主要介绍一下Subject，Subject 本身也是一个 Publisher，其定义如下：

public protocol Subject<Output, Failure> : AnyObject, Publisher {
	func send(_ value: Self.Output)
	func send(completion: Subscribers.Completion<Self.Failure>)
	func send(subscription: any Subscription)
}

从定义可以看到，Subject 暴露了三个 send 方法，外部调用者可以通过这些方法来主动地发布 output 值、failure 事件、 finished 事件以及subscription。

Combine 内置提供了两种常用的 Subject 类型，分别是 PassthroughSubject 和 CurrentValueSubject，下面来分别看一下。

PassthroughSubject

PassthroughSubject是Combine框架中的一种Subject具体类型，它不持有任何值，将自己接收到的任何值简单的传递给下游的Subscriber。

当我们要创建一个PassthroughSubject时，需要指定要发送的值的类型，然后使用send方法发送，任何的Subscriber都会收到这个值。因为它本身不持有值，所以如果下游没有Subscriber，那么这个值将废弃了。

  func testPassthroughSubjectPublisher() {

    let publish2 = PassthroughSubject<String, Error>()

    publish2.send("1")

    publish2
      .sink { completion in
        switch completion {
          case .finished:
            print("---> Finished")
          case .failure(let error):
            print("---> Error: \(error.localizedDescription)")
        }
      } receiveValue: { value in
        print("---> value is: \(value)")
      }
      .store(in: &cancellable)

    publish2.send("2")
    publish2.send(completion: .finished)

  }

上面代码中创建了PassthroughSubject实例publish2，并通过sink方法添加了订阅者，订阅后，随后通过send方法发送了2和.finished事件，sink方法中对应的输出都正常。但是在添加sink方法之前发送的send("1")没有任何输出，就像上面说的，发送的时候还没有任何订阅者，发送的值就直接抛弃了。

输出结果：

---> value is: 2
---> Finished

作为Subject的具体实现，PassthroughSubject提供了一种方便的方法，使现有的命令式代码适应Combine模型。

CurrentValueSubject

Currentvaluessubject是Combine框架中的一种Subject具体类型。它可以保存单个值，并在设置新值时向任何订阅者发布新值。
Currentvaluessubject在初始化的时候需要设置一个初始值。

let publisher = CurrentValueSubject<String, Error>("one")

当有订阅者订阅的时候会立即发送这个值。下面代码中当初始化CurrentValueSubjectViewModel的时候，则会直接输出“—> value is: one”

class CurrentValueSubjectViewModel: ObservableObject {

  init() {
    setUpPublisher()
  }

  func setUpPublisher() {
    let publisher = CurrentValueSubject<String, Error>("one")

    let cancelable = publisher
      .sink { completion in
        switch completion {
          case .finished:
            print("---> Finished")
          case .failure(let error):
            print("---> Error: \(error.localizedDescription)")
        }
      } receiveValue: { value in
        print("---> value is: \(value)")
      }
  }
}

下面代码中，在viewModel中实例化了一个CurrentValueSubject，并添加了subscriber，在SwiftUI界面添加了三个按钮，用来发送数据。

在发送数据的时候，可以通过send方法，也可以通过直接设置value的方法，效果都是一样的。

class CurrentValueSubjectViewModel: ObservableObject {
  private var cancellable = Set<AnyCancellable>()
  let publisher = CurrentValueSubject<String, Error>("one")

  init() {
    setUpPublisher()
  }

  func setUpPublisher() {
    publisher
      .sink { completion in
        switch completion {
          case .finished:
            print("---> Finished")
          case .failure(let error):
            print("---> Error: \(error.localizedDescription)")
        }
      } receiveValue: { value in
        print("---> value is: \(value)")
      }
      .store(in: &cancellable)
  }

  func sendMessage() {
    publisher.send("Hello World")
    publisher.value = "Swift Combine"
  }

  func sendError() {
    publisher.send(completion: .failure(NetworkError.invalidURL))
  }

  func sendFinished() {
    publisher.send(completion: .finished)
  }

}

struct CurrentValueSubjectDemo: View {
  @StateObject private var viewModel = CurrentValueSubjectViewModel()

  var body: some View {
    VStack {
      Button("Send Message") {
        viewModel.sendMessage()
      }

      Button("Send Finished") {
        viewModel.sendFinished()
      }

      Button("Send Error") {
        viewModel.sendError()
      }
    }
    .buttonStyle(BorderedProminentButtonStyle())
  }
}

当点击按钮时，输出如下：
在这里插入图片描述

关于Subject生命周期

Subject是有生命周期的，放发送了completion后（不管是finished还是error），Subject都不会再发送任何新值。

就上面的CurrentValueSubject为例，在发送一个value之后，就发送finished，然后在发送value就无效了。
在这里插入图片描述
PassthroughSubject亦是如此。所以当使用PassthroughSubject或CurrentValueSubject时，重要的是要考虑生命周期，并在明显没有任何值发送时关闭Subject。