所有文章

RxSwift 探索之旅 · 14

RxSwift 社群套件:RxGesture 與 RxSwiftExt

用 RxGesture 處理各種手勢,以及 RxSwiftExt 常用的 operator 與 Reactive Extensions。

RxGesture

GitHub - RxSwiftCommunity/RxGesture是封裝UIGestureRecognizer的方法,幫助我們在任何view上面進行各種手勢的偵測。

Before & After

在遇到RxGesture之前,我是這樣寫

let myView: UIView = UIView()
let tapGesture = UITapGestureRecognizer()
myView.addGestureRecognizer(tapGesture)
tapGesture.rx.event
.debug("Tap")
.subscribe()
.disposed(by: disposeBag)

建立一個UITapGestureRecognizer(),給myView加入手勢的識別,在用Rx的方式監聽手勢的事件。

當我遇到RxGesture之後,我變成這樣寫

let myView: UIView = UIView()
myView.rx.tapGesture()
.when(.recognized)
.debug("Tap")
.subscribe()
.disposed(by: disposeBag)

myView擴充了tap手勢的事件,when可以幫助我們過濾UIGestureRecognizerState,使用時監聽即可。

常用的手勢

以下就記錄一下常用的手勢,假設我有一個UIView叫做myView

let myView = UIView(frame: .zero)
self.view.addSubview(myView)
myView.snp.makeConstraints { make in
make.width.height.equalTo(200)
make.center.equalToSuperview()
}

Tap 點一下

myView.rx.tapGesture()
.when(.recognized)
.subscribe(onNext: { _ in
print("Tap")
})
.disposed(by: disposeBag)

Double Click 點兩下

myView.rx.tapGesture() { gesture, _ in
gesture.numberOfTapsRequired = 2
}
.when(.recognized)
.subscribe(onNext: { _ in
print("Double Click")
})
.disposed(by: disposeBag)

Long Press 長按

myView.rx.longPressGesture()
.when(.began)
.subscribe(onNext: { _ in
print("Long Press")
})
.disposed(by: disposeBag)

Pan 拖移

myView.rx.panGesture()
.when(.began, .changed, .ended)
.subscribe(onNext: {
$0.view?.center = $0.location(in: self.view)
print("panGesture: \($0.state)")
})
.disposed(by: disposeBag)

Swipe 滑動

myView.rx.swipeGesture(.up, .down)
.when(.recognized)
.subscribe(onNext: {
print("Swipe \($0.direction.rawValue)")
})
.disposed(by: disposeBag)

Pinch 縮放

myView.rx.pinchGesture()
.when(.began, .changed, .ended)
.subscribe(onNext: {
$0.view?.transform = CGAffineTransform(scaleX: $0.scale, y: $0.scale)
print("Pinch \($0.scale)")
})
.disposed(by: disposeBag)

Rotation 旋轉

myView.rx.rotationGesture()
.when(.began, .changed, .ended)
.subscribe(onNext: {
let angle = $0.rotation * (180 / CGFloat(Double.pi))
$0.view?.transform = CGAffineTransform(rotationAngle: $0.rotation)
print("Rotation: \($0.state), \(angle)")
})
.disposed(by: disposeBag)

RxSwiftExt

GitHub - RxSwiftCommunity/RxSwiftExt如同它的名字,就是對RxSwift的Operator進行擴充,多了25種operator、materialize擴充和兩個Reactive Extensions,以下針對個人覺得有趣或是可能常用到的提出來介紹。

安裝

如果是用CocoaPod,加入pod 'RxSwiftExt', '~> 5',若是要使用UIViewPropertyAnimator跟UITableView的擴充,需要在安裝pod 'RxSwiftExt/Core'

編按(2026):文中版本是 2020 年寫作時對應 RxSwift 5 的 ~> 5;目前 RxSwiftExt 最新版為 6.2.1,對應 RxSwift 6。

Unwrap

unwrap可以unwrap optional value,並且排除掉nil

Observable.of(1, nil, Int("2"), Int("a"), 3)
.unwrap()
.subscribe(onNext: {
print($0)
})
.disposed(by: disposeBag)

執行結果

1
2
3

原本的話,會是這樣寫

Observable.of(1, nil, Int("2"), Int("a"), 3)
.filter { $0 != nil }
.map { $0! }

相比之下,unwrap更簡潔也更加的可讀了

Distinct

distinct可以把重複的元素去除

Observable.of("a", "1", "b", "1", "c")
.distinct()
.debug("Result")
.subscribe()
.disposed(by: disposeBag)

執行結果

a
1
b
c

相似的operator有distinctUntilChanged,但distinctUntilChanged是判斷是否與上一個元素重複,是的話則過濾掉,distinct則是看全部曾經發送過的元素是否重複。

Pairwise

pairwise有點像是滑動視窗,把按照順序兩兩合併成tuple

Observable.of(1, 2, 3, 4, 5, 6)
.pairwise()
.subscribe(onNext: {
print($0)
})
.disposed(by: disposeBag)

執行結果

(1, 2)
(2, 3)
(3, 4)
(4, 5)
(5, 6)

如果要用原本寫法,大概會像下面這樣

