[디자인 패턴] Coordinator를 사용하면서(feat.MVVM-C)

안녕하세요.

오늘은 Coordinator 디자인 패턴에 대해서 간단하게 소개해보려고 합니다.

최근에 진행하고 있는 프로젝트에서 사용 중인데

Coordinator 사용에 있어 뭔가 잘못 사용하고 있다고 생각되어 다시 공부할 겸 포스팅 남겨봅니다.

 

---

 

Coordinator

Coordinator 디자인 패턴은 기존의 ViewController에서 처리했던 화면전환이나 흐름을 분리하여 담당하는 디자인 패턴입니다.

즉, ViewController가 다른 ViewController를 직접 푸시하거나 인스턴스를 생성하던 것을 Coordinator가 담당하게 되면서 명확한 역할의 분리가 생기게 되고 이렇게 명확한 역할의 분리로 더 깔끔한 코드, 확장성과 재사용성에 이점을 가져갈 수 있습니다.

 

장단점

앞서 설명한 것처럼 기존의 ViewController가 하던 화면전환이나 흐름제어의 역할을

Coordinator가 담당하게 되면서 명확한 역할의 분리를 기대할 수 있기 때문에 사용합니다.

자주 봐왔던 것처럼 역할이 분리된다면 ViewController와 Coordinator를 개별적인 테스트를 진행할 수 있게 되고, 하나의 Coordinator가 여러 ViewController의 화면전환에 사용이 될 수 있게 됩니다.

따라서 매번 화면전환 함수를 만들어 처리하지 않을 수 있게 되어 재사용성 측면에서도 굉장한 이점이 있습니다.

단점이 있다면 작은 앱이나 간단한 탐색(1회성, 자주 사용하지 않는 화면전환이나 흐름 제어)에 Coordinator를 도입할 시에는 오히려 불필요한 복잡성만 추가될 수 있습니다.

 

비교해 보자

아래는 기존에 ViewController에서 담당하던 화면전환 로직입니다.

LoginViewController의 인스턴스를 함수 내에서 생성하고 

상위 뷰컨트롤러인 navigationController에게 push를 요청하고 있습니다.

class MyViewController: UIViewController {

   ...
   
   func showLgoinViewController() {
        let loginViewController = LoginViewController() 
        self.navigationController?.pushViewController(loginViewController, animated: true)
   }
}

 

Coordinator를 이용하면 다음과 같이 사용할 수 있게 됩니다. 

 

1. Coordinator 프로토콜 구현

protocol Coordinator: AnyObject {
    var navigationController: UINavigationController { get set }
    var childCoordinators: [Coordinator] { get set }
    
    func start()
    
    init(_ navigationController: UINavigationController)
}

 

2. 해당 프로토콜을 채택한 Coordinator

class LoginCoordinator: Coordinator {
    var navigationController: UINavigationController
    var childCoordinators = [Coordinator]()
        
    init(_ navigationController: UINavigationController) {
    	self.navigationController = navigationController
    }
    
    func start() {
        let loginViewController = LoginViewController()
        navigationController.pushViewController(loginViewController, animated: false)
    }
}

- 생성자를 통해 받은 NavigationController를 기준으로 화면전환이 이루어집니다.

 

3. Coordinator 인스턴스를 생성하고 start()  메서드를 호출합니다.

로그인 화면이 가장 첫 화면이라는 가정하에 작성했습니다.

보통 AppCoordinator라는 Coordinator를 만들어 유저가 가입이 되었는지 안되었는지에 따라 로그인화면으로 갈지, 홈화면으로 갈지 등을 판단합니다.

class AppDelegate: UIResponder, UIApplicationDelegate {
    
    var window: UIWindow?
    var coordinator: LoginCoordinator?
    
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        let navigationController = UINavigationController()
        coordinator = LoginCoordinator(navigationController)
        coordinator?.start()
        
        window = UIWindow(frame: UIScreen.main.bounds)
        window?.rootViewController = navigationController
        window?.makeKeyAndVisible()
        
        return true
    }
}

이렇게 하면 앱이 실행되었을 때, LoginCoordinator의 start() 함수가 호출되고 화면에는 LoginViewController가 나오게 됩니다.

 

4. 조금 더 알아보자.

만약 로그인 성공 시 홈으로 화면전환을 하고 싶다면 여러 가지 예시를 작성할 수 있지만

delegate 패턴을 활용한 경우에 대해서 작성해 보겠습니다.

protocol LoginViewModelDelegate {
    func showHomeViewController()
}

class LoginViewModel {
	
    weak var delegate: LoginViewModelDelegate?
    
    ...
    
    func showHomeViewController() {
        delegate?.showHomeViewController()
    }
}

class LoginCoordinator: Coordinator {

   ...
   
    func start() {
        let viewModel = LoginViewModel()
        let loginViewController = LoginViewController(viewModel: viewModel)
        viewModel.delegate = self
        navigationController.pushViewController(loginViewController, animated: false)
    }
}

// MARK: - Navigation

extension LoginCoordinator: LoginViewModelDelegate {
    
    func showHomeViewController() {
        let coordinator = HomeCoordinator(navigationController)
        childCoordinators.append(coordinator)
        coordinator.start()
    }
}

로그인 성공 시 ViewModel에서 showHomeViewController 메서드를 호출할 경우, delegate를 채택하고 있는 LoginCoordinator의 showHomeViewController가 호출되게 됩니다.

따라서 기존의 Coordinator뒤에 HomeCoordinator가 추가되고,  start 메서드를 호출함으로써 화면전환이 이루어지게 됩니다.

 

다시 공부해야겠다

저의 경우에는 ViewModel의 생성자에 Coordinator를 추가하여 ViewModel 내부에서 Coordinator를 사용했었습니다.

class LoginViewModel {

    weak var coordinator: HomeCoordinator?
    
    init(coordinator: HomeCoordinator...) {
        self.coordinator = coordiantor
        ...
    }

    func showHomeViewController() {
         coordinator?.showHomeViewController()
    }
}

예를 들어 위처럼 사용했었습니다. 

ViewModel에서 coordinator를 받아 사용하다 보니 특정한 뷰컨트롤러가 Home, Profile, Chat 등 Coordinator에서 모두 사용되게 될 경우에는 해당 뷰모델들은 생성자를 Coordinator 프로토콜로 받아 사용할 수밖에 없었습니다.

프로토콜로 받아서 사용한다고 하더라고 어떤 Coordinator인지 ( Chat, Profile, Home...) 분기처리를 매번 해야만 했었습니다.

이번 포스팅을 작성하면서 delegate 패턴을 활용하면 위와 같은 못난이 코드를 작성하지 않게 될 것 같다는 생각이 드네요.

아무쪼록 도움이 되셨으면 좋겠네요.

그럼 이만  👋🏻 👋🏻 👋🏻