effective-swift

Item 3. private 생성자나 열거 타입으로 싱글턴임을 보증하라

싱글턴(Singleton)

싱글턴이란 앱이 요청하는 횟수에 관계없이 동일한 인스턴스를 반환하는 클래스를 의미합니다. 일반적인 클래스는 호출하는 만큼 클래스의 인스턴스를 만들 수 있도록 허용하는 반면, 싱글턴 클래스의 경우 프로세스 당 인스턴스가 하나만 존재할 수 있습니다. 따라서 환경설정, 네트워크 관리와 같이 앱 전체에서 공유되는 리소스 또는 서비스에 주로 사용합니다. FileManager.default, URLSession.shared와 같이 실제 Cocoa 프레임워크 계층의 여러 클래스에 싱글턴 디자인 패턴이 적용되어 있습니다.

출처: Cocoa Core Competencies - Singleton

싱글턴 생성

책에서 자바를 사용한 싱글턴 생성 방식으로 private 생성자와 열거 타입을 소개하는데, 스위프트는 private 생성자를 사용하는 방식을 취합니다. 스위프트의 열거 타입은 값 타입(value type)으로, 앱 전체에서 공유하여 사용하는 싱글턴의 용도에 부합하지 않고, 열거 타입 내부에 원시값으로 싱글턴 인스턴스를 갖는다면 외부에서 생성이 가능한 것이기 때문에 그 자체로 의미가 없습니다.

스위프트의 싱글턴은 static 타입 프로퍼티와 private 접근 수준의 생성자를 사용하여 생성할 수 있습니다. static 타입 프로퍼티를 통한 지연 연산으로 처음 요청될 때 자신의 유일한 인스턴스를 생성하고, 생성자가 private으로 설정되어 외부에서 호출할 수 없기 때문에 다른 인스턴스를 생성할 수 없도록 합니다.

class Singleton {
    static let shared = Singleton()

    private init() { }
}

주의할 점

싱글턴이 일반적으로 야기하는 문제는 다음과 같습니다.

• 싱글턴 생성 시 사용하는 static 타입 프로퍼티는 여러 스레드에서 동시에 접근하는 경우 한 번만 생성되는 것을 보장하지만, 동시에 참조할 경우 원치 않은 결과를 가져올 수 있으므로 코드가 스레드로부터 안전한지 고려해야 합니다.
• 앱 전체에서 공유되기 때문에 싱글턴 인스턴스의 상태가 예기치 못하게 변경되면 버그가 발생할 수 있습니다.
• 테스트하기가 어려워질 수 있습니다. 각 테스트 케이스에서 깨끗한 초기 상태로 시작할 수 없기 때문입니다. 또한 프로토콜을 채택한 싱글턴이 아니라면 싱글턴 인스턴스를 가짜(mock) 인스턴스로 대체하기 어렵습니다.

의존성 주입

위에서 설명한 싱글턴의 문제점을 보완하기 위해 의존성 주입을 활용할 수 있습니다. 여기서 의존성이란 서비스로 사용할 수 있는 객체이고, 주입은 의존성(서비스)을 사용하려는 객체로 전달하는 것을 의미합니다. 즉, 객체가 어떤 서비스를 사용할 것인지 지정하는 대신, 객체에게 어떤 서비스를 사용할 것인지를 말해주는 것입니다.

현재 로그인한 사용자의 이름을 표시하고 버튼을 탭하면 로그아웃하는 상황을 가정해보겠습니다. 아래의 싱글턴 예시에서는 사용자 모델과 계정 처리 기능을 싱글턴 클래스인 UserManager가 포함하고, 화면이 표시될 때 사용자의 이름에 UserManager.shared.user?.name과 같이 옵셔널로 접근하는 것을 볼 수 있습니다. UserManager 클래스에 User 타입을 옵셔널로 정의한 이유는 사용자의 정보가 존재하지 않을 수 있기 때문입니다. 예를 들어, 사용자가 로그인을 하기 전까지는 사용자 정보가 존재하지 않습니다.

의존성 주입 예시에서는 옵셔널이 아닌 User와 SignOutService를 주입합니다. 결과적으로 훨씬 더 명확하고 관리하기 쉬워집니다. 이 방식을 택할 경우 모델에 안전하게 의존할 수 있으며, 명확한 API를 갖습니다.

• 싱글턴

  class UserManager {
      static let shared = UserManager()
      var user: User?
  
      private init() { }
  
      func signUp() {
          // sign up code
      }
  
      func signIn() {
          // sign in code
      }
  
      func signOut() {
          // sign out code
      }
  }
  
  class User {
      var name: String
  
      init(name: String) {
          self.name = name
      }
  }
  
  class ProfileViewController: UIViewController {
      private lazy var nameLabel = UILabel()
  
      override func viewDidLoad() {
          super.viewDidLoad()
          nameLabel.text = UserManager.shared.user?.name
      }
  
      private func signOutButtonTapped() {
          UserManager.shared.signOut()
      }
  }
  

• 의존성 주입

  class User {
      var name: String
  
      init(name: String) {
          self.name = name
      }
  }
    
  class SignOutService {
      func signOut() {
          // sign out code
      }
  }
  
  class ProfileViewController: UIViewController {
      private let user: User
      private let signOutService: SignOutService
      private lazy var nameLabel = UILabel()
  
      init(user: User, signOutService: SignOutService) {
          self.user = user
          self.signOutService = signOutService
          super.init(nibName: nil, bundle: nil)
      }
  
      override func viewDidLoad() {
          super.viewDidLoad()
          nameLabel.text = user.name
      }
  
      private func signOutButtonTapped() {
          signOutService.signOut()
      }
  }
  

결론

싱글턴은 Apple 자체에서도 많이 사용하는 만큼 편리하다는 장점이 있습니다. 어디에서나 접근이 가능하고 앱 전체에서 공유될 수 있습니다. 그러나 멀티 스레드 환경에서 동시에 참조한다거나, 객체 간의 명확한 분리 없이 광범위하게 사용할 경우 원치 않은 결과와 버그가 발생할 수 있습니다. 따라서 객체 간에 보다 잘 정의된 관계를 만들고, 의존성 주입을 사용하는 등 주의가 필요합니다.

This site is open source. Improve this page.