[TIL] 20231207

Trouble Shooting - 싱글턴 인스턴스의 초기화 시점

부캠 동료분에게 받은 질문!

싱글턴 인스턴스는 다른 클래스에서 전역 변수나 상수에 할당해두고 해당 변수나 상수에 접근해서 사용하면 안되나요???

오엥?? 되는데열,, but 동료의 플젝에서 런타임 에러가 발생하고 있었음... whyrano....

코드를 봅시다. 레쭈고. (제가 짠 코드가 아니니 코드 블럭이 아닌 스샷으로 보여드리겠습니다..!)

 

GamePlayer라는 클래스에서 static 프로퍼티로 해당 클래스의 인스턴스를 생성해두고,

init() 생성자에 private으로 접근제어를 함으로써 해당 클래스의 인스턴스는 하나만 생성됨을 보장해주셨음!!!

싱글턴 패턴을 사용해서 클래스를 아주 잘 생성하셨죠??

이제 GamePlayer 라는 클래스 인스턴스에 접근하려면 shared 라는 이름의 프로퍼티로 접근해야함!!!

 

RockPaperScissorsController 라는 구조체 안에서 아까 생성해둔 싱글톤 객체에 접근해서 해당 클래스의 프로퍼티인 attackPlayer의 값을 사용해주고 싶음.

그러면 GamePlayer.shared로 아까 생성해둔 인스턴스에 접근해서 사용해줄 수 있겠죠??

여기까지는 문제가 없습니다.. 실행해봐도 프로그램이 잘 작동되는 것을 확인할 수 있습니다!

 

but 싱글턴 객체에 접근할 때마다 클래스 이름.shared 이렇게 접근해야되냐고..... 넘 귀찮잖아요......(실제로 해당 구조체 내에서 꽤나 여러번 싱글턴 객체의 프로퍼티에 접근해주고 있는 상황)

 

위와 같이 접근하려는 클래스 or 구조체 내에 전역적으로 선언해두고 바로바로 접근해서 사용하고 싶단 말임. 이렇게 하는게 가능한가요??

당연히 가능합니다!!! 실제로 컴파일 에러를 만나지 않을 것임!!

 

여기서 드는 의문.. 싱글턴은 앱 내에 인스턴스 자체가 하나만 존재하는데 이렇게 다른 클래스나 구조체에서 프로퍼티 하나를 만들어서 할당해두고 이 프로퍼티로 접근하면 인스턴스 여러 개 생성되는 것 아닌가??? 데이터의 동기화 문제가 일어나지 않나요??

정답은 아닙니다!! 싱글턴 클래스의 생성자에 private으로 접근제어를 해두었기 때문에 다른 인스턴스가 생성되지 않을 뿐더러 위의 코드에서 변수에 새로운 인스턴스를 생성해 할당해주고 있는 것이 아니라 shared에 저장된 인스턴스를 가져오기만 하고 있져??? 걱정 노노

컴파일 에러도 안나니,, 실행을 해봅시다.

 

어라라 런타임에 에러가 발생해 강제 종료가 되네요..

오류 메시지를 보니 메인 스레드에서 발생했고,, 왼쪽 콜 스택을 보면,, 클래스.init() or 구조체.init() 이 뜨는걸 보니 초기화 시점과 관련한 에러인 것 같습니다!

어떤 인스턴스가 초기화 되기 전에 접근을 해주고 있는 듯 하네요,,  찾아봅시다 ,,

 

일단 처음에 GamePlayer.shared.~ 로 접근했을 때 아무 문제가 생기지 않았던 이유는?

바로바로 우리가 shared를 static하게 선언해두었기 때문!!

Swift에서 static을 사용해 타입 프로퍼티로 인스턴스를 전역적으로 생성하면, 사용 시점에 초기화가 됨!!!

즉, lazy 하게 초기화된다는 점..객체에 접근할 때 초기화되어 메모리에 올라간다! shared에 처음 접근할 때 초기화가 이루어짐!!

+ Swift에서는 dispatch_once 로 멀티스레딩 환경에서도 싱글톤 객체가 한번만 초기화되는 것을 보장함!!

즉, Thread-Safe하게 초기화가 된다는 것임 (좋다..ㅎ)

그래서 여기저기서 GamePlayer.shared.~를 호출해도 문제가 없었던 것!!! (swift에서는 전역, 정적 변수의 초기화 과정이 atomic, thread-safe 함을 보장해주기 때문에)

 

But, 문제 상황은 다른 변수에 할당하고 여기에 접근할 때 생기고 있었죠??

이 방식은 thread-safe 하지 않기 때문임!!!

다른 프로퍼티에 shared를 할당하면 해당 프로퍼티의 초기화 시점은 shared의 초기화 시점과 독립적으로 결정됩니다.

만약 다른 스레드에서 shared를 어떤 프로퍼티에 할당하려는 시점에 shared에 대한 초기화가 이루어지지 않은 상태라면??

초기화 되지 않은 인스턴스에 접근해버리게 되는 것이니 문제가 발생하겠죠???

위의 상황이 딱 그런 상황인 것임! 

 

이 구조체 내에서 GamePlayer.shared 를 gamePlayer 라는 전역변수(상수도 가능)에다가 할당해주고 있죠??

근데 멀티 스레딩 환경에서 shared가 GamePlayer.shared가 초기화 안되어있는 상황이라면?? 

초기화되지 않은 인스턴스에 접근하게 되어 관련된 부분에서 런타임 에러가 다라라ㅏㄹㄱ 생기게 되는 것이죠..

그럼 해결방법은 간단하겠죠??? 새로운 변수 or 상수에 할당 해줄 때도 lazy를 붙여주면 됩니다!!!!

실제로 사용하는 시점에 지연 초기화 해줘!!!!

 

이제 프로그램이 정상적으로 실행이 되는 것을 확인할 수 있습니다!!!

참고로 lazy는 변수에만 붙일 수 있습니다! (상수에는 불가..)

 

호하하ㅏ 재밌네요.. 시디가 이거 보고 이해했으면 좋겠습니다.. 이해할 것임 그는 천재닉까.....

이해 안가는 부분이 있다면 달려오세요,,

글고 이거 보는 선배들.. 여기서 틀린 부분이 있다면 알려주십셔..댓글 환영합니다!!!

Tuist를 이용한 모듈화 - 외부 의존성 추가하기

Xcode native Swift Package Manager를 이용한 방법

경로를 입력해서 local로 package를 등록하는 방식!

remote는 url과 requirement를 받는다.

url은 SPM을 지원하는 레포의 Remote Git URL, requirement는 버전 정보!!!

 

ThirdPartyLib > Project.swift (SnapKit 라이브러리 추가 예시)

import ProjectDescription
import ProjectDescriptionHelpers

let project = Project.makeModule(
    name: "ThirdPartyLib",
    product: .framework,
    packages: [
        .remote(url: "<https://github.com/SnapKit/SnapKit.git>", 
                requirement: .upToNextMajor(from: "5.0.0"))
    ],
    dependencies: [
        .package(product: "SnapKit")
    ]
)

 

tuist edit 명령어 입력 후 위의 코드 넣어주면 됨!!

generate 해보면??

package가 추가되고 추가해준 패키지를 import 해서 사용할 수 있게 됨!!!

이렇게 그래프에도 추가가 됩니다!!!

⚠️ 주의할 점!!!

SPM, Carthage만 지원합니다… cocoapods는 지원을 하지 않아서 따로 Podfile을 만들어서 사용해야 하는 이슈가 있다고 하네요..