UserDefaults 값 하나로 앱 진입시 1회만 검사하는 로직 관리하기

 

 

 

 

 

앱을 서비스하다보면 버그개선 또는 업데이트 안내 등의 이유로 단 1회만 동작하는 코드가 필요할 때가 있습니다.

 

예를 들어, TiTi에서는 비어있는 기록 객체인 Daily가 사라지지 않아서 Log화면에 기록이 있는 것 처럼 보이는 버그가 있었는데요,

보다시피 기록이 비어 있는데도 날짜 아래에 점이 찍혀 있습니다 (기록이 있는 경우에만 점이 찍혀 있어야함)

 

 

이를 해결하기 위해서는 두 가지 동작이 필요 했습니다.

 

 

1. 사용자가 기록을 편집해서 그 날의 기록을 모두 지우는 경우 Daily객체를 삭제한다.

2. 버그 개선 전에 존재했던 비어있는 Daily객체를 모두 삭제한다.

 

여기서 2번은 사용자가 앱을 진입할 때 1회만 작업하면 되는 내용입니다.

여러번 동작해도 문제는 없겠지만, 비어 있는 Daily객체를 찾기 위해 현재 존재하는 Daily 객체를 완전탐색 해야하고 1회 작업 이후에는 비어 있는 Daily객체가 존재하지 않을 것이기 때문에 필요 없는 동작을 반복하게 되는 것이죠!

 

 

아무튼, 이런 이유로 1회만 작업하게 될 코드를 관리하기 위해서는 여러가지 방법이 있습니다.

 

 

1. 작업의 횟수를 관리하지 않기

가장 쉬운 방법입니다.

private func removeEmptyDailys() {
    RecordsManager.shared.dailyManager.removeEmptyDailys()
}


// RecordsManager.shared.dailyManager.removeEmptyDailys()
func removeEmptyDailys() {
    dailys = dailys.filter { daily in
        return daily.totalTime > 0
    }
    self.saveDailys()
}

 

이 함수를 앱을 켤때 마다 동작하도록 하는 것이죠.

앞서 말한대로 이는 dailys를 완전 탐색하기 때문에 매우 비효율적입니다. 👎🏻

 

 

 

2. UserDefaults로관리하기

private func removeEmptyDailys() {
    guard let _ =  UserDefaults.standard.object(forKey: "didRemoveEmptyDailys") as? Bool else {
        RecordsManager.shared.dailyManager.removeEmptyDailys()
        UserDefaults.standard.setValue(true, forKey: "didRemoveEmptyDailys")
        return
    }
}

 

이 방법은 실제로 1회만 동작하게 됩니다.

하지만, UserDefaults에 넣은 Bool값이 실제로는 아무 의미가 없는 값이 됩니다.

1회 동작 전에는 UserDefaults에 값이 없기 때문에 guard문 내부를 실행합니다.

이후에는 UserDefaults에 값이 있고, 그 말은 1회 동작을 했다는 의미이기 때문에 true/false 어떤 값이 들어가도 무관합니다.

 

즉, UserDefaults에  값이 존재 하는지의 여부로 동작 여부를 판단하게 되는 것입니다.

UserDefaults로 값을 저장하는것 조차 1회성인 것이죠.

 

UserDefaults는 비휘발성이기 때문에 메모리 공간을 차지하게 됩니다.

물론 작은 값이지만, 이러한 1회성 동작이 여러개가 된다면 분명 메모리가 낭비 될 것입니다.

 

이를 개선하기 위해 하나의 UserDefaults 값으로 여러 개의 1회성 동작들을 관리하는 방법을 고안했습니다.

 

 

3. 1회성 동작을 Version으로 관리하기

 

유저가 업데이트 했던 버전을 기록하여,

1회성 동작을 수행할 버전을 통해 관리하는 것입니다.

 

좀 더 쉽게.. 설명해보자면

 

예를 들어, `removeEmptyDailys`가 2.1 버전에 업데이트 된다고 가정하겠습니다.

- 사용자가 2.0 버전을 쓰다가 2.1 버전으로 업데이트 하고 앱을 켠다면? -> removeEmptyDailys 수행⭕️
- 사용자가 2.1 버전을 쓰는 사용자가 앱을 켠다면? -> removeEmptyDailys 수행❌
- 사용자가 2.1 버전을 쓰다가 3.0 버전으로 업데이트 하고 앱을 켠다면? -> removeEmptyDailys 수행❌

 

이런 방식으로 동작할 수 있게 구현하는 것입니다 !

 

여기서 사용자가 쓰던 버전은 UserDefaults에 저장해서 관리하고,

수행할 로직은 어떤 버전에서 수행될지를 enum으로 저장해서 관리할 것입니다.

 

말은 너무 어려우니..

동작을 관리할 Version객체를 만들어 보겠습니다.

struct Version {
}

 

 

먼저, 현재 사용자가 어디까지 업데이트 되었는지 기록을 해야겠죠? == 사용자가 쓰던 버전

그 버전을 UserDefaults에 기록 할 것입니다. 이를, lastUpdateVersion이라고 하겠습니다.

static private var lastUpdateVersion: String {
    UserDefaults.standard.object(forKey: "lastUpdateVersion") as? String ?? "2.0"
}

 

lastUpdateVersion은 유저가 앱을 업데이트 하기 직전에 사용하던 앱의 버전을 담고 있게 됩니다.

default value를 2.1로 해준 이유는 처음 해당 코드를 동작 시킬 때 UserDefaults에 값이 없기 때문에,

