[iOS/Swift] Property Wrapper 를 활용한 UserDefaults 이용하기

지난 포스팅에서 UserDefaults, Onboarding 페이지에 대해서 작성했었고, Onboarding 페이지를 구현하기 위해 UserDefaults 를 이용했었습니다. 스터디하시는 분 중에서 Property Wrapper 를 이용하면 효율적으로 사용할 수 있다고 해서 공부를 했습니다. ✍️ 감사합니다!

 

💡 Property Wrapper 란? 

Property Wrapper 는 Property 에 대해 특정한 기능을 정의할 수 있는 기능입니다. Swift5.1 에서 추가된 기능이라고 합니다. 

 

Property wrapper 는 Property 가 저장되는 방식을 관리하는 코드와 Property 를 정의하는 코드 사이에 분리 계층을 추가해줍니다. 저는  Property 가 정의되고, 저장되기 전에 Wrapper 를 거쳐가는 것이라고 이해했습니다.

 

기존에는 Thread-safety check 를 제공하거나, DB에 저장하는 property 가 여러개 필요한 경우, 각각의 property 마다 작성해야 했지만, Property wrapper 를 이용하면 한 번만 작성할 수 있습니다. 

 

DB 에 저장하는 등의 management code 를 Property wrapper 를 정의하는 부분에서 한번만 작성하면 됩니다. 이후에 여러 property 에서 Property wrapper 를 명시해 재사용하는 것입니다! 

 

✔︎ Property Wrapper 사용하기

Property wrapper를 정의하기 위해서는

 

1. structure, enumeration 혹은 class 를 정의하고 @propertyWrapper 를 명시해줍니다.
2. 실제 저장되는 값을 wrappedValue 속성으로 정의합니다. * 필수로 구현해야합니다.

Property wrapper 의 형태는 computed property 의 getter, setter 를 설정하는 모습과 같습니다. setter 에서 새롭게 들어오는 값을 newValue 라고 합니다. Property warpper 는 반복되는 computed property 를 하나의 struct 로 정의하는 역할을 한다고 생각할 수 있습니다.

 

아래 예제에서 TwelveOrLess 구조체는 number 가 항상 12보다 작거나 같음을 보장합니다. wrappedValue 를 살펴보면, setter 에서 12보다 큰 수는 12가 대입되도록 구현되어있기 때문입니다.

 

@propertyWrapper
struct TwelveOrLess {
    private var number: Int
    init() { self.number = 0 }
    var wrappedValue: Int {
        get { return number }
        set { number = min(newValue, 12) }
    }
}

 

위의 구조체를 이용한 예제는 아래 코드입니다. SmallRectangle 구조체에 height, width 속성이 있고, @TwelveOrLess (wrapper) 를 작성해줌으로 Property wrapper 를 적용할 수 있습니다. 

 

struct SmallRectangle {
    @TwelveOrLess var height: Int
    @TwelveOrLess var width: Int
}

var rectangle = SmallRectangle()
print(rectangle.height)
// Prints "0"

rectangle.height = 10
print(rectangle.height)
// Prints "10"

rectangle.height = 24
print(rectangle.height)
// Prints "12"

 

✔︎ UserDefaults 코드에 Property Wrapper 를 적용하기

 

조언을 듣고 프로젝트의 코드를 보니, UserDefaults 관련 코드들이 key 값만 다르고 전부 같은 코드를 반복해 작성하고 있었습니다. Propery Wrapper 를 이용해 반복되는 코드를 줄여보도록 하겠습니다.

 

1. @propertyWrapper 를 명시한 구조체 UserDefault 를 정의해줍니다.
2. 구조체의 property 를 정의합니다.
3. property 의 초기화를 위해 init 함수를 정의합니다.
4.  wrappedValue 를 정의합니다. * 필수 구현 property 입니다.

wrappedValue 의 getter 는 UserDefaults 를 통해 object 를 가져와 반환하고, setter 는 UserDefaults 를 통해 값을 저장합니다.

 

참고로, 여기서 <T> 는 타입 인자(Type Parameters)로 함수의 인자나 반환 타입으로 사용할 수 있습니다. 타입 인자는 함수가 호출될 때 실제 타입으로 대체되도록 표시됩니다. 

 

@propertyWrapper
struct UserDefault<T> {
    private let key: String
    private let defaultValue: T

    init(key: String, defaultValue: T) {
        self.key = key
        self.defaultValue = defaultValue
    }

    var wrappedValue: T {
        get {
            // Read value from UserDefaults
            return UserDefaults.standard.object(forKey: key) as? T ?? defaultValue
        }
        set {
            // Set value to UserDefaults
            UserDefaults.standard.set(newValue, forKey: key)
        }
    }
}

 

정의한 UserDefault 구조체를 이용하기 위한 코드입니다.  User 구조체에서는 @UserDefault wrapper가 명시된 isApplicationLaunch property 를 갖습니다. property 의 정의와 함께 wrapper 초기화도 진행했습니다. 앱이 처음 실행되는 경우에 정의될것이므로 초기값을 true 로 설정을 해줬습니다. 

 

key 값을 지정하기 위해서 기존에는 "~~" 형태로 바로 작성했는데, 스터디에서 참고로 보내주신 코드에 enum 이 있길래 이용을 해봤습니다.  해당 코드에서는 constant string 을 표현하기 위해 사용된 것 같습니다.

 

struct User {
    @UserDefault(key: keyEnum.isAppFirstLaunch.rawValue, defaultValue: true)
    static var isAppFirstLaunch: Bool
}

enum keyEnum: String {
    case isAppFirstLaunch = "isAppFirstLaunch"
}

 

온보딩 페이지 예제의 SceneDelegate extension 코드에서 아래 함수만 수정해주었습니다. if 구문과 property 값을 설정하는 부분의 코드가 달라졌습니다 🙂 기존과 동일하게 작동하는 것을 확인했습니다.

 

단순히 property 에 값을 대입하는 코드만으로 DB 에 값을 저장할 수 있게 되었네요. DB 에서 값을 가져오는 것은 더욱 간단해졌고요. 

 

extension SceneDelegate {
    private func setRootViewController(_ scene: UIScene){
        if User.isAppFirstLaunch {
            User.isAppFirstLaunch = false
            setRootViewController(scene, name: "Onboarding",
                                  identifier: "OnboardingViewController")
        } else {
            setRootViewController(scene, name: "Main",
                                  identifier: "TodoViewController")
        }
    }
    // ...
 }

 

제가 작성했던 예제는 UserDefaults 에 하나의 값만 저장하고 있지만, 더 많은 값을 저장한다면 유용할거라고 예상됩니다. 👍

---

참고 문서 및 링크

• Swift 공식 가이드 - Property Wrapper (영어)
• Swift 공식 가이드의 번역 포스팅
• Property Wrapper 사용법이 자세한 포스팅

 

관련된 내용

• Swift에서 enum 활용하기
• Swift Generics 정리 (Type Parameter 참고)