[iOS] RxSwift之Subjects

更新：2019.3.26 RxSwift v4.4 Swift 4.2

前言

上一篇 《iOS开发进阶-RxSwift之Observables》学习了Observables概念，如何创建，订阅以及清除等。Observables在运行时将值添加到序列中，在将来的某个时机发射给订阅者。Subjects与Observables不同在于它同时担任序列和订阅者两个角色。

Subjects

本节将会学习不同类型的Subject，各个类型Subject是如何工作的及它们之间的不同点。

在RxSwift中，提供了四种不同类型的Subject 和两种解包类型。分别如下：

• ①、PublishSubject：初始化为空，只发射最新的元素给订阅者。
• ②、BehaviorSubject：有初始值，并且重复发射最晚一个元素给订阅者。
• ③、ReplaySubject：存在一个缓存区，重复发射符合缓存个数的元素给新的订阅者。
• ④、Variable：是BehaviorSubject的包装。
• ⑤、AsyncSubject: 只有在接收到 .completed事件时，发射最后一个 .next 事件。这个类型 Subject 很少使用。
• ⑥、PublishRelay 和 BehaviorRelay：包装相关的 Subject，只接受 .next 事件。

PublishSubjects

当只想将新的事件发布给订阅者时，PublishSubject就派上用场了。它也是通过.completed或.error事件终止。

下面看一张圆珠图。最上方的线代表PublishSubject。第二条和第三条代表订阅者。向上的虚线箭头代表订阅，向下的虚线箭头代表发射事件。

1. 第一个订阅者在1)之后，只能接收到2)和3)。
2. 第二个订阅者在2)之后，只能接收到3)。

创建PublishSubject

创建PublishSubject，示例代码如下：

example(of: "PublishSubject") {
    // 1
    let subject = PublishSubject<String>()
    // 2 
    subject.onNext("1")
    // 3 
    let subscriptionOne = subject.subscribe(onNext: { string in
        print(string)
    })
    // 4
    subscriptionOne.dispose()
}

1. 创建一个包含字符串类型的PublishSubject。
2. 向subject中添加一个字符串，此时并没有任何值输出因为没有订阅。
3. 为subject创建一个订阅，用于打印.next事件。但是此时并没有打印。
4. 用于销毁回收。

由于PublishSubject只能发射在订阅之后添加的事件，所以上面并没有输出结果。在4)之前添加下面这行代码：

// subject.on(.next("2"))
// 或者
subject.onNext("2")

subject之前添加了订阅，所以输出：

--- Example of: PublishSubject ---
1) 2

接下来在添加一个订阅，添加如下代码：

let subscriptionTwo = subject.subscribe { event in             
  print("2)", event.element ?? event)
} 

这种方式订阅逃逸闭包参数是Event<String>类型，事件中element属性是可选值，所以通过??操作取值，如果非nil打印值，否则打印事件本身。

接下来向subject中添加新的元素

subject.onNext("3")

输出结果：

--- Example of: PublishSubject ---
1) 2
1) 3
2) 3

通过上面的验证，结果与圆珠图中相同。

在PublishSubject当接收到.completed和.error事件也会终止。例如：

subject.onCompleted() 
subject.onNext("4")

此时控制台只打印出completed并没有输出4，因为subject已经结束。事实上，任何类型的subject一旦终止，将不会再发射事件。

BehaviorSubjects

BehaviorSubjects工作方式类似于PublishSubjects，不同点是它会重新发射最晚的.next事件给新添加的订阅者。

对应的圆珠图如下：

• 第一条线是当前的subject。
• 第一个订阅者，在①之后添加由于BehaviorSubjects可以重新发射最晚的一个元素给新的订阅者，所以接收到事件序列是① ② ③。
• 同理第二个订阅，可以接收的事件序列② ③。

// 错误枚举
enum LEError: Error {
    case anError
}

// 错误枚举
enum LEError: Error {
    case anError
}
// 封装打印方法
func print<T: CustomStringConvertible>(label: String, event: Event<T>) {
    print(label, (event.element ?? event.error) ?? event)
}

example(of: "BehaviorSubject") {
    // 1. 创建 subject
    let subject = BehaviorSubject(value: "Initial Value")
    let disposeBag = DisposeBag()
    subject.subscribe {
        print(label: "1)", event: $0)
    }
    .disposed(by: disposeBag) // 此时控制台输出 Initial Value
    
    // 2. 发送一个事件
    subject.onNext("X") // 输出 X
    
    // 3. 发送 Error事件
    subject.onError(LEError.anError) // 输出 anError
    
    // 4. 终止后不会在输出
    subject.onNext("Y")
    // 此时再添加订阅 会输出什么 ？
    subject.subscribe {
        print(label: "2)", event: $0)
    }
    .disposed(by: disposeBag) // 输出 2) anError
    // 5. 再添加事件，并不会被输出。==> 终止后不会再发送事件
    subject.onNext("Z")
}

