[RxSwift] Subject란?

알엑스..영업합니다...네..해요...

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

참 오랜만에 RxSwift 게시글 쓰게 되었습니다.. 문 닫은거 아니구요 정상영업하려구요.. 네..

사실 그동안 RxSwift 공부를 아예 안한 것은 아닌데요.. 뭔가 게시글을 쓸 때 확실한 정보를 전달해야한다는 생각에 좀 더 공부하고 정리해서 올리자 좀 더 하고... 하다가 이렇게 미루게 된 것 같네요 하핫

이제 더 이상 미룰 수 없다! 많이 부족해도 글로 정리하면서 확실히 이해하는 부분들이 많은 것 같기도 하고, 최근에 프로젝트에서 RxSwift를 이용해 비동기 처리를 할 일이 많은데 정확히 알지 못하는 부분이 많다고 느꼈습니다.. 그래서 제대로 알고 코드를 짜고 싶어서 다시 RxSwift 공부를 열심히하며 티스토리에도 정리를 해보려고 합니다! 

마지막으로 Observable에 대해 정리했더라구요.. 그래서 Subject부터 다시 시작해보겠습니다 아좌좌!

 

이번 게시글은 RxSwift: Reactive Programming with Swift 책의 Subjects 챕터와 ReactiveX 의 문서를 번역하면서 Subject에 대해 정리해보도록 하겠습니다. 

Subject란?

Subject를 한마디로 정의하자면 Observable이자 Observer인 것입니다.

이것이 대체 무슨 말이냐... 지금부터 차근차근 알아가봅시다.

 

Observable은 '관찰가능한 데이터의 흐름' 정도로 정의할 수 있으며 일정기간 동안 계속해서 이벤트를 생성하여 방출하는 객체입니다.

하지만 실제 앱 개발에서 일반적으로 필요한 것은 실시간으로 Observable에 새로운 값을 수동으로 추가하고 subscriber에게 방출하는 것입니다. 즉, observable이자 observer로 동작하는 무언가가 필요하다는 것이죠. 우리가 필요한 이 무언가가 바로 Subject입니다.

 

본격적으로 Subject에 대해 알아가기에 앞서 간단한 코드부터 보고 시작해봅시다!

 example(of: "PublishSubject") {

     // 1
     let subject = PublishSubject<String>()

     // 2
     subject.onNext("Is anyone listening?")

     // 3
     let subscriptionOne = subject
         .subscribe(onNext: { (string) in
             print(string)
         })

     // 4
     subject.on(.next("1"))		// Print: 1

     // 5
     subject.onNext("2")		// Print: 2
 }

PublishSubject를 이용한 간단한 코드인데요, 주석을 따라가면서 코드를 살펴봅시다.

1. PublishSubject 생성

먼저 subject라는 이름의 PublishSubject 객체를 하나 생성해주었는데요,

PublishSubject는 이름에서도 유추할 수 있듯이 신문 출판사처럼 정보를 받아 구독자들에게 배포합니다. (PublishSubject에 대해서는 뒤에서 더 자세히 정리할게요!) 위의 코드에서는 String 타입으로 생성했으니 String 형의 정보만 받을 수 있고 또 배포할 수 있겠죠? 

객체가 초기화되었다면 이제 정보를 받을 준비가 되었다는 것입니다.

 

2~3. 구독을 하지 않은 상태라면 값은 전달되지 않는다

2번 코드에서 subject에 새로운 문자열 값이 추가되었습니다. 하지만, 이 코드는 프린트되지 않습니다.

왜냐하면 아직 observer가 없기 때문입니다.

그래서 3번에서 subject를 subscribe 해주었습니다. 그러나 여전히 아무것도 출력되지 않습니다.

왜 구독을 했는데도 출력이 되지 않냐면! PublishSubject는 오직 현재의 subscriber에게만 이벤트를 방출합니다. 그렇기 때문에 이벤트가 추가되었을 때 구독을 하지 않고 있었다면 구독한 이후에도 그 값을 받을 수 없습니다. 

 

4~5. 구독 이후 추가된 값 내보내기

이제 구독을 했으니 이후에 추가되는 값들은 모두 전달받을 수 있겠죠??

당연한 이야기겠지만 subject를 String 타입으로 선언했기 때문에 추가되는 next 이벤트 내의 값은 String 타입이어야만 합니다! .on(.next(_:))는 subscribe 연산자와 유사한 방식으로 새로운 next 이벤트를 subject에 추가하고, 이벤트 내의 값들을 파라미터로 통과시키는 연산자입니다. 이 연산자도 subscribe와 마찬가지로 축약형이 존재합니다. 5번 코드와 같이 .onNext(_:)로 축약해서 훨씬 더 보기 편하게 사용할 수 있습니다! 이제 추가된 값이 모두 프린트되는 것을 확인할 수 있습니다.

