基本觀念跟operator都帶到之後,可以用一個簡單範例,把前面提到的內容應用在UITableView上,不過在這之前先講一下UITableView+Rx的基本用法。
TableView + Rx
UITableView+Rx封裝內容可以藉由搜尋『UITableView+Rx.swift』看到,裡面註解也包含簡單的範例
第一種方式
也是我比較習慣用的方式,cell要自行register
// 1let items = Observable.just([ "First Item", "Second Item", "Third Item"])// 2, 3items .bind(to: tableView.rx.items) { (tableView, row, element) in let cell = tableView.dequeueReusableCell(withIdentifier: "Cell")! cell.textLabel?.text = "\(element) @ row \(row)" return cell } .disposed(by: disposeBag)- 給定一個遵守Sequence的items,像是一個Array
- 將它bind到tableView的item
- 在closure可以收到tableView、row和element參數,裡面就可以自訂cell,最終回傳UITableView的類型即可
第二種方式
把cell register的動作也封裝了起來,就會像下面這樣
let items = Observable.just([ "First Item", "Second Item", "Third Item"])
items .bind(to: tableView.rx.items(cellIdentifier: "Cell", cellType: UITableViewCell.self)) { (row, element, cell) in cell.textLabel?.text = "\(element) @ row \(row)" } .disposed(by: disposeBag)其他像是select、didSelect、delete…等都有相對應的寫法,在找尋資料的過重中,發現一個網站 Swift - RxSwift的使用详解30(UITableView的使用1:基本用法) ,對各項操作都有介紹,非常詳細,所以想說這裡就不細談了!
TableView範例
我自己使用MVVMC架構,不過我想這不影響我們解說,一些觀念會邊寫文章邊帶過,在接下來要進行範例中,程式碼放在GitHub - bing-kuo/RxSwiftDemo,假設我們從API可以取的Product的列表,我們就在把資料呈現在TableView上,很簡單但也滿常見的,所以預計實現了幾項目標
- UITableView+Rx的基本使用方式
- ViewModel與ViewController的溝通方式
- Pull to refresh實現方式
- Infinite scroll實現方式
ViewController
畫面部分我習慣用Snapkit,所以,一開始先import所需要的library
import UIKitimport RxSwiftimport SnapKit定義畫面所需要的元件
// MARK: - Privateprivate let viewModel: ProductListViewModelprivate let disposeBag = DisposeBag()
private let refreshControl: UIRefreshControl = { return UIRefreshControl()}()private let tableView: UITableView = { let tv = UITableView(frame: .zero)
tv.separatorStyle = .none tv.backgroundColor = .white tv.estimatedRowHeight = 44 tv.rowHeight = UITableView.automaticDimension
tv.register(ProductListCell.self, forCellReuseIdentifier: String(describing: ProductListCell.self))
return tv}()- 負責資料與邏輯的ViewModel
- 存放訂閱者的DisposeBag
- 用於呈現載入中的UIRefreshControl
- 本次主角的UITableView,並且註冊了ProductListCell這一個自訂的UITableViewCell
初始畫面的部分,因為每個人做法都不一樣,這邊草草帶過
// MARK: - Constructorinit(viewModel: ProductListViewModel) { self.viewModel = viewModel
super.init(nibName: nil, bundle: nil)}
required init?(coder: NSCoder) { fatalError("init(coder:) has not been implemented")}
// MARK: - Life Cycleoverride func viewDidLoad() { super.viewDidLoad()
setupTableView() setupNavigation() bindViewModel()}
func setupTableView() { self.view.addSubview(tableView)
tableView.snp.makeConstraints { make in make.edges.equalToSuperview() }
tableView.addSubview(refreshControl)}
func setupNavigation() { navigationItem.title = "範例一"}這邊是重點部分,我們將需要與ViewModel做綁定的部分都放在bindViewModel()
func bindViewModel() { tableView.rx.setDelegate(self).disposed(by: disposeBag)
viewModel.data .bind(to: tableView.rx.items) { (tableView, row, element) in guard let cell = tableView.dequeueReusableCell(withIdentifier: String(describing: ProductListCell.self)) as? ProductListCell else { return UITableViewCell() }
cell.config(item: element)
return cell } .disposed(by: disposeBag)
refreshControl.rx.controlEvent(.valueChanged).bind(to: viewModel.triggerAPI).disposed(by: disposeBag)
viewModel.isLoading.bind(to: refreshControl.rx.isRefreshing).disposed(by: disposeBag)}- 要實作infinite scroll,就需要偵測滾到到最後一筆,這部分需要在tableView的
tableView(_:willDisplay:forRowAt:)做偵測,很可惜的是RxSwift並沒其封裝,而是提供了tableView.rx.setDelegate(self),讓我們自己編寫Delegate,就跟原生的一樣做法 - 將
viewModel.data綁定到UITableView上 - 將refreshControl的valueChanged事件綁定到
viewModel.triggerAPI,這樣當接收到valueChanged事件就會傳遞給triggerAPI,進而觸發call API viewModel.isLoading綁定refreshControl.rx.isRefreshing,也就是說當isLoading是true時,refreshControl就會啟動,開始轉圈圈,反之,就會停止。
最後,前面提到的,需要偵測滾動到最後一筆。
extension ProductListViewController: UITableViewDelegate {
func tableView(_ tableView: UITableView, willDisplay cell: UITableViewCell, forRowAt indexPath: IndexPath) { let lastSectionIndex = tableView.numberOfSections - 1 let lastRowIndex = tableView.numberOfRows(inSection: lastSectionIndex) - 1
if indexPath.section == lastSectionIndex && indexPath.row == lastRowIndex { viewModel.triggerNextPage.onNext(()) } }
}接著介紹ViewModel的部分,我想不管是MVVMC或是MVVM,ViewModel都不擇了資料跟邏輯的部分,ViewController負責邏輯的部分,所以在兩者之間,使用Rx來做binding。
ViewModel
以Pure Function概念出發,我們也可以把ViewModel分為Input跟Output,Input就是會進到邏輯處理資料或事件;Output就是可能會給Controller接收或是Coordinator接收的Observable。
宣告變數部分可以分為Input跟Output
// MARK: - Inputlet apiService: ProductAPIProtocollet triggerAPI: AnyObserver<Void>let triggerNextPage: AnyObserver<Void>
// MARK: - Outputlet didClose: Observable<FinishReason>let isLoading: Observable<Bool>let data: Observable<[Product]>let page: Observable<Int>let showError: Observable<Error>
// MARK: - Privateprivate let disposeBag = DisposeBag()Input的部分
- triggerAPI來接收reload事件
- triggerNextPage則是用來接收下一頁事件
Output的部分
- didClose是來發送這個頁面或是說這模組的關閉原因
- isLoading是發送現在是否要呈現Activity indicator
- data是發送從目前呈現在頁面上的資料
- showError是包含所以可能發生錯誤的事件
Constructor部分就會包含變數的定義,
// MARK: - Constructorinit(apiService: ProductAPIProtocol) { self.apiService = apiService
didClose = .never()- 建構時,帶入apiService作為參數,apiService定義了這整個功能所需要call API,用注入的方式是為了之後再測試時,可以mock測試的API
- didClose是這個模組離開或結束的原因,可能因為使用者取消,或使用者選了一個選項…等原因,這模組結束,而需要轉跳到別頁。但因為目前做的這功能就是APP開啟的第一個模組,沒有要dimiss的需求,先放
.never()
let pageRelay = BehaviorRelay<Int>(value: 1)page = pageRelay.asObservable()
let productListRelay = BehaviorRelay<[Product]>(value: [])data = productListRelay.asObservable()
let indicator = ActivityIndicator()isLoading = indicator.asObservable()
let triggerAPISubject = PublishSubject<Void>()triggerAPI = triggerAPISubject.asObserver()
let triggerNextPageSubject = PublishSubject<Void>()triggerNextPage = triggerNextPageSubject.asObserver()pageRelay跟productListRelay分別是目前頁面與產品的資料,使用Relay是因為在串接過程中要加減一頁,或是新增或清空陣列,用Relay很方便。- 但我們在Subject、Relay 與使用時機有聊到要謹慎使用Subject,所以,對viewModel以外來說,它並沒有需要使用到它們,因為我對外只提供data這Observable,對外只能訂閱,並不能修改。
triggerAPISubject和triggerNextPageSubject作為中介者,對外開放Observer接收到訊息,接收到之後,對內作為Observable發送給訂閱者,這對應到Subject、Relay 與使用時機所講的Subject特性,但同樣的,為了避免被到處.onNext(),這裡只對外開放Observer。
let fetchProductListResult = triggerAPISubject.asObservable().startWith(()) .flatMapLatest { _ in apiService.request(page: 1).trackActivity(indicator).materialize() } .share()
fetchProductListResult.elements() .bind { products -> Void in pageRelay.accept(1) productListRelay.accept(products) } .disposed(by: disposeBag)- fetchProductListResult是接收
triggerAPISubject的.next事件後,去call API,並回傳回來的資料,這對應到Transforming Operators:map、flatMap 與 materialize所說的,因為一進畫面需要先載入一次資料,所以用startWith先觸發一次 fetchProductListResult.elements()這整段則是在處理改變pageRelay的數值為1,以及將productListRelay覆蓋為新的資料。
let nextProductListResult = triggerNextPageSubject.asObservable() .debounce(.seconds(2), scheduler: MainScheduler.instance) .flatMapLatest { _ in apiService.request(page: pageRelay.value+1).trackActivity(indicator).materialize() } .share()
nextProductListResult.elements() .bind { products -> Void in let newPage = pageRelay.value + 1 let newData = productListRelay.value + products
pageRelay.accept(newPage) productListRelay.accept(newData) } .disposed(by: disposeBag)}- nextProductListResult與fetchProductListResult類似,考慮到下拉到tableView最底時,還是繼續一直滾,這樣可能會頻繁發送
.next(Void),這不是我們預期的,所以這裡放置debounce來過濾掉頻繁的元素 nextProductListResult.elements()這段仍是處理pageRelay跟productListRelay,我們將數值先暫存,更新後再存放回去。
showError = Observable.merge(fetchProductListResult.errors(), nextProductListResult.errors())最後將所以可能會發生錯誤的地方,匯集到showError,在由要呈現錯誤訊息的地方去訂閱。
目前這樣寫雖然一看就懂,但缺點就是有點冗,總感覺nextPage跟reload是可以合併在一起,之後再回頭看,或許會有新的想法。