[Swift] 메모리 누수를 해결해보자(feat.map)

개발 중인 앱에서 MVP를 위한 기능 구현을 하던 중에 메모리 누수를 확인한 적이 있다.

당시에는 빠른 개발이 필요했기 때문에

정해진 일정을 마치고 해결하기로 했다.

앞으로는 바로 할 거다. 생각보다 오래 걸렸다 : (

 

아무튼

메모리 그래프를 보면서 이런저런 상황을 테스트를 해본 결과

Coordinator에서 생성된 ViewController와 ViewModel, 알림 화면 등

메모리에서 deinit 되지 않는 이슈로 확인됐다.

 

이상하다.

코드를 여기저기 뜯어봐도

약한 참조를 통해 캡쳐해 잘 사용하고 있어 살아있을 만한 녀석이 보이지 않았다.

 

Profile Instrument를 이용해 메모리 누수가 발생하고 있는지 확인했지만 정상동작 중이라고 표시되고 있었다.

코드를 어떻게 작성했길래 Profile Instrument에서는 정상이라고 표시되는지 어이가 없다.

 

메모리 그래프를 살펴보기로 했다.

메모리 누수가 되고 있는 지점을 찾았다. ( 캡처해뒀어야 했는데 이미지가 없다 🙃 )

RxSwift.블라블라 하는 곳에서 강한 참조가 발생해

ViewController, ViewModel 등이 메모리에서 해제되지 않고 있었다. 

[ 참고 사항 ]

- 메모리 그래프에서 굵은 선은 강한 참조를, 가는 선은 강한 참조 혹은 약한 참조임을 알려준다.

 

ViewModel을 Input, Output 방식을 통해서 개발했는데

여기서 Input에 인자를 넣을 때 문제가 발생했다.

아래는 예시 코드다.

let input = EditProfileViewModel.Input(
            editPhotoSign: ...,
            gender: ...,
            introduceText: ...,
            saveSign: saveButton.rx.tap
                .map { _ in
                return UpdateUserInformation(
                    profilePictrue: ...,
                    nickname: self.nicknameTextField.text ?? ...,
                    gender: self.womanButton.getStatus(),
                    bio: self.introduceTextField.text ?? ...)
            }.asSignal(onErrorJustReturn: nil))

보이는 것처럼 map을 통해서 UpdateUserInformation을 넘겨주고 있다.

여기서 self 키워드를 사용했고, 이를 약한 참조로 변경해야 했다. 

즉, 클로저로 캡처할 때, 인스턴스를 캡처하게 되면서 클로저와 인스턴스가 강한 참조 순환을 발생시킨 것이다.

let input = EditProfileViewModel.Input(
            editPhotoSign: ...,
            gender: ...,
            introduceText: ...,
            saveSign: saveButton.rx.tap
                .withUnretained(self)
                .map { owner, _ in
                return UpdateUserInformation(
                    profilePictrue: "",
                    nickname: owner.nicknameTextField.text ?? ...,
                    gender: owner.womanButton.getStatus(),
                    bio: owner.introduceTextField.text ?? ...)
            }.asSignal(onErrorJustReturn: nil))

따라서 위와 같이 수정했다.

위와 비슷한 케이스들이 있어 모두 수정했고, 다행히 메모리 누수가 어느 정도 해결이 되었다.

 

아직도 어디선가 누수가 발생하고 있다.

앞서 말했듯이 누수가 발생했던 곳은 ViewController와 ViewModel 말고도 Alert나 커스텀한 알림 화면이 있었다.

Coordinator 내부에서 생성된 화면에 표시되고, 화면에서 사라질 때, 메모리에서 해제되어야 하지만 그렇지 않았다.

Coordinator에서 프로필 화면을 보여주는 코드를 살펴보자.

func showProfileBottomSheet(nickname: String) {
    let viewController = getProfileBottomSheet(nickname: nickname)
    viewController.modalPresentationStyle = .overFullScreen

    viewController.getViewTapGesture().subscribe(onNext: { [weak self] _ in
        self?.navigationController.unsetBackground()
        viewController.dismiss(animated: true)
    })
    .disposed(by: disposeBag)

    navigationController.setBackground()
    navigationController.present(viewController, animated: true)
}

프로필 화면 인스턴스를 생성 및 할당하고 화면에 보여주는 코드다.

화면 외부를 클릭했을 경우, 현재 NavigationController의 백그라운드 컬러를 제거하는 코드가 subscribe 안에 작성되어 있다.

 

위의 코드의 문제점은 뭘까.

weak를 통해 self(Coordinator)를 참조해 사용하고 있어서 문제가 될 거라고는 생각 못했었다. 

문제는 프로필 화면의 인스턴스였다.

getProfileBottomSheet 내부 코드에는 self 키워드가 사용되고 있기도 하고

subscribe 클로저 내부에 강한 참조의 형태로 dismiss 코드가 실행되고 있기 때문이었다.

따라서 다음과 같이 수정해야 했다.

func showProfileBottomSheet(nickname: String) {
    let viewController = getProfileBottomSheet(nickname: nickname)
    viewController.modalPresentationStyle = .overFullScreen

    viewController.getViewTapGesture().subscribe(onNext: { [weak self, weak viewController] _ in
        self?.navigationController.unsetBackground()
        viewController?.dismiss(animated: true)
    })
    .disposed(by: disposeBag)

    navigationController.setBackground()
    navigationController.present(viewController, animated: true)
}

위의 두 가지를 모두 수정한 다음, 동일한 동작을 했을 때의 메모리는 아래와 같다.

 

 

 

흠.. 제대로 수정된 것 같은데

아직 한 가지 찝찝한 게 있다. 원래 기본적으로 메모리가 저렇게 높았나 싶다.

뭔가 수정할 게 있으면 수정하고 포스팅해야겠다.

아무쪼록 메모리 누수는 해결 완료.

 

출시 이후에 홍보차 글 작성하러 오겠습니다.

그럼 이만 👋🏻👋🏻👋🏻