Keys에 있는 로직이 모두 실행되게 하기 위해 Keys중에 가장 작은 값 보다 작은 버전을 default value로 가집니다.

 

 

1회성 로직들을 관리하기 위해 key값을 만듭니다.

private enum Keys: String, CaseIterable {
    case removeEmptyDailys = "2.1"
    case anotherOnceLogic = "2.7"
}

 

여기서 가지는 rawValue는 유저가 이 버전보다 낮은 버전을 썼다가 앱을 업데이트 했다면 해당 로직을 수행할거야!

라는 의미를 담고 있습니다.

 

예를 들어,

유저가 2.1보다 낮은 버전을 쓰다가 앱을 업데이트 했다면 removeEmptyDailys를 수행할거야!

라는 의미입니다.

 

 

이제,

- 사용자가 2.0 버전을 쓰다가 2.1 버전으로 업데이트 하고 앱을 켠다면? -> removeEmptyDailys 수행⭕️
- 사용자가 2.1 버전을 쓰는 사용자가 앱을 켠다면? -> removeEmptyDailys 수행❌
- 사용자가 2.1 버전을 쓰다가 3.0 버전으로 업데이트 하고 앱을 켠다면? -> removeEmptyDailys 수행❌

 

 

요 로직들을 수행하기 위해 다음과 같은 함수를 만듭니다.

/// (extension String) static let currentVersion: String = Bundle.main.object(forInfoDictionaryKey: "CFBundleShortVersionString") as! String

static func update() {
    if lastUpdateVersion == String.currentVersion { return }

    for key in Keys.allCases {
        if !check(forKey: key) { continue }
        switch key {
        case .removeEmptyDailys:
            removeEmptyDailys()
        case .anotherOnceLogic:
        	anotherOnceLogic()
        }
    }

    UserDefaults.standard.setValue(String.currentVersion, forKey: "lastUpdateVersion")
}

static private func check(forKey key: Versions.Keys) -> Bool {
    let checkVer = key.rawValue
    return checkVer.compare(lastUpdateVersion, options: .numeric) == .orderedDescending
}

 

 

코드를 찬찬히 살펴 볼게요.

if lastUpdateVersion == String.currentVersion { return }

 

 

유저가 업데이트 하기 직전 버전(lastUpdateVersion)과 업데이트 한 버전(currentVersion)이 동일하면, 동작하지 않습니다.

(이미 업데이트가 완료 되었다는 의미입니다)

 

 

for key in Keys.allCases {
    if !check(forKey: key) { continue }
    switch key {
    case .removeEmptyDailys:
        removeEmptyDailys()
    case .anotherOnceLogic:
        anotherOnceLogic()
    }
}

 

check()를 통해 key의 버전과 업데이트하기 직전 버전을 비교합니다.

key의 버전이 더 높은 경우에만 true입니다.

 

check()가 true라면 업데이트가 필요하다는 의미입니다.

해당 key에 맞는 로직을 함수로 작성해두고, 실행합니다.

 

removeEmptyDailys로 예를 들면,

사용자가 업데이트 전에 2.0버전을 사용하고 있었다면 check는 true입니다.

그렇다면 switch문을 통해 removeEmptyDailys()를 실행하게 될 것입니다.

 

 

UserDefaults.standard.setValue(String.currentVersion, forKey: "lastUpdateVersion")

 

로직이 모두 수행되고 나면, lastUpdateVersion값을 현재 버전으로 바꿔 줍니다.

즉, 2.0버전을 사용하고 있던 사용자가 2.1 버전으로 업데이트 했다면 lastUpdateVersion은 2.1로 변경될 것입니다.

 

 

그렇다면 다음에 앱을 켰을 때, update()에서

if lastUpdateVersion == String.currentVersion { return }

 

요 조건문에 걸려 아래 코드를 수행하지 않겠죠?

즉, 업데이트 로직을 1회만 수행하게 되는 것입니다.

 

 

 

조각된 코드를 모아서 보면 다음과 같습니다.

 

struct Versions {
    
    static private var lastUpdateVersion: String {
        UserDefaultsManager.get(forKey: .lastUpdateVersion) as? String ?? "2.0"
    }
    
    private enum Keys: String, CaseIterable {
        case removeEmptyDailys = "2.1"
        case anotherOnceLogic = "2.7"
    }
    
    static func update() {
        if lastUpdateVersion == String.currentVersion { return }

        for key in Keys.allCases {
            if !check(forKey: key) { continue }
            switch key {
            case .removeEmptyDailys:
                removeEmptyDailys()
            case .anotherOnceLogic:
                anotherOnceLogic()
            }
        }

        UserDefaults.standard.setValue(String.currentVersion, forKey: "lastUpdateVersion")
    }

    static private func check(forKey key: Versions.Keys) -> Bool {
        let checkVer = key.rawValue
        return checkVer.compare(lastUpdateVersion, options: .numeric) == .orderedDescending
    }
    
    static private func removeEmptyDailys() {
    	//code
    }
    
    static private func anotherOnceLogic() {
    	//code
    }
}

 

이렇게 하면, UserDefaults값 하나로 1회만 동작하는 로직들을 관리 할 수 있습니다!

 

 

외부에서는 update() 함수 호출만으로 업데이트를 진행할 수 있습니다.

Versions.update()

 

 

 

 

 

더 좋은 의견이 있다면 댓글 부탁드립니다 😊