[RxSwift] Driver란 ? (feat. bind)

 

observable을 생성하고 구독 할 때 가끔 subscribe 대신 asDriver(), drive()로 받는 경우가 있습니다 .. 뭐지 ?? 하면서 잊고 살던 중 traits 관련 문서를 읽고 

driver가 있어 정리 해보려구 합니다 !

참고 문서 : https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Traits.md#driver

GitHub - ReactiveX/RxSwift: Reactive Programming in Swift

 

---

 

Driver

 UI layer에서 좀 더 직관적으로 사용하도록 제공하는 trait

 

trait이란 ?

"모든 경계에서 사용할수 있는 원시 Observable과 비교할때 인터페이스 경계에서 observable 프로퍼티를 전달하고 보장하며, 문법적으로도 더 쉽고 구체적인 사용 사례를 타켓팅하는데 도움이됩니다" 

라고 정의되어 있는데 제가 재해석한 trait은 observable 중 명확한 이벤트 규칙을 가지고 있는 친구들인거 같아요. 명확한 의도를 가지고 있다는 것을 보여주기 때문에 선택적으로 사용하는 것 같습니다

 

다시 Driver로 돌아와서 ..

Driver의 특징

• 오류를 방출하지 않는다
• observe는 Main scheulder에서 발생한다.
• 부작용을 공유한다 (?) ex> share(replay: 1, scope: .whileConnected)

부작용을 공유한다는 말이 무슨 말인가 해서 보니 아래 예시가 나와 있네요

let results = query.rx.text
    .throttle(.milliseconds(300), 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)

 

위 코드를 보면

1. query에 대해 fetchAutoCompleteItems (서버에서 query)결과 값 가져오기 수행

2. 가져온 resultfmf resultCount, tableview UI에 바인딩하고 있습니다.

 

하지만 위에서 만약 fetchAutoCompleteItems 수행시 에러가 발생하면 어떡할까요 ? 반환값이 없을수도 있고 파싱이 잘못될 수도 있을거 같네요. 에러가 발생한다면 바인딩이 해제되고 UI가 더이상 새로운 쿼리에 대해 업데이트 되지 않을 것입니다.

또한 fetchAutoCompleteItems 작업 중 일부는 백그라운드 스레드에서 실행 될 수도 있습니다. 모든 UI는 메인 스레드에서 실행되어야 하는데 말이죠.

더욱이 result는 두가지 요소(resultCount, tableview)에 바인딩 되어 있습니다. 즉 각 사용자 쿼리에 대해 두개의 HTTP 요청이 만들어지고, 각 UI요소에 하나씩 의도된 동작이 아닙니다

 

따라서 아래와 같이 수정되어야 할 것입니다.

let results = query.rx.text
    .throttle(.milliseconds(300), scheduler: MainScheduler.instance)
    .flatMapLatest { query in
        fetchAutoCompleteItems(query)
            .observeOn(MainScheduler.instance)  // results are returned on MainScheduler
            .catchErrorJustReturn([])           // in the worst case, errors are handled
    }
    .share(replay: 1)                           // HTTP requests are shared and results replayed
                                                // to all UI elements

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)

 

또는 아래와 같이 작성될 수 있습니다.

let results = query.rx.text.asDriver()        // This converts a normal sequence into a `Driver` sequence.
    .throttle(.milliseconds(300), scheduler: MainScheduler.instance)
    .flatMapLatest { query in
        fetchAutoCompleteItems(query)
            .asDriver(onErrorJustReturn: [])  // Builder just needs info about what to return in case of error.
    }

results
    .map { "\($0.count)" }
    .drive(resultCount.rx.text)               // If there is a `drive` method available instead of `bind(to:)`,
    .disposed(by: disposeBag)              // that means that the compiler has proven that all properties
                                              // are satisfied.
results
    .drive(resultsTableView.rx.items(cellIdentifier: "Cell")) { (_, result, cell) in
        cell.textLabel?.text = "\(result)"
    }
    .disposed(by: disposeBag)

바뀐 코드를 보면 

let results = query.rx.text.asDriver()

asDriver : ControlProperty trait을 Driver trait으로 바꾸었습니다.

 

두번째 변화는

 

.asDriver(onErrorJustReturn: [])​

observable 시퀀스를 Driver trait으로 바꾸었습니다. 

따라서 Driver의 특성을 만족하게 됩니다 (1. 오류 방출 x, 2. 메인 스레드에서 실행, 3. 부작용을 공유 ex) share )

asDriver()는 아래와 같은 효과를 가집니다.

let safeSequence = xs
  .observeOn(MainScheduler.instance)        // observe events on main scheduler
  .catchErrorJustReturn(onErrorJustReturn)  // can't error out
  .share(replay: 1, scope: .whileConnected) // side effects sharing

return Driver(raw: safeSequence)            // wrap it up

 

마지막으로 

.drive(resultCount.rx.text)

resultCount를 bind 하는 대신 drive 해주었습니다.

bind(to: )와 같은 효과를 가지지만 Driver trait의 특성을 만족하게끔 보장합니다.

 

Driver에 대해 살펴보았습니다. bind와 같은 역할을 하지만 Driver trait을 보장한다는 점에서 UI 바인딩을 할때 매우 유용할 것 같군요 trait의 유용함을 점점 더 알아가는 것 같습니다. 

 

다음 글에서는 

남은 ControlProperty, ControlEvent, Signal trait에 대해 공부 해보도록 하겠습니다 그럼 안뇽