[RxSwift] Traits - Driver, Signal, Control Property/ControlEvent

안녕하세요 제인입니다 :) 

지난 게시글에 이어 이번 게시글에서는 RxCocoa의 Traits에 대해 정리해보겠습니다.

이번 게시글도 ReactiveX/RxSwift의 Traits 문서 번역을 통해 작성하겠습니다!

RxCocoa Traits의 종류

RxCocoa의 Traits로는 Driver, Signal, Control Property/ControlEvent가 있습니다.

하나씩 살펴보겠습니다!

Driver

Driver는 가장 정교한 trait입니다. UI 계층에서 reactive 코드를 작성하는 직관적인 방법을 제공하거나 애플리케이션을 구동(driving)하는 데이터 스트림을 모델링하려는 모든 경우에 사용할 수 있습니다. 

+ Driver라는 이름이 붙은 이유? Driver의 목적 자체가 애플리케이션을 구동(drive)하는 시퀀스를 만드는 것이기 때문

Driver의 특징

1. 에러를 방출하지 않습니다. 

시퀀스 에러가 발생하게 되면 애플리케이션이 사용자 입력에 대한 응답을 멈추게 됩니다.

 

2. observe는 Main Scheduler에서 발생합니다.

UI 요소들과 로직은 일반적으로 thread safe 하지 않기 때문에 이러한 요소들이 메인 스레드에서 관찰되는 것은 매우 중요합니다.

 

3. 부수작용을 공유합니다.(share(replay: 1, scope: .whileConnected))

Driver는 부수작용을 공유하는 observable 시퀀스를 만듭니다.

share(replay: , scope: )
한번 생성한 시퀀스를 공유해 사용할 수 있도록 하는 operator입니다. share를 사용하면 발생한 이벤트가 버퍼에 저장되고, 새로운 subscription은 새로운 데이터 시퀀스를 생성하는 것이 아니라 버퍼에 저장된 이벤트를 전달받게 됩니다. 

- replay: 버퍼 사이즈(신규 subscriber에게 이전 방출했던 요소를 몇 개를 기록했다가 방출할(replay) 것인가)
- scope
    1) .whileConnected: subscriber가 한 개 이상 있으면 replay가 유지되지만, dispose되어 0개가 되면 replay 버퍼 초기화
    2) .forever: subscriber가 없어도 버퍼 유지

예제 코드

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. 사용자 input 조절(throttle)

throttle operator
throttle은 이벤트가 발생하는 최소 간격을 제한할 수 있는 operator입니다. 
지정된 기간(dueTime 설정) 안에 수많은 이벤트가 발생해도, 2개 이상 요소가 방출되지 않도록 합니다.

2. 서버 요청을 통해 사용자 결과 목록을 가져오기 (쿼리당 한 번)

3. 결과를 두 UI 요소에 바인딩 (reulstCount, resultsTableView)

 

이 코드의 문제점은 무엇일까요?

 

• 만약 fetchAutoCompleteItems 시퀀스에서 오류가 발생하면, 오류는 모든 바인딩을 해제하고 UI가 더 이상 새 쿼리에 응답하지 않게 됩니다.
• fetchAutoCompleteItems가 일부 백그라운드 스레드에서 결과를 반환하면 결과가 UI 요소에 바인딩되는 과정에서 충돌이 발생할 수 있습니다.
• 결과를 두 개의 UI 요소에 바인딩하면서, 같은 쿼리에 대해 두 개의 HTTP 요청을 수행하게 됩니다. (의도된 동작이 아님)

다음과 같이 개선하여 위의 문제점들을 해결할 수 있습니다.

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)

첫번째 코드와의 차이점을 보면,

.observeOn(MainScheduler.instance) 를 통해 메인 스케줄러에서 작업이 수행되도록 하고, .catchErrorJustReturn()을 통해 에러 상황에 대비(error 발생 시 [] 전달)합니다. 

또한, .share(replay: 1) 을 통해 생성된 시퀀스를 공유할 수 있도록 해줍니다.

 

위와 같은 방법으로 문제를 해결할 수 있지만, 대규모 시스템에서 위와 같은 사항들이 적절하게 처리되는지 확인하는 것은 어려울 수 있습니다. -> Driver를 사용하여 더 간단하게 처리할 수 있습니다.

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)

위의 코드에서는,

.asDriver()를 통해 ControlProperty trait를 Driver trait로 변환해주었습니다. (모든 observable sequence는 Driver로 변경가능)

.asDriver(onErrorJustReturn: []) 를 통해 에러 처리를 해주었습니다.

.bind(to:) 대신 drive()를 사용해 UI요소에 적용해주었습니다.

drive는 Driver에 정의된 메서드로, drive를 사용하면 해당 observable 시퀀스는 절대 오류를 방출하지 않으며 UI 요소에 바인딩하기에 안전한 메인 스레드에서 관찰됩니다. 

Signal

Signal은 Driver와 유사하지만 구독 시 최신의 이벤트를 replay 하지 않는다는 차이점이 있습니다.

(Driver는 구독하는 순간 최신의 이벤트를 replay, Signal은 구독한 이후의 값만을 방출)

Signal의 특징

• 에러를 방출하지 않음
• Main Scheduler에서 이벤트를 방출
• 부수작용을 공유 (share(scope: .whileConnected) but Driver와 다르게 버퍼를 가지지 않음) 
• 구독 이전의 event를 replay 하지 않음

ControlProperty / ControlEvent

ControlProperty

UI 요소의 property를 나타내는 Observable/ObservableType 을 위한 Trait입니다.

ControlProperty 시퀀스는 오직 최초의 control value와 사용자가 시작한 값 변경만을 나타냅니다. (코드로 변경된 value change는 감지하지 못함)

ControlProperty의 특징

• 절대 실패하지 않음
• share(replay: 1) 처럼 동작 - subscribe 호출 시 마지막 element가 생성되는 즉시 replay 
• deallocated될 때 complete됨 (메모리 해제 시 complete 이벤트 방출)
• 에러를 방출하지 않음
• Main Thread에서 실행됨

ControlProperty의 실행은 이벤트 시퀀스가 main scheduler에서 subscribe되는 것을 보장합니다. (subscribeOn(ConcurrentMainScheduler.instance))

ControlEvent

UI 요소의 event를 나타내는 Observable/ObservableType 을 위한 Trait입니다.

ControlEvent의 특징

• 절대 실패하지 않음
• 구독 시 초기 값을 내보내지 않음
• deallocated될 때 complete됨 (메모리 해제 시 complete 이벤트 방출)
• 에러를 방출하지 않음
• Main Thread에서 실행됨

ControlEvent의 실행 또한 이벤트 시퀀스가 main scheduler에서 subscribe되는 것을 보장합니다. (subscribeOn(ConcurrentMainScheduler.instance))

---

[참고 자료]

https://github.com/ReactiveX/RxSwift/blob/main/Documentation/Traits.md

https://inuplace.tistory.com/1102

https://ios-development.tistory.com/872