RxSwift Observable-可观察序列

上一篇已经介绍了Observable是什么,现在简单介绍一下它怎么创建,以及RxSwift里面Observable存在的一些特征序列。

常见的创建方法

1. just() 方法

该方法通过传入一个默认值完成初始化,并指定了当前Observable所发出事件携带的数据类型

let observable = Observable<Int>.just(1)

2.of()方法

该方法可以接受多个参数来创建实例,但这些参数必须是同类型

let observable = Observable.of("A", "B", "C")

3.from()方法

该方法只接收数组作为参数,并抽取出数组里的元素来作为数据流中的元素

let observable = Observable.from(["A", "B", "C"])

4.never()方法

该方法创建一个永远不会发出Event(也不会终止)的 Observable序列

let observable = Observable<Int>.never()

5.empty()方法

该方法创建一个空内容的Observable序列

let observable = Observable<Int>.empty()

6.error() 方法

该方法创建一个不做任何操作,而是直接发送一个错误的Observable序列

enum MyError: Error {
    case A
    case B
}
         
let observable = Observable<Int>.error(MyError.A)

7.range() 方法

该方法通过指定起始和结束数值,创建一个以这个范围内所有值作为初始值的Observable序列

let observable = Observable.range(start: 1, count: 5)

8.repeatElement() 方法

该方法创建一个可以无限发出给定元素的EventObservable序列

let observable = Observable.repeatElement(1)

9.generate() 方法

该方法创建一个只有当提供的所有的判断条件都为 true 的时候,才会给出动作的Observable序列

let observable = Observable.generate(
    initialState: 0,
    condition: { $0 <= 10 },
    iterate: { $0 + 2 }
)

10.interval() 方法

这个方法创建的Observable序列每隔一段设定的时间,会发出一个索引数的元素。而且它会一直发送下去

let observable = Observable<Int>.interval(1, scheduler: MainScheduler.instance)
observable.subscribe { event in
    print(event)
    //next(0) next(1) next(2)......
}

11.timer() 方法

  • 创建的Observable序列在经过设定的一段时间后,产生唯一的一个元素
//10秒种后发出唯一的一个元素0
let observable = Observable<Int>.timer(10, scheduler: MainScheduler.instance)
observable.subscribe { event in
    print(event)
}
  • 创建的Observable序列在经过设定的一段时间后,每隔一段时间产生一个元素
//延时10秒种后,每隔1秒钟发出一个元素
let observable = Observable<Int>.timer(10, period: 1, scheduler: MainScheduler.instance)
observable.subscribe { event in
    print(event)
}

12. create()方法

该方法接受一个block形式的参数,任务是对每一个过来的订阅进行处理

let observable = Observable<String>.create { (observer) -> Disposable in
    observer.onNext("test")
    observer.onCompleted()
    return Disposables.create()
}
observable.subscribe { (element) in
    print(element)
}
//next(test)
//completed

13.deferred() 方法

该个方法相当于是创建一个Observable工厂,通过传入一个block来执行延迟Observable序列创建的行为,而这个block里就是真正的实例化序列对象的地方

var time = 0
let factory: Observable<Int> = Observable.deferred {
    time += 1
    return Observable.just(time)
}
factory.subscribe { (event) in
    print(event)
}
factory.subscribe { (event) in
    print(event)
}
factory.subscribe { (event) in
    print(event)
}
factory.subscribe { (event) in
    print(event)
}
/* 
打印结果
 next(1)
 completed
 next(2)
 completed
 next(3)
 completed
 next(4)
 completed
 */

特征序列

Swift是一个强类型语言,它相对弱类型语言更加严谨。我们可以通过类型来判断出,实例有哪些特征。同样的在RxSwift 里面Observable也存在一些特征序列,这些特征序列可以帮助我们更准确的描述序列。并且它们还可以给我们提供语法糖,让我们能够用更加优雅的方式书写代码,他们分别是SingleCompletableMaybeDriverControlEventControlProperty

1. Single

Single,在RxSwift中,对它的解释是Represents a push style sequence containing 1 element,它要么只能发出一个元素,要么产生一个error事件

  • 发出一个元素或一个error事件
  • 不会共享状态变化
    附:
public enum SingleEvent<Element> {
    /// One and only sequence element is produced. (underlying observable sequence emits: `.next(Element)`, `.completed`)
    case success(Element)
    /// Sequence terminated with an error. (underlying observable sequence emits: `.error(Error)`)
    case error(Swift.Error)
}
/*

  */

比如说,我们利用Single实现一个网络请求,返回成功的结果或失败:

