Environment : 객체의 의존성 환경 만들기

관련 저장소

Environment란?

객체를 생성할 때, 그 객체가 필요로 하는 의존성을 주입해 준다.
이 때 필요한 의존성이 객체 전체가 아니라 그 객체의 메서드 일부라면, 객체 전체가 아니라 메서드 일부만을 주입해 주는 것이 좋을 것이다.
그래서 '특정 객체가 필요로 하는 환경' 의미로 해석하여 Environment라는 이름을 이해해 보았다.

사용 배경

관련 PR

Environment 사용 전에는 의존성 주입에 필요한 요소들이 모두 분리되어 있거나, 다른 객체 내의 요소로 존재해 객체 생성 과정이 매우 복잡했다.

예를 들어,

1. 이슈 목록들을 보여주는 IssueViewController에서 필요한 메서드가 IssueService의 메서드 중 1개뿐인데, 그 메서드를 사용하기 위해 IssueModel에게 IssueService객체 전체를 넘기는 상황 발생
2. 객체 생성 및 관리를 담당하는 Container가 AppDelegate에만 존재해, Container사용을 위해 AppDelegate를 오브젝트화하여 접근하는 상황 발생

...와 같은 혼란스러운 상황이 생겼다.

1차적으로 생각한 해결방안은 "IssueService에 너무 많은 메서드가 있어서 그러니, 각 뷰 컨트롤러에 필요한 메서드들로 서비스 객체를 또 나눠야겠다" 고 생각했다.

하지만 서비스를 나누는 것 만으로는 두 번째 상황이 해결되지 않는다.

또, "모델이라는 객체가 필요로 하는 것은 IssueService가 아니라 IssueService에 있는 메서드 일부이다. 그러니 객체 전체가 아니라 객체에 필요한 행동만을 전달해 주면 되지 않겠나?" 라는 리뷰어님의 조언이 있었다.

그래서 Environment를 사용해 개선하는 것에 도전해 보았다.

적용 과정

Environment는 특정 객체에 필요한 의존성을 관리한다.

나는 기존 문제가 발생한 부분인 Container와 Model에 Environment를 적용했다.

• ContainerEnvironment : Container에 필요한 환경 관리
  • Container는 객체들을 생성하고 관리하는 객체이므로, 각 객체들의 생성자가 필요로 하는 요소들을 모두 넣어 주어야 한다.
  • 따라서 UserDefaults, OAuthService, IssueService라는 가장 많은 프로퍼티를 갖게 되었다.
• Model들의 Environment : 해당 Model에 필요한 Service의 메서드 일부 관리
  • 예를 들어, ReposModelEnvironment는 ReposModel에 필요한 환경(IssueService의 메서드 일부)을 관리한다.
  • 사용하는 IssueService 내의 함수만 클로저로 받고, 이 Environment를 ReposModel의 생성자에 주입해 준다.

적용 방법

struct ReposModelEnvironment {
    let requestRepos: (@escaping (Result<[Repository], IssueError>) -> Void) -> Void
}

1. 이 객체에 필요한 환경을 확인한다.
   1. ReposModel이 기존에 생성자로 받아오던 요소는 IssueService였고, IssueService에서 사용하던 메서드는 requestRepos() 뿐이다.
2. 객체이름Environment 구조체를 만들고, 그 객체가 필요로 하는 환경을 프로퍼티로 정의한다.
   1. 객체가 필요로 하는 것이 메서드인 경우에는 클로저로 정의한다.
   2. 예를 들어 ReposModel에서 사용하던 IssueService의 requestRepos()의 경우, 기존 service.requestRepos()하는 메서드의 시그니처는 아래와 같다.

   func requestRepos(completion: @escaping (Result<[Repository], IssueError>) -> Void) { 
           // ...
   }

   c. ReposModel의 환경은 이 메서드를 담아야 한다. 따라서 이 메서드를 받고 리턴타입은 없는 (@escaping ((Result<[Repository], IssueError>)) -> Void) -> Void 타입이 된다.
