[iOS] 메이트러너: 모든 화면에서 초대장을 받고 달리기 시작하기, 심지어 앱이 꺼져있어도!

메이트 러너 앱 개발 과정을 공유하는 포스트입니다!

GitHub - boostcampwm-2021/iOS06-MateRunner: 함께 달리는 즐거움, Mate Runner 🏃🏻‍♂️🏃🏻‍♀️

여기서 저희 프로젝트를 더 자세히 볼 수 있어요!

 

그럼 시작하겠습니다!

 

구현하고자 했던 기능 

초대장과 푸시 알림을 구현하면서, 사용자의 편의를 위해 함께 구현하고자 했던 것이 푸시 알림을 탭 하는 것을 통해 어떤 화면에서든 초대장을 받는 것이었습니다. 앱이 종료된 상황에서도요. 그리고 초대장에서 수락 버튼을 누르면 어떤 화면에서든 곧바로 달리기가 시작되도록 해야 했죠.

 

우리 앱은 각 탭이 코디네이터로 설계되어 있고, 탭에 대한 코디네이터를 모두 가지고 있는 부모 코디네이터인 TabBarCoordinator가 있었기 때문에 이를 적극적으로 활용하기로 했습니다.

 

코디네이터 

우리 앱의 코디네이터는 이렇게 설계되어 있습니다. 그리고 코디네이터 프로토콜은 아래와 같이 정의되어 있는데요,

 

각 탭을 나타내는 TabBarCoordinator의 자녀 코디네이터들은 각각 자신의 NavigationController를 가지고 있게 됩니다.

이 코드는 실제로 탭 바 코디네이터를 생성할 때 함께 불리는 메서드들입니다. createTabNavigationController에서 볼 수 있듯이 탭에 대한 새로운 UINavigationController를 만들고, 코디네이터를 새로 시작합니다. 

 

그렇다면 결국 탭 바가 가지고 있는 내비게이션 컨트롤러와, 각 탭이 가진 내비게이션 컨트롤러는 다르다는 것을 의미하기 때문에, 초대장 뷰를 탭 바의 내비게이션 컨트롤러에게 present 하라고 알려주면 됩니다. 이렇게 하면 기존 화면이 그대로 유지된 채로 새로운 화면이 그 위에 올라오겠죠.

 

탭 바의 내비게이션 컨트롤러는 탭 바 코디네이터가 가지고 있으니 초대장이 도착하면 탭 바 코디네이터에게 알려주면 되겠네요!

 

코디네이터에게 초대가 왔다고 알려주기 

이제 문제가 더 작은 문제로 명확해졌습니다. "사용자가 푸시 알림을 탭 하면 탭 바 코디네이터에게 알린다!"

 

푸시 알림을 탭 하면 어디에서 푸시 알림에 대한 정보를 얻을 수 있을까요? 

AppDelegate에서 푸시 알림에 대한 delegate 메서드를 구현하면, 사용자가 푸시 알림을 탭 했을 때에 대한 동작을 지정할 수 있습니다. 그럼 AppDelegate에서 초대장을 만들어서 탭 바 코디네이터에 주입시켜주면 될 것이라고 생각하지만 여기서 한 가지 문제가 또 발생했습니다.

 

가장 큰 문제는 최상위 코디네이터인 AppCoordinator는 AppDelegate가 아닌 SceneDelegate에서 생성된다는 것이고, TabBarCoordinator를 찾기 위해서는 이 AppCoordinator에 접근이 필요하다는 것이었습니다.

 

AppDelegate에서 SceneDelegate에 접근해 AppCoordinator의 인스턴스를 가져오는 것은 어렵지 않지만, 이 작업과 그 이후에 TabBarCoodinator를 검색해 사용하는 과정이 코드 가독성이 떨어진다고 생각했습니다. 그리고 AppDelegate와 SceneDelegate가 단순히 알림을 위한 용도로 연결되는 것이 어색하다고 생각해 이번에는 NotificationCenter를 사용하기로 했습니다.

AppDelegate에서는 푸시 알림을 받고 해당 알림의 UserInfo에 들어있는 내용이 초대장 모델로 변환이 된다면, NotificationCenter로 알림을 전송합니다.

탭 바 코디네이터는 이 알림에 대한 옵저버를 등록을 해두고,

알림이 올 때마다 초대장 뷰 컨트롤러와 그에 대한 의존성을 주입해준 뒤에 자신의 탭 바 컨트롤러에 초대장 뷰 컨트롤러를 present 합니다. 

 

이제 우리가 해결하려고 했던 문제인 "사용자가 푸시 알림을 탭 하면 탭 바 코디네이터에게 알린다!"가 해결되었습니다. 

 

짠!

 

그럼 이렇게 현재 화면과는 상관없이 어디서나 초대장이 잘 보이게 됩니다.

 

달리기 시작하기

초대장에서 거절을 누르면 present 했던 뷰 컨트롤러를 dismiss 시키면 되지만, 수락했을 때는 달리기 카운트 다운 화면이 시작되어야 합니다.

 

하지만 달리기 카운트 다운 화면과 달리기 화면, 그리고 결과 화면은 홈 탭에 속해져 있죠. 만약 초대장을 홈 탭이 아닌 다른 화면에서 수락한다면 어떨까요?

 