func getReop(_ repo: String) -> Single<[String: Any]>{
    return Single<[String: Any]>.create(subscribe: { (single) -> Disposable in
        let url = URL.init(string: "https://api.github.com/repos/\(repo)")!
        let task = URLSession.shared.dataTask(with: url, completionHandler: { (data, response, error) in
            if let error = error{
                single(.error(error))
                return
            }
            guard let data = data,
                  let json = try? JSONSerialization.jsonObject(with: data, options: .mutableLeaves),
                  let result = json as? [String: Any] else{
                    single(.error(DataError.cantParseJSON))
                    return
            }
            single(.success(result))
        })
        task.resume()
        return Disposables.create {
            task.cancel()
        }
    })
}
//与数据相关的错误类型
enum DataError: Error {
    case cantParseJSON
}

当我们想调用这个方法的时候:

let disposeBag = DisposeBag()
getReop("ReactiveX/RxSwift").subscribe(onSuccess: { (json) in
    print("Json:\(json)")
}) { (error) in
    print("error:\(error)")
}.disposed(by: disposeBag)

2. Completable

Completable,在RxSwift中,对它的解释Represents a push style sequence containing 0 elements.可以理解为表示包含0个元素的推送样式序列,它要么产生completed事件,要么产生error事件。

  • 不会发出任何元素
  • 只会发出一个completed事件或者一个error事件
  • 不会共享状态变化
    附:
public enum CompletableEvent {
    /// Sequence terminated with an error. (underlying observable sequence emits: `.error(Error)`)
    case error(Swift.Error)  
    /// Sequence completed successfully.
    case completed
}

举个🌰:

func cacheLocally() -> Completable {
    return Completable.create(subscribe: { (completable) -> Disposable in
        //将数据缓存到本地(这里掠过具体的业务代码,随机成功或失败)
        let success = (arc4random() % 2 == 0)
        guard success else {
            completable(.error(CacheError.failedCaching))
            return Disposables.create{}
        }
        completable(.completed)
        return Disposables.create()
    })
}
enum CacheError: Error {
    case failedCaching
}

调用方法:

cacheLocally().subscribe(onCompleted: {
    print("completed")
}) { (error) in
    print("error:\(error)")
}.disposed(by: disposeBag)

3. Maybe

MayBe介于SingleCompletable之间,它要么只能发出一个元素,要么产生一个completed事件,要么产生一个error事件。

  • 发出一个元素、或者一个completed事件、或者一个error 事件
  • 不会共享状态变化
    附:
public enum MaybeEvent<Element> {
    /// One and only sequence element is produced. (underlying observable sequence emits: `.next(Element)`, `.completed`)
    case success(Element)
    /// Sequence terminated with an error. (underlying observable sequence emits: `.error(Error)`)
    case error(Swift.Error)
    /// Sequence completed successfully.
    case completed
}

举个🌰:

func generateString() -> Maybe<String>{
    return Maybe<String>.create(subscribe: { (maybe) -> Disposable in
        maybe(.success("success"))
        maybe(.completed)
        maybe(.error(StringError.failedGenerate))
        return Disposables.create()
    })
}
enum StringError: Error {
    case failedGenerate
}

调用方法:

generateString().subscribe(onSuccess: { (element) in
    print("success:\(element)")
}, onError: { (error) in
    print("error:\(error)")
}) {
    print("completed")
}.disposed(by: disposeBag)

4. Driver

Driver准确来说是RxCocoa的特征序列,目标是提供一种简便的方式在 UI 层编写响应式代码。

为什么使用Driver

这部分我们引用RxSwift中文文档内容
我们举个例子来说明一下,为什么要使用Driver
这是文档简介页的例子:

let results = query.rx.text
    .throttle(0.3, scheduler: MainScheduler.instance)
    .flatMapLatest { query in
        fetchAutoCompleteItems(query)
    }

results
    .map { "\($0.count)" }
    .bind(to: resultCount.rx.text)
    .disposed(by: disposeBag)

results
    .bind(to: resultsTableView.rx.items(cellIdentifier: "Cell")) {
      (_, result, cell) in
        cell.textLabel?.text = "\(result)"
    }
    .disposed(by: disposeBag)

这段代码的主要目的是:

  • 取出用户输入稳定后的内容
  • 向服务器请求一组结果
  • 将返回的结果绑定到两个 UI 元素上:tableView和 显示结果数量的label
    代码存在的问题:
  • 如果fetchAutoCompleteItems的序列产生了一个错误(网络请求失败),这个错误将取消所有绑定,当用户输入一个新的关键字时,是无法发起新的网络请求
  • 如果fetchAutoCompleteItems在后台返回序列,那么刷新页面也会在后台进行,这样就会出现异常崩溃
  • 返回的结果被绑定到两个 UI 元素上。那就意味着,每次用户输入一个新的关键字时,就会分别为两个 UI 元素发起 HTTP 请求,这并不是我们想要的结果
    一个更好的方案是这样的:
let results = query.rx.text
    .throttle(0.3, scheduler: MainScheduler.instance)
    .flatMapLatest { query in
        fetchAutoCompleteItems(query)
            .observeOn(MainScheduler.instance)  // 结果在主线程返回
            .catchErrorJustReturn([])           // 错误被处理了,这样至少不会终止整个序列
    }
    .share(replay: 1)                             // HTTP 请求是被共享的