1. 创建subject和disposeBag。
2. 添加第一个订阅，由于 BehaviorSubject的特性会携带上次的事件，此时会输出初始1) Initial Value。
3. 添加新的元素X，订阅者会将上一次事件和本次事件同时输出。
4. 两种结束subject的方式，当出现错误时终止或者发送complete时终止。发送onError使用错误终止subject，终止后就不会再发送新的事件。此时添加 Y 事件订阅并没有输出信息。
5. 添加新的订阅，也不能接收 Y 事件，此时 Subject 只会告诉订阅已经终止，因 onError 事件终止。

ReplaySubjects

ReplaySubject存在一个临时的缓存，会重复将缓存中的元素发射给新的订阅。对应的圆珠图如下：

第一个订阅者(中间线)，第二个订阅(下方线)。两者的输出结果都是序列① ② ③。

示例代码如下：

example(of: "ReplaySubject") {
    // 创建Subject，缓存大小为2。每次会将最晚的两个发送给新的订阅
    let subject = ReplaySubject<String>.create(bufferSize: 2)
    let disposeBag = DisposeBag()
    // 订阅①
    subject.subscribe {
        print(label: "1)", event: $0)
        }
    .disposed(by: disposeBag)
    // 添加元素
    subject.onNext("1")
    subject.onNext("2")
    // 订阅②
    subject.subscribe {
        print(label: "2)", event: $0)
        }
        .disposed(by: disposeBag)
    // 添加元素
    subject.onNext("3")
}

输出结果：

--- Example of: ReplaySubject ---
1) 1
1) 2
2) 1
2) 2
1) 3
2) 3

这里不做过多的解释，如果理解前两个这个不难理解。

由于ReplaySubjects的缓存是保存在内存中的，所以在使用的时候需要注意大小问题，防止浪费过的的内存。尽量避免创建过多的缓存或存放大的对象。

PublishRelay & BehaviorRelay

PublishRelay用来包装 PublishSubject；BehaviorRelay 用来包装 BehaviorSubject ，被包装的 Subject 不会终止。通过 accept添加值而不是onNext，由于不会终止也就没有 .error 和 .completed 事件。

下面看关于 PublishRelay 的例子。

example(of: "PublishRelay") {
    // 1. 创建 relay
    let relay = PublishRelay<String>()
    let disposeBag = DisposeBag()
    // 2. 添加一个元素
    relay.accept("hello")
    // 3. 添加订阅，PublishRelay 是对 PublishSubject 的封装具有其特性，并不会输出 hello
    relay.subscribe(onNext: {
        print($0)
    })
    .disposed(by: disposeBag)
    // 4. 添加元素，
    relay.accept("1") // 输出： 1
    
    // 5. 如果发送 .completed 或者 .error 将会怎样？
//    relay.accept(LEError.anError) // 编译器报错。
}

PublishReplay 是对 PublishSubject的封装具有其特性。

example(of: "BehaviorRelay") {
    // 1. 定义
    let relay = BehaviorRelay(value: "initial Value")
    let disposeBag = DisposeBag()
    
    // 2. 添加value
    relay.accept("New Initial Value")
    // 3. 订阅
    relay.subscribe {
        print(label: "1)", event: $0)
    }
    .disposed(by: disposeBag)
    // 3. 新Value
    relay.accept("1") // 同 BehaviorSubject
    // 4. 新的订阅
    relay.subscribe {
        print(label: "2)", event: $0)
    }
    .disposed(by: disposeBag)
    // 5. 新Value
    relay.accept("2")
    // 6. 直接通过 replay 获取值。
    print(relay.value)
}

Variables

在之前有提到，Variable是对BehaviorSubject的包装，它会存储当前的值作为状态。可以通过value属性访问当前的值，也可以通过它修改值。通过value属性可以代替onNext(_:)。

Variable包含BehaviorSubject的所有功能，存在初始值，可以重复发射最晚元素给新的订阅。不过，想访问Variable中包装的BehaviorSubject需要使用asObservable()方法。

Variable与其他subject不同点，第一，不能向Variable中添加.error事件但是可以监听。在销毁时自动发送completed事件，不需要手动添加。

example(of: "Variable") {
    let variable = Variable("Init Variable")
    let disposeBag = DisposeBag()
    // 1
    variable.value = "New init value" // 添加新值
    // 2
    variable.asObservable()
        .subscribe {
            print(label: "1)", event: $0) // 输出前一个值
    }
    .disposed(by: disposeBag)
    // 2
    variable.value = "1"
    variable.asObservable()
        .subscribe {
            print(label: "2)", event: $0)
    }
    .disposed(by: disposeBag)
    // 3
    variable.value = "2"
}

输出结果：

--- Example of: Variable ---
1) New init value
1) 1
2) 1
1) 2
2) 2

小结

本节学习了Subjects概念及创建方法。理解基础概念才能为以后的熟练运用打好基础。

参考

RxSwift_v4.4