[RxSwift] Relay란?

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

저번 Rx 게시글이었던 Subject에 이어 Relay에 대해서도 한 번 정리해보려고 합니다.

이번에도 RxSwift: Reactive Programming with Swift 책을 참고해서 정리를 해보도록 하겠습니다!

Subject에 대해 잘 모르시겠다면 아래의 게시글을 먼저 읽고 오시는 것을 추천드립니다.

[RxSwift] Subject란?

Relay란?

Relay는 Subject의 Wrapper 클래스로, RxCocoa 내부에 import 되어있습니다!

그러면 이제 구조적인 부분이 궁금해지는데요.. 그래서 ReactiveX의 Github문서를 확인해보았습니다..!

RxSwift 파트 설명을 찾아보면,  <understand the structure> 이라는 파트에 다음과 같은 설명이 나와있습니다.

 

RxSwift의 구조

 

RxSwift의 핵심 단위는 RxSwift 그 자신이며, UI 작업, 테스트 등을 위해 다른 종속성이 추가될 수 있습니다.

위의 그림과 같은 방식으로 서로 의존하는 다섯 개의 개별 구성 요소로 구성됩니다.

 

• RxSwift: RxSwift의 핵심으로, (대부분) ReactiveX에 의해 정의된 Rx 표준을 제공합니다. 다른 종속성은 가지지 않습니다.
• RxCocoa: 일반적인 iOS/macOS/watchOS & tvOS 앱 개발을 위해 Shared Sequences, Traits 등과 같은 코코아 고유의 기능을 제공합니다. 이는 RxSwift와 RxRelay에 의존합니다.
• RxRelay: PublishRelay, BehaviorRelay, ReplayRelay 라는 세 가지 Subject에 대한 wrapper 클래스를 제공합니다. 이는 RxSwift에 의존합니다.
• RxTest & RxBlocking: Rx 기반 시스템에 대한 테스트 기능을 제공합니다. 이는 RxSwift에 의존합니다.

그림으로 보니 RxSwift의 구조와 의존관계가 한눈에 잘 파악되는 것 같습니다!

RxRelay는 RxCocoa에 내장된 Subject의 Wrapper 클래스라고 했으니 UIEvent 처리에서 Subject와 같은 역할로 사용할 수 있는 클래스일 것 같다는 유추를 해볼 수 있을 것 같은데요, Subject와의 차이점에 대해 간략하게 살펴보고 코드로 하나씩 보면서 더 자세히 알아봅시다. (여기서부터는 raywenderlich 책을 번역하면서 정리해보겠습니다!)

 

observable, subject와 다르게 relay에는 accept(_:)메서드를 통해 값을 추가합니다. 즉, relay에서는 onNext(_:)를 사용하지 않습니다! 왜냐하면, relay는 값을 accept하는 것만 가능하기 때문입니다. 이는 relay에 error나 completed 이벤트를 추가할 수 없다는 말과 동일하며, 여기서 알 수 있는 subject와의 차이점은 relay는 종료되지 않음을 보장한다는 것입니다.

PublishRelay

// 1
let relay = PublishRelay<String>()
let disposeBag = DisposeBag()

// 2
relay.accept("Knock knock, anyone home?")

// 3
relay
    .subscribe(onNext: {
        print($0)
    })
    .disposed(by: disposeBag)

// 4
relay.accept("1") // Print: 1

 

1번 주석부터보면, 1에서 relay의 생성방법은 subject와 다른점이 없습니다! 

그러나 2번에서 relay에 값을 추가하는 과정을 보면 onNext(_:)가 아닌 accept(_:) 메소드를 이용하고 있는 것을 확인할 수 있습니다.

2번에서 새로운 값을 추가해주었지만 아직 subscriber가 없으니 아무 값도 방출되지 않겠죠?

3번에서 subscriber를 생성해주고 생성 이후 4번에서 새로운 값인 "1"을 추가하게 되면 이 값이 프린트 됩니다.

여기까지는 PublishSubject와 다른 것이 없습니다! 

그러나, relay에는 error 혹은 completed 이벤트를 추가할 방법이 없습니다. 그렇기 때문에 아래와 같은 코드를 추가한다면 컴파일러 오류가 나게 됩니다.

 

relay.accept(MyError.anError)
relay.onCompleted()

 

정리해보면, PublishRelay는 새로운 값을 onNext(_:) 가 아니라 accept(_:)를 이용해서 추가한다는 것을 제외하고는 PublishSubject와 동일하게 작동하며 종료되지 않습니다.

BehaviorRelay

BehaviorRelay도 당연히 completed나 error 이벤트로 종료되지 않는다는 점은 동일합니다.

PublishRelay와 다른점은 BehaviorRelay는 BehaviorSubject를 래핑한 클래스이기 때문에 초기값을 가지고 생성되며 새로운 subscriber에게 초기값 또는 최신값을 방출한다는 것입니다. 또한, BehaviorRelay의 특별한 기능은 언제든 현재 값을 요청할 수 있다는 것인데, 이 기능은 비동기 프로그래밍에서 유용하게 사용될 수 있습니다.

코드로 살펴봅시다!

 

// 1
let relay = BehaviorRelay(value: "Initial value")
let disposeBag = DisposeBag()
        
// 2
relay.accept("New initial value")
        
// 3
relay
    .subscribe {
        print(label: "1)", event: $0) // Prints: 1) New initial value
    }
    .disposed(by: disposeBag)

 

위의 코드는 직관적으로 이해가 될 것 같은데요!

간략하게 설명해보자면, 초기값을 가지는 BehaviorRelay를 생성하고 이에 "New initial value"라는 값을 accept(_:)를 이용해 추가해줍니다. 이후에 subscriber가 생성되지만 BehaviorRelay는 새로운 subscriber에게 최신의 값을 방출하기 때문에 구독 이전에 추가된 값이 방출되어 "1) New initial value" 라는 값이 찍히게 됩니다.

이제 아래의 코드를 추가해봅시다!

 

// 1
relay.accept("1")

// 2
relay
  .subscribe {
    print(label: "2)", event: $0)
  }
  .disposed(by: disposeBag)
  
// 3
relay.accept("2")

/* Prints
1) 1
2) 1
1) 2
2) 2
*/

 

위에서부터 보면, 아래와 같은 흐름으로 새로운 값과 구독이 추가되었습니다.

1. relay에 새로운 값 추가

2. relay에 새로운 구독 추가

3. relay에 또 다른 새로운 값 추가

 

이렇게 되면 이미 구독하고 있던 1)이 relay에 추가된 "1" 이라는 값을 받게 되어 "1) 1" 이 먼저 프린트 되고, 2)라는 구독이 추가될 때 최신의 값을 받게 되니 그 다음으로 "2) 1"이 프린트됩니다. 그런 다음, 3번 주석에서 "2" 라는 값이 추가되면 1), 2) 구독 모두 그 값을 받게 되니 "1) 2"와 "2) 2" 가 순서대로 출력되는 것입니다.

 

BehaviorRelay에는 언제든 현재의 값에 접근할 수 있다는 한 가지 특별한 기능이 있다고 했죠?

아래와 같이 relay.value 로 접근할 수 있고, 위의 코드에서 가장 최근에 추가된 "2" 라는 값이 콘솔에 출력되게 됩니다.

 

print(relay.value) // Print: 2

ReplayRelay

ReplayRelay는 RxSwift 6에서 새롭게 추가된 연산자 클래스입니다.

당연히 ReplaySubject의 Wrapper 클래스이며, 그렇기 때문에 정해진 버퍼 사이즈를 가진 채로 초기화되고 버퍼 사이즈 만큼의 값들을 유지하면서 새로운 subscriber에게 방출한다는 동일한 특성이 있습니다. 다른 relay들과 같이 error나 completed로 종료되지 않으며 accept(_:)로 새로운 값들을 추가한다는 것을 제외하면 ReplaySubject와 동일하니 따로 예시 코드는 추가하지 않겠습니다!