results
    .map { "\($0.count)" }
    .bind(to: resultCount.rx.text)
    .disposed(by: disposeBag)

results
    .bind(to: resultsTableView.rx.items(cellIdentifier: "Cell")) {
      (_, result, cell) in
        cell.textLabel?.text = "\(result)"
    }
    .disposed(by: disposeBag)

在一个大型系统内,要确保每一步不被遗漏是一件不太容易的事情。所以更好的选择是合理运用编译器和特征序列来确保这些必备条件都已经满足。
以下是使用Driver优化后的代码:

let results = query.rx.text.asDriver()        // 将普通序列转换为 Driver
    .throttle(0.3, scheduler: MainScheduler.instance)
    .flatMapLatest { query in
        fetchAutoCompleteItems(query)
            .asDriver(onErrorJustReturn: [])  // 仅仅提供发生错误时的备选返回值
    }

results
    .map { "\($0.count)" }
    .drive(resultCount.rx.text)               // 这里改用 `drive` 而不是 `bindTo`
    .disposed(by: disposeBag)                 // 这样可以确保必备条件都已经满足了

results
    .drive(resultsTableView.rx.items(cellIdentifier: "Cell")) {
      (_, result, cell) in
        cell.textLabel?.text = "\(result)"
    }
    .disposed(by: disposeBag)

首先第一个asDriver方法将ControlProperty转换为Driver
然后第二个变化是:

.asDriver(onErrorJustReturn: [])

任何可被监听的序列都可以被转换为 Driver,只要他满足 3 个条件:

  • 不会产生 error 事件
  • 一定在 MainScheduler 监听(主线程监听)
  • 共享状态变化
    那么要如何确定条件都被满足?通过 Rx 操作符来进行转换。asDriver(onErrorJustReturn: []) 相当于以下代码
let safeSequence = xs
  .observeOn(MainScheduler.instance)       // 主线程监听
  .catchErrorJustReturn(onErrorJustReturn) // 无法产生错误
  .share(replay: 1, scope: .whileConnected)// 共享状态变化
return Driver(raw: safeSequence)           // 封装

最后使用drive而不是bindTo

5. ControlProperty

ControlProperty是专门用来描述 UI 控件属性,拥有该类型的属性都是被观察者(Observable),它也是RxCocoa的特征序列
ControlProperty具有以下特征:

  • 不会产生error事件
  • 一定在MainScheduler订阅(主线程订阅)
  • 一定在MainScheduler监听(主线程监听)
  • 共享状态变化
    举个🌰:
import UIKit
import RxSwift
import RxCocoa

class ViewController: UIViewController {

    @IBOutlet weak var textField: UITextField!
    @IBOutlet weak var label: UILabel!
    //负责对象销毁
    let disposeBag = DisposeBag()
    override func viewDidLoad() {
        super.viewDidLoad()
        //将textField输入的文字绑定到label上
        textField.rx.text
                    .bind(to: label.rx.text)
                    .disposed(by: disposeBag)
    }
    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }
}

有人可能会纳闷,这跟ControlProperty有什么关系,没看到它的影子啊。我们查看textField.rx.texttext方法:

extension Reactive where Base : UITextField {
public var text: ControlProperty<String?> {
        return value
    }
 
    public var value: ControlProperty<String?> {
        return base.rx.controlPropertyWithDefaultEvents(
            getter: { textField in
                textField.text
        },
            setter: { textField, value in
                if textField.text != value {
                    textField.text = value
                }
        }
        )
    }
}

原来UITextField 的rx.text属性类型便是 ControlProperty<String?>
同时,这段代码也给我们启示,为控件添加属性,可以采用extension Reactive where Base : UITextField的方法。

6. ControlEvent

ControlEvent专门用于描述 UI 控件所产生的事件,它具有跟ControlProperty一样的特征:

  • 不会产生error事件
  • 一定在MainScheduler订阅(主线程订阅)
  • 一定在MainScheduler监听(主线程监听)
  • 共享状态变化
    举个🌰:
import UIKit
import RxSwift
import RxCocoa
 
class ViewController: UIViewController {
     
    let disposeBag = DisposeBag()
     
    @IBOutlet weak var button: UIButton!
     
    override func viewDidLoad() {
         
        //订阅按钮点击事件
        button.rx.tap
            .subscribe(onNext: {
                print("blick")
            }).disposed(by: disposeBag)
    }
}

可能也有人会疑问,ControlEvent在哪?查看tap方法,会看到源码(UIButton+Rx.swift),这个时候就会发现 UIButton 的rx.tap方法类型便是ControlEvent<Void>

import RxSwift
import UIKit
 
extension Reactive where Base: UIButton {
    public var tap: ControlEvent<Void> {
        return controlEvent(.touchUpInside)
    }
}

至此,我们就对Observable有了一个简单的介绍。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容