Subject의 종류

Subject는 observable인 동시에 observer인 것입니다.

위에서 간단한 코드를 통해서 subject가 어떻게 이벤트를 받는지(observer의 역할), 그리고 어떻게 구독되는지(observable의 역할)를 살펴보았습니다. next 이벤트를 받아서 이것을 다시 subscriber에게 방출하는 과정을 간단히 살펴보았는데 subject에 대해 조금 이해가 가시나요??? 이제 Subject의 종류에 대해 알아보겠습니다!

 

RxSwift에는 4가지 종류의 Subject가 있습니다.

 

• PublishSubject: 빈 상태로 시작하여 새로운 값만을 subscriber에 방출합니다. 
• BehaviorSubject: 초기값을 가진 상태로 시작하여, 새로운 subscriber에게 초기값 또는 최신값을 방출합니다.
• ReplaySubject: 정해진 버퍼 사이즈를 가진 채로 초기화되고 버퍼 사이즈 만큼의 값들을 유지하면서 새로운 subscriber에게 방출합니다. 
• AsyncSubject: subject가 completed 이벤트를 받을 때만 시퀀스의 마지막 next 이벤트만을 방출합니다. (거의 사용되지 않는 Subject이기 때문에 raywenderich 책에서 다루지 않는다고 합니다)

하나씩 자세히 살펴봅시다!

PublishSubject

PublishSubject는 구독된 순간 구독자들에게 새로운 이벤트 수신을 알리고 싶을 때 용이합니다.

이는 구독을 멈추거나 혹은 subject가 completed나 error 이벤트로 종료될 때까지 지속됩니다.

 

위의 그림에서 맨 윗줄이 PublishSubject를 나타낸 것이고, 그 아래 두 줄이 구독자들입니다.

위로 향하는 화살표들은 구독을 나타내고, 아래로 향하는 화살표들은 이벤트의 방출을 나타내는 것인데요,

두번째 줄에서는 1번이 추가된 이후에 구독을 했기 때문에 구독 시점 이후에 방출되는 2, 3 이벤트만을 받는 것을 확인할 수 있으며, 마지막 줄에서는 2번까지 추가된 이후에 구독했기 때문에 3번 이벤트만을 받은 것을 알 수 있습니다.

 

코드로 한 번 살펴봅시다!

 example(of: "PublishSubject") {
     let subject = PublishSubject<String>()
     subject.onNext("Is anyone listening?")

     // 첫번째 subscriber
     let subscriptionOne = subject
         .subscribe(onNext: { (string) in
             print(string)
         })
     subject.on(.next("1"))
     subject.onNext("2")

     // 1
     // 두번째 subscriber
     let subscriptionTwo = subject
         .subscribe({ (event) in
             print("2)", event.element ?? event)
         })

     // 2
     subject.onNext("3")
     
     // Print: 3
     // Print: 2) 3

     // 3
     subscriptionOne.dispose()
     subject.onNext("4")
     
     // Print: 2) 4

     // 4
     subject.onCompleted()
     
     // Print: 2) completed

     // 5
     subject.onNext("5")

     // 6
     subscriptionTwo.dispose()

     let disposeBag = DisposeBag()

     // 7
     subject
         .subscribe {
             print("3)", $0.element ?? $0)
     }
         .disposed(by: disposeBag)
         
    // Print: 3) completed

     subject.onNext("?")
 }

처음에 시작하면서 봤었던 코드 아래 부터 주석을 따라가면서 살펴볼게요!

 

1. 두번째 subscriber 추가 

subscriptionTwo라는 이름으로 두번째 구독자를 추가해주었습니다.

이벤트들은 옵셔널 값을 가지고 있으며, 이 값들은 next 이벤트로 방출되기 때문에 nil 병합 연산자를 이용하여 nil이 아니라면 값이 프린트되도록하고 nil이라면 이벤트만 프린트되도록 해주었습니다.

 

2. 구독자가 두 명인 상태에서 subject에 새로운 값 추가

subject에 "3"이라는 값을 추가해주었습니다.

현재 구독자가 subscriptionOne, subscriptionTwo 두 명이기 때문에 3이라는 값은 구독자들에 의해 한 번씩 출력되어 총 두 번 프린트되게 됩니다.

3
2) 3

 

3. subscriptionOne 구독 중단 후 subject에 새로운 값 추가

.dispose()를 통해 첫번째 구독자의 구독을 중단시켰습니다. 이렇게 되면 이제 구독자가 subscriptionTwo 밖에 없기 때문에 이후 추가되는 값인 "4"는 한 번만 출력되게 됩니다.

2) 4

 

4. subject 종료

PublishSubject가 completed나 error 같은 종료 이벤트를 받게 된다면, subject는 더 이상 구독자들에게 새로운 next 이벤트들을 방출하지 않을 것입니다. 그러면 이제 아무것도 출력되지 않는다고 예상할 수 있습니다.

하지만, subject는 이러한 종료 이벤트들을 이후 새 subscriber들에게 재방출합니다. 그러므로 completed가 출력되게 됩니다.

2) completed

 

5~7. subject 종료된 이후 새로운 구독자 추가

subject는 completed 이벤트를 받아 이제 종료되었으니 5번에서 새로운 값이 추가되지만 이를 방출하지는 않습니다. 

6번에서는 두 번째 구독자가 구독을 중단하고 7번에서는 새로운 구독자가 생기게 되는데요, subject는 이미 종료된 상태에서 새로운 subscriber가 생긴다고 해서 종료된 subject가 다시 작동하지는 않습니다. 다만, .completed 이벤트만을 방출합니다.

3) completed

 

이를 통해 subject가 종료되었을 때 기존에 존재하는 구독자들에게만 종료 이벤트를 전달할 뿐만 아니라 그 이후에 구독한 subscriber에게도 종료 이벤트를 알려준다는 특징이 있다는 것을 알 수 있었습니다. 이것이 때때로 버그의 원인이 될 수 있으니 주의해야 할 것 같습니다!

BehaviorSubject

BehaviorSubject는 마지막 next 이벤트를 새로운 구독자에게 반복한다는 점만 빼면 PublishSubject와 유사합니다.

 

위의 그림을 통해 한 번에 이해할 수 있을 것 같은데요, 첫 줄이 BehaviorSubject이고 그 아래 두 줄이 subscriber들입니다!

첫번째 구독자인 두번째 줄은 1번 이벤트가 발생된 이후에 구독을 시작하는데, 구독 즉시 마지막 이벤트인 1을 받고 이후에 방출되는 값들을 받는 것을 확인할 수 있습니다. 마지막 줄도 마찬가지로 구독을 시작할 때 구독 전의 마지막 이벤트를 받습니다.

 

이제 코드를 통해 살펴봅시다!

 // 1
 enum MyError: Error {
     case anError
 }

 // 2
 func print<T: CustomStringConvertible>(label: String, event: Event<T>) {
     print(label, event.element ?? event.error ?? event)
 }

 //3
 example(of: "BehaviorSubject") {

     // 4
     let subject = BehaviorSubject(value: "Initial value")
     let disposeBag = DisposeBag()
 }

 

1. 에러 타입 정의

발생할 수 있는 에러를 Error enum으로 만들어줍니다.

 

2. print 함수 정의

Generic 문법을 사용해 이벤트 내에 값이 있으면 값을 프린트하고, 에러가 있으면 에러를, nil이라면 이벤트만을 출력할 수 있는 print 메소드를 만들어줍니다.

 

3~4. BehaviorSubject 객체 생성

새로운 BehaviorSubject 객체를 생성합니다. 

BehaviorSubject는 항상 최신의 값을 방출하기 때문에 반드시 초기값을 가져야 합니다!

 

4번의 하단에 아래의 코드를 추가해봅시다.

// 6
subject.onNext("X")

// 5
subject
    .subscribe{
        print(label: "1)", event: $0)
    }
    .disposed(by: disposeBag)
        
// 7
subject.onError(MyError.anError)
        
// 8
subject
    .subscribe {
        print(label: "2)", event: $0)
    }
    .disposed(by: disposeBag)

 

 

5. 생성한 subject를 구독하고 dispose

1) Initial value

위에서 생성한 subject를 구독하면, subject 생성 이후 다른 값이 추가되지 않았기 때문에 위와 같이 초기값이 프린트 됩니다.

 

6. subject를 구독하기 전에 새로운 값을 추가한다면

1) X

5번 코드 상단에 subject에 "X"를 가진 .onNext(_:) 메소드를 추가해봅시다. 이렇게 되면 subject를 구독하기 전 최신의 값이 "X"가 되기 때문에 초기값인 Initial Value가 아니라 X가 출력됩니다. 

 

7~8. subject에 error 이벤트 추가 후 구독하기

1) anError
2) anError

subject에 error 이벤트를 추가하고 새로운 구독자를 추가해주었습니다.

이렇게 되면 두 명의 구독자에 의해 error 이벤트가 한 번씩 찍혀 총 두 번 출력되게 됩니다.

 

BehaviorSubject의 경우 뷰를 최신 데이터로 미리 채우려는 경우 유용하게 사용할 수 있을 것 같습니다!

예를 들어, 사용자 프로필 화면의 컨트롤을 BehaviorSubject에 바인딩하여 앱이 새 데이터를 가져오는 동안 최신 값을 사용하여 뷰를 미리 채워 놓을 수 있습니다.

ReplaySubject

ReplaySubject는 생성 시 설정한 특정 사이즈까지, 방출하는 최신 요소를 일시적으로 cache하거나 buffer하고 해당 버퍼를 새로운 구독자에게 방출합니다.

 

위의 그림에서 첫번째 줄이 버퍼 사이즈가 2인 ReplaySubject, 그 아랫줄들은 구독자들입니다.

첫번째 구독자(중간줄)는 이미 subject를 구독하고 있는 상태이기 때문에 1과 2가 방출되면 이들을 받습니다.

두번째 구독자(마지막줄)는 2가 방출된 이후 구독하게 됩니다. 그러나 버퍼 사이즈인 2만큼의 값을 받게 되어 구독 이전에 방출된 1과 2를 모두 받게 됩니다.

 

주의해야 할 점은 ReplaySubject의 버퍼는 메모리가 가지고 있다는 점입니다.

그렇기 때문에 이미지나 배열과 같이 메모리를 크게 차지하는 값들을 큰 사이즈의 버퍼로 가지는 것은 메모리에 엄청난 부하를 주게 됩니다.

 

코드로 살펴봅시다.

 example(of: "ReplaySubject") {

     // 1
     let subject = ReplaySubject<String>.create(bufferSize: 2)
     let disposeBag = DisposeBag()

     // 2
     subject.onNext("1")
     subject.onNext("2")
     subject.onNext("3")

     // 3
     subject
         .subscribe {
             print(label: "1)", event: $0)
         }
         .disposed(by: disposeBag)

     subject
         .subscribe {
             print(label: "2)", event: $0)
         }
         .disposed(by: disposeBag)
 }

 

1. subject 생성

버퍼 사이즈가 2인 ReplaySubject를 생성합니다. ReplaySubject는 .create(bufferSize:) 메소드를 이용하여 생성 및 초기화될 수 있습니다.

 

2. subject에 새로운 값 추가

생성한 subject에 1, 2, 3이라는 세 가지 새로운 값을 추가했습니다.

 

3. subject 구독

1) 2
1) 3
2) 2
2) 3

subject에 대한 구독자들을 두 개 생성하게 되면 위에서 추가한 값들 중 어떤 값이 출력될까요??

마지막 2개의 값들이 각각의 구독자들에 의해 한 번씩 출력되게 됩니다. 왜냐하면 버퍼 사이즈가 2이기 때문입니다!

 

3번 코드 하단에 아래의 코드를 추가해보겠습니다!

 subject.onNext("4")

 subject.subscribe {
     print(label: "3)", event: $0)
     }
     .disposed(by: disposeBag)

새로운 값인 "4"를 subject에 추가한 후, 새로운 구독자를 생성해주었습니다.

"4"라는 새로운 값이 추가되면 기존의 구독자들( 1), 2) )은 이 값을 받게 될 것이고, 새로운 구독자는 버퍼 사이즈인 2만큼 최신의 값을 받게 되므로 아래와 같이 출력되게 됩니다.

1) 4
2) 4
3) 3
3) 4

 

그렇다면 subject가 error 이벤트를 받게 된다면 어떻게 출력될까요?? 

아래의 코드를 subject.onNext("4") 하단(새 구독자 생성 전)에 추가해보겠습니다.

subject.onError(MyError.anError)

/* Prints:
1) 4
2) 4
1) anError
2) anError
3) 3
3) 4
3) anError
*/

subject가 error를 통해 종료되고 난 이후의 구독자인 3)에게 error 이벤트를 재전송하고 있습니다. 그런데 이 때 3)에게 버퍼에 있는 값들 또한 전달하고 있는 것을 확인할 수 있습니다. 이런 결과가 나오는 이유는 subject가 종료되었어도 버퍼는 여전히 돌아다니고 있기 때문입니다. error를 추가한 다음에 이벤트의 재방출을 막으려면 dispose()를 사용하면 됩니다.

subject.dispose()

 /* Prints:
  3) Object `RxSwift.(ReplayMany in _33052C2CE59F358A8740AFDD4371DD39)<Swift.String>` was already disposed.
  */

위의 코드를 추가하게 되면, 새로운 구독자는 에러 이벤트만 받게 됩니다. 왜냐하면 구독 전에 subject 자체가 dispose 되기 때문입니다.

그러나, ReplaySubject에 명시적으로 dispose()를 호출하는 것은 일반적으로 필요한 작업은 아닙니다.

왜냐하면 만약 subject의 구독을 disposeBag에 넣고, ViewController나 ViewModel 같은 해당 subject의 소유자가 할당 해제되면 모든 것들이 dispose 될 것이기 때문입니다.

 

여기까지 Subject에 대해 알아보았는데요.. 힘드네요...

Subject를 이해하는 데 조금이나마 도움이 되었으면 좋겠고 앞으로도 RxSwift 게시글을 꾸준히 올려보도록 노력해보겠습니다..ㅎ