Observable.zip(observable, observable.skip(1)) { ($0, $1) }
.subscribe(onNext: {
print($0)
})
.disposed(by: disposeBag)

Retry

我們在Error Handling Operators那篇,介紹retryWhen時,寫了延遲retry範例,在RxSwiftExt中,對此作了封裝,讓寫法更佳的簡潔,我們就拿原本retryWhen的範例做修改

let result = subject
.flatMapLatest { _ in
API().request().asObservable().debug("Call")
.retry(.exponentialDelayed(maxCount: 5, initial: 1.0, multiplier: 1.0))
.materialize()
}
.share()

.exponentialDelayed是RepeatBehavior枚舉中的一個case,你也可以選擇只定義次數、固定時間或是自訂時間

public enum RepeatBehavior {
case immediate (maxCount: UInt)
case delayed (maxCount: UInt, time: Double)
case exponentialDelayed (maxCount: UInt, initial: Double, multiplier: Double)
case customTimerDelayed (maxCount: UInt, delayCalculator: (UInt) -> DispatchTimeInterval)
}

.exponentialDelayed則是提供一個延遲時間增加的公式initial * pow(1 + multiplier, Double(currentAttempt - 1)),如果multiplier是1,那延遲時間就是2的0次方、2的1次方、2的2次方,依此類推

RepeatWithBehavior

repeatWithBehavior跟retry極為相似,retry是偵測到.error後進行retry,而repeatWithBehavior是偵測到.completed後進行repeat

let result = subject
.flatMapLatest { _ in
API().request().asObservable().debug("Call")
.repeatWithBehavior(.exponentialDelayed(maxCount: 5, initial: 1.0, multiplier: 1.0))
.materialize()
}
.share()

Errors, Elements

我們在Transforming Operators:map、flatMap 與 materialize 所提到的 materialized+elements.swift 也被整合進RxSwiftExt中了。

ofType

ofType可以篩選出元素的type

let result = Observable.of(NSNumber(value: 1),
NSDecimalNumber(string: "2"),
NSNumber(value: 3),
NSNumber(value: 4),
NSDecimalNumber(string: "5"),
NSNumber(value: 6))
result
.ofType(NSDecimalNumber.self)
.subscribe { print($0) }
.disposed(by: disposeBag)

執行結果

next(2)
next(5)
completed

如果要用原本寫法,大概會像下面這樣

result
.filter { $0 is NSDecimalNumber }

Partition

partiion可以幫你做二分流,也就是符合條件的是一個Observable,不符合條件的是另一條Observable

let (evens, odds) = numbers.partition { $0 % 2 == 0 }
evens.debug("even").subscribe().disposed(by: disposeBag)
odds.debug("odds").subscribe().disposed(by: disposeBag)

執行結果如下

even -> subscribed
even -> Event next(2)
even -> Event next(4)
even -> Event next(6)
even -> Event completed
even -> isDisposed
odds -> subscribed
odds -> Event next(1)
odds -> Event next(3)
odds -> Event next(5)
odds -> Event completed
odds -> isDisposed

UIViewPropertyAnimator.animate

這是對RxCocoa進行擴增,所以需要安裝pod 'RxSwiftExt/Core',animate提供.subscribe跟.completed時觸發動畫

建立UI

let button = UIButton(frame: .zero)
let myView = UIView(frame: .zero)

建立動畫

var animator1: UIViewPropertyAnimator!
var animator2: UIViewPropertyAnimator!
private func makeAnimators() {
// 1
animator1 = UIViewPropertyAnimator(duration: 0.3, curve: .easeInOut) { [unowned self] in
self.myView.transform = self.myView.transform.translatedBy(x: 0, y: 100)
}
// 2
animator2 = UIViewPropertyAnimator(duration: 0.3, curve: .easeInOut) { [unowned self] in
self.myView.transform = self.myView.transform.scaledBy(x: 1.5, y: 1.5)
}
}
  1. myView下移100距離
  2. myView放大1.5倍

綁定事件

button.rx.tap
.flatMap {
self.animator1.rx.animate()
.andThen(self.animator2.rx.animate(afterDelay: 0.15))
}
.subscribe()
.disposed(by: disposeBag)

當按鈕點擊myView會先下滑,延遲0.15秒,後放大1.5倍

UIScrollView.reachedBottom

在UITableView + Rx:從綁定到 ViewModel 當中,我們實現Infinite scroll,需要偵測UITableView滑至最底,所以我們寫了

func bindViewModel() {
tableView.rx.setDelegate(self).disposed(by: disposeBag)
...
}
extension ProductListViewController: UITableViewDelegate {
func tableView(_ tableView: UITableView, willDisplay cell: UITableViewCell, forRowAt indexPath: IndexPath) { ... }
}

RxSwiftExt對這行為作了封裝,寫法變得更加簡潔,於是我們可以改寫成,且允許設定offset距離

tableView.rx.reachedBottom(offset: 40)
.bind(to: viewModel.triggerNextPage)
.disposed(by: disposeBag)

在研究RxSwiftExt時,發現有些很實用的作法,對比之前的作法,更加的簡潔,也更加可讀。