通過之前的一系列文章,關于可被觀察的序列(Observable
)我們應該都了解的查不多了。 除了Observable
,RxSwift
還為我們提供了一些特征序列(Traits
):Single
、Completable
、Maybe
、Driver
、ControlEvent
。
我們可以將這些 Traits
看作是 Observable
的另外一個版本。它們之間的區別是:
-
Observable
是能夠用于任何上下文環境的通用序列。 - 而
Traits
可以幫助我們更準確的描述序列。同時它們還為我們提供上下文含義、語法糖,讓我們能夠用更加優雅的方式書寫代碼。
一、Single
1,基本介紹
Single
是 Observable
的另外一個版本。但它不像 Observable
可以發出多個元素,它要么只能發出一個元素,要么產生一個 error
事件。
- 發出一個元素,或一個
error
事件 - 不會共享狀態變化
2,應用場景
Single
比較常見的例子就是執行 HTTP
請求,然后返回一個應答或錯誤。不過我們也可以用 Single
來描述任何只有一個元素的序列。
3,SingleEvent
為方便使用,RxSwift
還為 Single
訂閱提供了一個枚舉(SingleEvent
):
-
.success
:里面包含該Single
的一個元素值 -
.error
:用于包含錯誤
public enum SingleEvent<Element> {
case success(Element)
case error(Swift.Error)
}
4,使用樣例
(1)創建 Single
和創建 Observable
非常相似。下面代碼我們定義一個用于生成網絡請求 Single
的函數:
//獲取豆瓣某頻道下的歌曲信息
func getPlaylist(_ channel: String) -> Single<[String: Any]> {
return Single<[String: Any]>.create { single in
let url = "https://douban.fm/j/mine/playlist?"
+ "type=n&channel=\(channel)&from=mainsite"
let task = URLSession.shared.dataTask(with: URL(string: url)!) { data, _, 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
}
(2)接著我們可以使用如下方式使用這個 Single
:
import UIKit
import RxSwift
import RxCocoa
class ViewController: UIViewController {
let disposeBag = DisposeBag()
override func viewDidLoad() {
//獲取第0個頻道的歌曲信息
getPlaylist("0")
.subscribe { event in
switch event {
case .success(let json):
print("JSON結果: ", json)
case .error(let error):
print("發生錯誤: ", error)
}
}
.disposed(by: disposeBag)
}
}
(3)也可以使用 subscribe(onSuccess:onError:)
這種方式:
import UIKit
import RxSwift
import RxCocoa
class ViewController: UIViewController {
let disposeBag = DisposeBag()
override func viewDidLoad() {
//獲取第0個頻道的歌曲信息
getPlaylist("0")
.subscribe(onSuccess: { json in
print("JSON結果: ", json)
}, onError: { error in
print("發生錯誤: ", error)
})
.disposed(by: disposeBag)
}
}
(4)運行結果如下:
5,asSingle()
(1)我們可以通過調用 Observable
序列的.asSingle()
方法,將它轉換為 Single
。
let disposeBag = DisposeBag()
Observable.of("1")
.asSingle()
.subscribe({ print($0) })
.disposed(by: disposeBag)
(2)運行結果如下:
二、Completable
1,基本介紹
Completable
是 Observable
的另外一個版本。不像 Observable
可以發出多個元素,它要么只能產生一個 completed
事件,要么產生一個 error 事件。
- 不會發出任何元素
- 只會發出一個
completed
事件或者一個error
事件 - 不會共享狀態變化
2,應用場景
Completable
和 Observable<Void>
有點類似。適用于那些只關心任務是否完成,而不需要在意任務返回值的情況。比如:在程序退出時將一些數據緩存到本地文件,供下次啟動時加載。像這種情況我們只關心緩存是否成功。
3,CompletableEvent
為方便使用,RxSwift
為 Completable
訂閱提供了一個枚舉(CompletableEvent
):
-
.completed
:用于產生完成事件 -
.error
:用于產生一個錯誤
public enum CompletableEvent {
case error(Swift.Error)
case completed
}
4,使用樣例
(1)創建 Completable
和創建 Observable
非常相似。下面代碼我們使用 Completable
來模擬一個數據緩存本地的操作:
//將數據緩存到本地
func cacheLocally() -> Completable {
return Completable.create { completable 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
}
(2)接著我們可以使用如下方式使用這個 Completable
:
cacheLocally()
.subscribe { completable in
switch completable {
case .completed:
print("保存成功!")
case .error(let error):
print("保存失敗: \(error.localizedDescription)")
}
}
.disposed(by: disposeBag)
(3)也可以使用 subscribe(onCompleted:onError:)
這種方式:
cacheLocally()
.subscribe(onCompleted: {
print("保存成功!")
}, onError: { error in
print("保存失敗: \(error.localizedDescription)")
})
.disposed(by: disposeBag)
(4)運行結果如下(失敗的情況):
三、Maybe
1,基本介紹
Maybe
同樣是 Observable
的另外一個版本。它介于 Single
和 Completable
之間,它要么只能發出一個元素,要么產生一個 completed
事件,要么產生一個 error
事件。
- 發出一個元素、或者一個
completed
事件、或者一個error
事件 - 不會共享狀態變化
2,應用場景
Maybe
適合那種可能需要發出一個元素,又可能不需要發出的情況。
3,MaybeEvent
為方便使用,RxSwift
為 Maybe
訂閱提供了一個枚舉(MaybeEvent
):
-
.success
:里包含該Maybe
的一個元素值 -
.completed
:用于產生完成事件 -
.error
:用于產生一個錯誤
public enum MaybeEvent<Element> {
case success(Element)
case error(Swift.Error)
case completed
}
4,使用樣例
(1)創建 Maybe
和創建 Observable
同樣非常相似:
func generateString() -> Maybe<String> {
return Maybe<String>.create { maybe in
//成功并發出一個元素
maybe(.success("hangge.com"))
//成功但不發出任何元素
maybe(.completed)
//失敗
//maybe(.error(StringError.failedGenerate))
return Disposables.create {}
}
}
//與緩存相關的錯誤類型
enum StringError: Error {
case failedGenerate
}
(2)接著我們可以使用如下方式使用這個 Maybe
:
generateString()
.subscribe { maybe in
switch maybe {
case .success(let element):
print("執行完畢,并獲得元素:\(element)")
case .completed:
print("執行完畢,且沒有任何元素。")
case .error(let error):
print("執行失敗: \(error.localizedDescription)")
}
}
.disposed(by: disposeBag)
(3)也可以使用 subscribe(onSuccess:onCompleted:onError:)
這種方式:
generateString()
.subscribe(onSuccess: { element in
print("執行完畢,并獲得元素:\(element)")
},
onError: { error in
print("執行失敗: \(error.localizedDescription)")
},
onCompleted: {
print("執行完畢,且沒有任何元素。")
})
.disposed(by: disposeBag)
(4)運行結果如下:
5,asMaybe()
(1)我們可以通過調用 Observable
序列的 .asMaybe()
方法,將它轉換為 Maybe
。
let disposeBag = DisposeBag()
Observable.of("1")
.asMaybe()
.subscribe({ print($0) })
.disposed(by: disposeBag)
(2)運行結果如下: