RxSwift - Dispose, Disposable, DisposeBag

Created

2023/09/15 09:36

RxSwift - Dispose, Disposable, DisposeBag

Disposable과 dispose()

Dispose - v. 처리하다/없애다

관찰 가능한 형태 Observable이 있을 때, Observer는 이 Observable을 ‘구독’을 통해 이벤트를 받을 수 있다고 했다.

→ 정확히는 Observer가 Observable이 방출하는 항목에 대해 받는 것

만약 더이상 이 Observable에 대한 이벤트를 받고 싶지 않아서 ‘구독을 해제’ 하고 싶을 때는? → Disposable

Subscrib 메서드 원형

(ref, https://babbab2.tistory.com/186)

이렇게 반환 타입이 Disposable 인 것을 볼 수 있다.

즉, subscribe 메서드를 호출할 경우, Observable을 구독할 수 있지만, 해당 Observable의 이벤트가 더 이상 필요하지 않을 때, 해당 구독을 취소할 수 있는 수단인 Disposable 이란 타입의 값을 리턴하여 준다.

이제 리턴 타입인 Disposable 을 살펴보면

public protocol Disposable {
		func dispose()
}
Swift
복사

이렇게 dispose라는 메서드를 가진 Protocol로 정의되어 있다.

Observer는 Observable을 구독하기 위해 Subscribe라는 메서드를 사용하는데, 이 Subscribe 메서드는 구독을 해제할 때 사용하는 Disposable이란 타입의 인스턴스를 반환한다!

그러면 이 리턴된 Disposable 타입의 값에 대고 dispose() 메서드를 호출하면 우리가 구독한 Observable에 대해 구독을 해제할 수 있다!

let hjDisposable = hjButton.rx
													.tap
													.subscribe(onNext: {
															print("hj 버튼 눌림!")
													})

hjDieButton.rx
					.tap
					.subscribe(onNext: {
								hjDisposable.dispose()
								print("hj 버튼 구독 해제!")
					})
Swift
복사

위 코드를 보면, hjButton의 tap 이벤트에 대해 subscribe를 통해 구독을 하고, 해당 구독을 취소할 수 있는 리턴 값, 즉 Disposable 인스턴스를 hjDisposable이란 변수에 저장했다.

그리고 hjDieButton이 눌렸을 때, 이 hjDisposable의 dispose() 메서드를 호출해본다.

hjDieButton이 눌리기 전까지 잘 동작하던 hjButton의 tap 이벤트가, hjDieButton이 눌리는 순간 hjButton의 tap Observable에 대한 구독을 해제해주기 때문에, 더이상 hjButton의 tap 이벤트에 대한 처리를 할 수가 없어진다.

따라서 구독 해제 후에 버튼을 누르면 더이상 아무런 이벤트를 하지 않게 된다.

요약

Observer가 어떤 Observable의 이벤트를 받고 싶을 경우, Subscribe 메서드로 ‘구독 ’을 통해 할 수 있다.

하지만 더이상 이벤트를 받고 싶지 않아서 ‘구독을 해제’ 할 경우를 대비해 Subscribe 메서드는 Disposable이란 타입의 리턴 값을 준다.

이 Disposable은 프로토콜 타입으로 dispose 메서드를 가지고 있는데, 만약 Observable이 방출하는 이벤트를 더이상 받고 싶지 않은 경우,

Subscribe를 했을 때 얻은 이 Disposable에 대고 dispose() 메서드를 호출할 경우, 해당 Observable에 대한 구독을 해제할 수 있다.

사실 dispose 메서드를 실행하는 건, 해당 시점(내가 원하는 시점)에 해당 이벤트의 구독을 끊기 위한 것도 있지만, 가장 중요한 이유 중 하나는 바로

메모리 관리

를 위해서이다. Observable은 기본적으로, complete나 error가 발생하기 전까진 계속 이벤트를 방출 시키는데, 따라서 이벤트가 더이상 방출되면 안되는 시점에서 우리는 이 리소스를 직접 deinit 해줘야 한다.

먄약 deinit 해주는 과정을 하지 않으면, 이 리소스는 계속해서 필요할 떄마다 이벤트를 방출시키는 메모리 릭(leak) 으로 이어질것이다.

그러면 어떻게 해당 Observable과 관련된 리소스를 deinit 시킬 수 있을까? → dispose() 메서드!

Disposable 타입의 인스턴스의 dispose 메서드를 호출한다는 것은 해당 Observable에 대한 리소스를 deinit 시킨다는 것이다. 즉, Rx에서 메모리 관리를 한다는 것

→ 이렇게 Rx에서 이 dispose는 메모리와 관련이 있기 때문에 아주 중요한 메서드이다.

예를들면

class HjViewController: UIViewController {
		override func viewDidLoad() {
				super.veiwDidLoad()

				let _ = Observable<Int>.interval(
					.seconds(1),
					scheduler: MainScheduler.instance
				)
				.subscribe(onNext: {
						print($0)
				})
		}
}
Swift
복사

HjViewController가 실행되면, 1초에 한번씩 0부터 순차적인 숫자를 방출하는 Observable을 만들고,

해당 Observable을 구독하여 이벤트가 방출됐을 때, 그 숫자를 출력하게 한 것이다.

그리고 해당 구독을 통해 리턴받은 Disposable 타입의 인스턴스로는 아무것도 하지 않는다.

이렇게 될 경우, 어떤 문제가 생기냐면

HjViewController가 생성되어 띄워졌을 때, 1초에 한번씩 순차적인 숫자를 방출하는 Observable이 생성되고, 해당 Observable이 이벤트를 방출 했을 때 subscribe 클로저에 의해 0, 1, 2가 찍히고 있다.

하지만 2까지 찍히고 나서 HjViewController를 내려서, 해당 Observer의 이벤트를 실행하던 ViewController가 앱에서 사라졌음에도 불구하고, 해당 Obserer에 대한 리소스가 해제되지가 않아서, 죽지않고 계속 이벤트를 방출하고 있는 메모리 leak가 발생하고 있다.

따라서

class HjViewController: UIViewController {
		private var timerDisposable: Disposable?

		override func viewDidLoad() {
				super.viewDidLoad()

				timerDisposable = Observable<Int>.interval(
					.seconds(1)
					scheduler: MainScheduler.instance
				)
				.subscribe(onNext: {
						print($0)
				})
		}
		
		deinit {
				timerDisposable?.dispose()
		}
}
Swift
복사

나를 가지고 있는 ViewController가 deinit 되는 시점에 해당 Disposable에 대한 dispose를 통해 해당 Observable 리소스에 대해서도 같이 deinit을 실행시켜주면

ViewController가 deinit 될 때 해당 Observable 리소스에 대한 deinit도 같이 이루어지기 때문에 메로리 누수가 일어나지 않는다.

DisposeBag

말 그대로 Disposable을 담는 Bag이다.

Observable 리소스가 해제되어야 할 시점에 dispose를 호출해주어야 한다고 했다.

하지만 만약 다음과 같이, 해제해줘야 하는 리소스가 많아진다면,

class HjViewController: UIViewController {
		private var timerDisposable: Disposable?
		private var button1Disposable: Disposable?
		private var button2Disposable: Disposable?

...

		deinit {
				timerDisposable?.dispose()
				button1Disposable?.dispose()
				button2Disposable?.dispose()
		}
}
Swift
복사

이렇게 지저분해질것이다.

그래서 Disposable들을 담는 배열을 만든다 → DisposableBag

public final class DisposeBag: DisposeBase {
		private var disposables = [Disposable]()
Swift
복사

RxSwift에서 제공하는 이 DisposeBag 이란 것은 쉽게 말해서 Disposable 객체를 담는 배열이다.

class HjViewController: UIViewController {
		private var disposeBag: DisposeBag = .init()
}
Swift
복사

위처럼, 전역 변수로 disposeBag 하나를 선언해주고, disposable 객체를 이제 어떻게 담냐면,

extension Disposable {
		public func disposed(by bag: DisposeBag) {
				bag.insert(self)
		}
Swift
복사

Disposable 프로토콜의 기본 메서드로 제공하는 이 disposed(by bag: DisposeBag) 메서드를 이용해서 담을 것이다.

class HjViewController: UIViewController {
		private var disposeBag: DisposeBag = .init()

		override func viewDidLaod() {
				super.viewDidLoad()
		
				Observable<Int>.interval(
					.seconds(1),
					scheduler: MainScheduler.instance
				)
				.subscribe(onNext: {
						print($0)
				})
				.disposed(by: disposeBag)
		}
}
Swift
복사

위처럼, subscribe를 통해 배출된 Disposable 객체에 대고 disposed(by bag:) 메서드로 미리 선언된 disposeBag 객체를 넘겨주면, 해당 disposeBag 안에 해당 Disposable이 담기게 된다.

그러면, deinit 되어야 할 때, disposeBag 안에 들어있는 Disposable 객체들을 다 dispose() 시켜야하나?

근데, 굳이 deinit 때 아무런 작업을 해주지 않아도 메모리 누수가 일어나지 않는다.

public final class DisposeBag: DisposeBase {
		deinit {
				self.dispose()
		}
Swift
복사

위처럼, DisposeBag 객체 자체가 deinit 되는 순간, 내부에 있는 dispose() 메서드를 호출한다.

private func dispose() {
		let oldDisposables = self._dispose()

		for disposable in oldDisposables {
				disposable.dispose()
		}
}
Swift
복사

이 메서드에서 해당 Disposables란 Disposable 배열에 담긴 disposable을 순회하면서 모두 dispose() 메서드를 호출해주기 때문이다.

요약

DisposeBag을 전역 프로퍼티로 선언해준 경우,

(다른 곳에서 참조하지 않은 경우) 해당 DisposeBag을 담고 있는 인스턴스가 사라질 때, DisposeBag이란 프로퍼티도 값이 deinit이 될 것이고,

이때 내가 갖고 있는 Disposable의 배열을 순회하며 dispose() 메서드를 호출해주기 때문에,

딱히 별도의 작업을 해주지 않아도,

DisposeBag이 갖고 있는 Disposable들의 메모리 누수가 나지 않을 수 있던 것이다.

→ 만약 특정 순간에 disposeBag을 직접 비워주어야 하는 상황이라면 해당 상황에 맞게 disposeBag을 메모리에서 해제해주면 된다.

disposeBag은 자신이 deinit 될 때,

자신이 가지고 있던 해당 Disposable을 모두 dispose() 시켜버리기 때문에,

class HjViewController: UIViewController {
		override func viewDidLoad() {
				super.viewDidLoad()
		
				let disposeBag: DisposeBag = .init()

				Observable<Int>.interval(
					.seconds(1)
					scheduler: MainScheduler.instance
				)
				.subscribe(onNext: {
						print($0)
				})
				.disposed(by: disposeBag)
		}
}
Swift
복사

위처럼, 만약 disposeBag을 전역이 아닌 viewDidLoad 메서드 안의 지역변수로 선언할 경우,

viewDidLoad 메서드가 끝날 때 disposeBag도 같이 메모리에서 해제되기 때문에,

이때 등록 되어 있는 Observable 또한 다 같이 구독 해제 되어 버려 위 코드에서의 Observable이 작동하지 않을 것이다.

따라서, disposeBag을 사용할 때는 유의해야한다 → 보통 전역에 둔다.

Subscribe 할 때 마지막 클로저 onDisposed:

public func subscribe(
    onNext: ((Element) -> Void)? = nil,
    onError: ((Swift.Error) -> Void)? = nil,
    onCompleted: (() -> Void)? = nil,
    onDisposed: (() -> Void)? = nil
) -> Disposable
Swift
복사

해당 Observable이 구독 해제될 때ㅡ

즉, disposed() 메서드가 불릴 때 실행 될 클로저를 넘겨주는 것이다.

→ onError나 onComplete으로 인해 disposed 될 때도 당연히 실행된다.

→ 해당 Observable이 구독 해제 될 때, 등록해놓은 클로저가 실행된다.

Reference

RxSwift) Dispose /Disposable / DisposeBag 이해하기

안녕하세요, 소들입니다 XD hm.. 요즘 제 블로그 댓글의 대부분이 소들님은 개발 공부를 어떻게 하셨나요? 에 대한 내용인듯 한디.. 교과서.. 위주로.. 공부하셈.. 두번하셈.. 라고 할뻔... ㅎㅎ 나중에 제 공부 방법에 대해서도 한번 포스팅을 해볼게욥!! 저번 포스팅에서 Observable과 Observer가 무엇이고 Subscribe가 무엇인지에 대해서 공부를 해봤잖아요??!! 이번 포스팅에선 Dispose에 대해 공부해볼 것입니당!! 모든 포스팅은 편의 말투로 합니다~!! 1. Disposable과 dispose() 여러분 Dispose라는 단어의 뜻을 아셈?? Dispose는 "처리하다/없애다"라는 뜻을 갖고 있음!! 그럼 멀 처리하나염..?? 자, 관찰 가능한 형태 Observable이 있..

https://babbab2.tistory.com/186