현재 화면에서 달리기 준비 화면부터 계속 push 해갈 수도 있지만, depth 가 너무 깊어질 수 있고, 운동이 종료되었을 때 어디까지 pop 해야 할지도 애매해집니다. 또, 이미 우리는 화면의 전환을 코디네이터에게 모두 맡기기로 했으니 모든 코디네이터에 달리기를 시작하는 함수들을 정의해두는 건 굉장히 비효율적입니다.

 

그래서 달리기는 항상 홈 탭에서 시작되도록 하고, 대신 수락 버튼이 탭 되었을 때는 탭이 바뀌면서 현재 상태를 주도하는 코디네이터가 홈 탭의 코디네이터가 되도록 했습니다.

 

초대장을 받는 TabBarCoordinator는 아래와 같이 초대장과 관련된 프로토콜을 채택하고 있습니다.

초대장에서 수락 버튼이 탭 되면 invitationDidAccept와 함께 초대장이 가지고 있던 정보를 달리기 설정 정보로 변환하여 전달하는데요, TabBarCoordinator는 이 메서드를 아래처럼 구현하고 있습니다.

1. 먼저 지금 열려있던 초대장 뷰 컨트롤러를 dismiss 하고,

2. 탭 바의 현재 탭을 홈 탭으로 변경한 뒤에,

3. 홈 탭에 대한 코디네이터인 HomeCooridnator를 자녀 코디네이터 리스트에서 찾아서,

4. 달리기를 시작시킵니다.

이 이미지에서 수락을 탭 했을 때 순간적으로 홈 화면이 보이는 게 바로 이 때문이죠..! 하지만 사용자가 불편함을 느낄 정도로 큰 딜레이가 아니고, 달리기가 종료되었을 때 홈 탭으로 다시 돌아온다는 것을 사용자에게 간접적으로 알릴 수 있기 때문에 문제가 아니라고 판단했습니다.

 

이 과정들을 그림으로 정리하면 이렇게 그릴 수 있습니다.

 

앱이 종료되어 있을 때 알림을 받으면?

앱이 종료되어있을 때 푸시 알림을 받으면 어떻게 해야 할까요? 

 

앱의 시작과 함께 초대장을 받아야 하기 때문에 앱이 켜져 있을 때와의 상황과는 조금 다릅니다. 이전 상황에서는 AppDelegate에서 Notification을 보내 화면을 띄웠었는데, 아직 화면의 UI가 그려지기 전이기 때문에 초대장이 나타나지 않습니다. 

 

이 문제 때문에 많은 시간을 쏟았는데, 실제로 테스트를 해본 결과, Notification이 발행되는 시점이 아직 앱이 런치 스크린에 있는 시점이었습니다.

 

그래서 Notification을 사용하는 방법은 불가능했고 다른 방법을 구상해야 했습니다. 

 

막 실행되면 어차피 홈 탭이잖아..?

문제를 해결할 수 있는 아이디어는 앱이 처음 실행되었을 때는 항상 홈 탭이 실행된다는 것에서 시작되었습니다. 저희가 가지고 있던 문제 해결의 힌트는

 

1. 초대장은 홈 화면이 그려지기 전에 도착한다.

2. 앱을 처음 시작하면 항상 홈 화면부터 시작한다.

 

이 두 가지였습니다. 

 

따라서 저희는 화면이 그려지기 전에 초대장을 띄우라는 메시지를 홈 화면에 남겨두고, 홈 화면을 ViewDidAppear 단계에서 이 메시지를 확인하고 초대장을 띄워야 한다면 뷰가 다 그려진 뒤에 띄우도록 결정했습니다.

 

이를 위해 먼저 홈 화면의 뷰 컨트롤러에 초대장 뷰 컨트롤러에 대한 프로퍼티를 옵셔널로 만들어두었습니다.

이 프로퍼티를 메시지로 삼아 nil이면 초대장을 띄우지 않고, 뷰 컨트롤러 인스턴스가 들어있으면 초대장을 띄우도록 했습니다.

 

초대장 뷰 컨트롤러를 주입시켜주는 것은 SceneDelegate에서 이루어집니다.

앱이 푸시 알림을 탭 해 시작되면 SceneDelegate의 connectionOptions 에는 notifiactionResponse에 푸시에 대한 정보가 포함되어 들어옵니다.

 

이를 이용해 앱이 시작될 때 notifiactionResponse가 존재하는지를 확인해서 초대장 뷰 컨트롤러를 홈 뷰 컨트롤러의 프로퍼티에 주입시켜줍니다.

홈 뷰 컨트롤러는 화면이 다 그려진 이후에 프로퍼티를 확인하고 뷰 컨트롤러가 존재하면 초대장을 화면에 나타냅니다. 그리고 한 번 사용된 초대장은 화면에 다시 그려지지 않게 지워둡니다.

 

마무리

이렇게 해서 저희 앱은 사용자가 앱을 꺼두어도, 여러 화면에서 앱을 사용 중이라도 초대장을 받고 달리기를 시작할 수 있는 기능을 제공하게 되었습니다! 굉장히 단순하게 해결될 줄 알았는데 생각보다 더 고민할 것도 많고 어려웠습니다. 역시 사용자가 편하려면 개발자가 불편해야 하나 봐요..!

 

읽어주셔서 감사합니다! 저희 프로젝트는 여기서 확인할 수 있어요!

https://github.com/boostcampwm-2021/iOS06-MateRunner

GitHub - boostcampwm-2021/iOS06-MateRunner: 함께 달리는 즐거움, Mate Runner 🏃🏻‍♂️🏃🏻‍♀️