[iOS] DIContainer : 의존성 주입을 위한 객체 관리하기

참고 문서 :

[DI] DI Container, IOC Container 개념과 예제

DIContainer란?

• DI = Dependency Injection 의존성 주입
  • 밖에서 인스턴스를 만들어 주입해주는 것
• Container : 모든 인스턴스를 가지고 관리하는 객체.
  • register : 내가 사용할 인스턴스를 만들어 등록
  • resolve : 필요한 인스턴스를 달라고 요청

즉 DIContainer는 의존성 주입에 필요한 객체들을 저장하고 관리하는 역할을 한다.

• 왜 필요한가?
  • 객체를 생성하는 중복코드가 많아질 때
  • 객체를 생성할 때 필요한 파라미터가 많을 때

사용배경

프로젝트를 하며 어떤 객체가 필요할 때, 생성자로 앱의 여기저기에서 무분별하게 객체를 생성하고 있었다.

또, 이미 생성했던 시점과 위치를 모르고 같은 객체를 여러 번 생성했는데 이는 자원을 낭비하는 행위라고 생각했다.

그래서 나는 객체를 만드는 방식을 통일하고, 한 번 만든 객체를 재사용하기 쉽게 만들고 싶어서 DIContainer를 적용해 보았다.

적용방법

DIContainer의 기본 개념은 간단하다.

생성된 객체를 저장하고 관리하는 역할을 한다.

import UIKit

class Container {

    let environment: ContainerEnvironment
    private var registeredObjects: [String: Any] = [:]

    init(environment: ContainerEnvironment) {
        self.environment = environment
    }

    // model, viewcontroller, coordinator를 생성 시점에 등록함
    func register<T>(_ object: T) {
        let key = String(describing: T.self)
        registeredObjects[key] = object
    }

    // let value: Type = container.resolve() 로 사용
    func resolve<T>() -> T? {
        let key = String(describing: T.self)
        guard let object = registeredObjects[key],
              let object = object as? T else {
            print("⚠️\(key)는 register되지 않음")
            return nil
        }
        return object
    }

}

• private var registeredObjects: [String: Any]
  • 컨테이너에 등록된 객체들을 저장하는 딕셔너리.
  • 키 : 객체 이름, 값 : 객체
• func register<T>(object:)
  • 컨테이너에 객체를 등록할 때 사용하는 메서드
• func resolve<T>() -> T?
  • 컨테이너에 등록된 객체를 꺼내 쓰고 싶을 때 사용하는 메서드
  • let value: Type = container.resolve() 와 같이 타입을 명시하고 사용하면 된다.
  • 요청한 객체가 등록된 객체라면 꺼내주고, 등록되지 않은 객체라면 nil을 반환

사용방법

• 앱 내에서 어떤 객체를 생성할 때, 생성한 객체를 Container에 등록한다.
• let environment = LoginModelEnvironment { [weak self] completion in self?.container.environment.oAuthService.requestCode(completion: { result in completion(result) }) } let model = LoginModel(environment: environment) // 생성 let viewController = LoginViewController(model: model) container.register(model) // 등록 container.register(viewController)
• 이후 그 객체를 사용해야 할 때 새로 생성하지 않고, 컨테이너에 등록했던 객체를 꺼내쓰면 된다.
• guard let issueCoordinator: IssueCoordinator = container.resolve() else { return } issueCoordinator.fetchIssues()

응용 - DIContainer로 코디네이터&뷰컨트롤러 쌍 관리하기

자세한 내용은 여기 를 참조해 주세요.

컨테이너는 앱 내의 객체들을 관리해 주는 역할을 한다.

그래서 이후 코디네이터 패턴을 적용하다가, 코디네이터와 뷰 컨트롤러 쌍을 함께 관리해야 할 필요가 생겼을 때 이 작업을 컨테이너가 하도록 했다.

• 키가 뷰 컨트롤러이고, 값이 코디네이터인 registeredViewControllerCoordinator 를 만든다.
• 컨테이너의 register(object:)시점에서, 등록하는 객체가 UIViewController일 때 쌍이 되는 코디네이터를 찾아 registeredViewControllerCoordinator 에 등록한다.
• func resolvePair(of viewController: UIViewController) -> Coordinator? : 뷰 컨트롤러가 주어졌을 때, 그 짝이 되는 코디네이터를 반환해 준다.

class Container {

    let environment: ContainerEnvironment
    private var registeredObjects: [String: Any] = [:]
    private var registeredViewControllerCoordinator: [UIViewController : Coordinator] = [:]

    init(environment: ContainerEnvironment) {
        self.environment = environment
    }

    // model, viewcontroller, coordinator를 생성 시점에 등록함
    func register<T>(_ object: T) {
        let key = String(describing: T.self)
        registeredObjects[key] = object
        if let viewControllerObject = object as? UIViewController {
            registerPairCoordinator(with: viewControllerObject)
        }
    }

    // let value: Type = container.resolve() 로 사용
    func resolve<T>() -> T? {
        let key = String(describing: T.self)
        guard let object = registeredObjects[key],
              let object = object as? T else {
            print("⚠️\(key)는 register되지 않음")
            return nil
        }
        return object
    }

    private func registerPairCoordinator(with viewController: UIViewController) {
        let viewControllerName = String(describing: type(of: viewController))

        let allViewController = ViewControllerCoordinator.allCases
        for oneCase in allViewController {
            let oneCaseName = String(describing: oneCase) // Enum case의 이름을 String으로 변환
            if oneCaseName == viewControllerName {
                let coordinatorName = oneCase.rawValue
                guard let coordinator = registeredObjects[coordinatorName],
                      let castedCoordinator = coordinator as? Coordinator else {
                    return
                }
                registeredViewControllerCoordinator[viewController] = castedCoordinator
            }
        }
    }

    func resolvePair(of viewController: UIViewController) -> Coordinator? {
        return registeredViewControllerCoordinator[viewController]
    }
}

개선점

DIContainer는 원리가 복잡하지 않아서 적용이 쉬우면서도, 그 효과를 바로 체감할 수 있어서 좋았다!

컨테이너를 만들고 리팩토링을 하니 객체 생성 코드가 여기저기서 남발되지 않고,

사용할 때도 한 번 만든 객체를 여러 번 재사용할 수 있게 되어서 좋았다.