3. 객체가 기존에 받던 의존성 대신, Environment를 넣는다.
   1. 이제 ReposModel을 생성할 때 service 대신 Environment를 넣어준다.
   2. let environment = ReposModelEnvironment(requestRepos: { [weak self] completion in // 필요로 하는 메서드를 completionHandler로 전달 self?.container.environment.issueService.requestRepos(completion: { result in completion(result) }) }) let model = ReposModel(environment: environment) let viewController = ReposViewController(model: model)

전후 비교

Before (Model)

import Foundation

class LoginModel {

    private let service: OAuthService

    init(service: OAuthService) {
        self.service = service
    }

    func requestCode(completion: @escaping (Result<URL, OAuthError>) -> Void) {
        service.requestCode { result in
            completion(result)
        }
    }
}

모델이 필요로 하는 service의 메서드를 사용하기 위해, 생성자에서 service를 직접 받고 있다.

After (Model)

import Foundation

class LoginModel {

    private let environment: LoginModelEnvironment

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

    func requestCode(completion: @escaping (Result<URL, OAuthError>) -> Void) {
        environment.requestCode { result in
            completion(result)
        }
    }
}

struct LoginModelEnvironment {
    let requestCode: (@escaping (Result<URL, OAuthError>) -> Void) -> Void
}

모델이 필요로 하는 service의 특정 메서드를 LoginModelEnvironment라는 구조체에 따로 정의한다.

모델은 생성자에서 이 Environment를 받는다.

이제 모델을 생성할 때 OAuthService전체가 아닌 LoginModelEnvironment를 생성하고,

LoginModelEnvironment에 모델이 필요로 하는 OAuthService의 메서드를 넣어주면 된다.

Before (Container)

class Container {

    private var accessToken: String?

    init(token: String?) {
        self.accessToken = token
    }

        func buildViewController(_ screen: Screen) -> UIViewController {
        let service = IssueService(token: self.accessToken ?? "")
        switch screen {
        case .login:
            return LoginViewController(service: OAuthService())
        case .issue(let selectedRepo):
            let model = IssueModel(service: service, repo: selectedRepo)
            let viewController = IssueViewController(model: model, repo: selectedRepo)
            viewController.title = "Issues"
            return viewController
        case .repos:
            let model = ReposModel(service: service)
            let viewController = ReposViewController(model: model)
            viewController.title = "Repos"
            return UINavigationController(rootViewController: viewController)
        case .newIssue(let repo):
            let model = NewIssueModel(service: service)
            return NewIssueViewController(repo: repo, model: model)
        case .optionSelect(let option, let repo):
            let model = OptionSelectModel(service: service)
            return OptionSelectViewController(model: model, option: option, repo: repo)
        }
    }

}

컨테이너가 객체들을 만들 때 필요로 하는 여러 요소들이 프로퍼티로 없어, 그때그때 객체를 생성할 때 만들어 사용하고 있다. 또, 뷰 컨트롤러마다 필요로 하는 서비스를 통째로 전달하고 있다.

After (Container)

class Container {

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

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

    // .......

}

struct ContainerEnvironment {
    var githubUserDefaults: GithubUserDefaults
    var oAuthService: OAuthService
    var issueService: IssueService

    static let live: ContainerEnvironment = {
        let githubUserDefaults = GithubUserDefaults()
        guard let token = githubUserDefaults.getToken() else {
            return ContainerEnvironment(githubUserDefaults: githubUserDefaults, oAuthService: OAuthService(), issueService: IssueService())
        }

        return ContainerEnvironment(githubUserDefaults: githubUserDefaults, oAuthService: OAuthService(), issueService: IssueService(token: token))
    }()
}

컨테이너가 객체를 만들때 필요로 하는 요소들을 Environment로 제공해 주고 있기 때문에, 동일한 객체를 여러 번 만들 필요가 없어졌다. 뷰 컨트롤러가 필요로 하는 메서드도 ContainerEnvironment.issueService.메서드 와 같이 접근해 바로 넘겨줄 수 있다.

느낀 점

• 우선 생성자를 통해 불필요하게 큰 객체가 오고가지 않는 점이 가장 큰 장점인 것 같다.
  • “객체가 정말 필요한 것이 무엇인지 생각해 보고, 꼭 필요한 것만 넣어 주기” 를 명심해야겠다.
• 함수를 변수처럼 사용하는 연습을 직접적으로 할 수 있어서 좋았다.