[iOS][CN] UserDefaults 사용하기

728x90

끄적끄적 (이 내용은 넘겨도 돼요)

아주 오래 전에, iOS의 배포 과정이 궁금하여 아주 간단한 앱을 출시해 본 적이 있다.

최근 포폴 정리도 할겸 애플 개발자 계정에 들어갔는데, 생각보다 많은 사람들이 앱을 사용하고 있었다.

정말 기본 중에 기본이었던 앱인데, 이렇게나 많은 사용자가 있다니,,

(근데 아무도 리뷰를 달지 않아 아무런 피드백을 받지 못하고 있다는,,,)

아직 분석 부분을 보는 방법도 모르지만.. (평균 유지율이 데이터 부족이면 아무도 유지 안하는건가 혹시)

 

그래도 누군가 사용하고 있으니

아직 개발자가 이 앱에 꾸준히 시간을 쏟고 있다는 것을 보여주고자,, 업데이트를 결심하게 되었다.

자자 그럼 이제 UserDefaults에 대해 알아보자 !!

 

 

UserDefaults 언제 사용하나?

나는, 햅틱 기능을 추가했는데, 해당 기능의 On, Off를 관리하기 위해 사용했다.

 

UserDefaults에 대한 공식 문서를 봐보자

An interface to the user’s defaults database, where you store key-value pairs persistently across launches of your app.
-> 앱이 실행될 때마다 사용자의 기본값 데이터베이스에 키-값 쌍을 지속적으로 저장하는 인터페이스라는 말이다.

 

더 쉽게 말하면, 런타임에서, UserDefaults 객체를 사용하여 앱에서 사용하는 기본값을 사용자의 기본값 데이터베이스에서 읽을 수 있다. UserDefaults는 이 정보를 캐시하여 매번 데이터베이스를 열지 않고도 기본값을 사용할 수 있도록 한다.

 

이 외에 공식 문서 내용을 정리하면,

1. UserDefaults 클래스는 사용자의 기본값 시스템을 다룰 수 있는 프로그래밍 인터페이스를 제공한다.

2. 이 기본값 시스템을 사용하면 앱이 실행될 때 사용자 개인의 선호도에 맞게 앱의 동작을 맞출 수 있다.

- 예를 들어, 사용자가 선호하는 단위나 미디어 재생 속도를 설정할 수 있다.

3. 앱은 이러한 선호도를 사용자의 기본값 데이터베이스에 저장하여, 앱이 시작될 때 기본 상태를 설정하거나 앱의 기본 동작을 결정하는 데 사용된다.

 

결국! 쉽게 말해 UserDefaults는 사용자가 설정한 언어, 테마, 마지막 로그인 정보 등을 저장할 때 주로 사용한다.

 

 

 

UserDefaults는 어디에 있는거죠?

문득 UserDefaults는 어디에 있길래 앱을 아예 종료하고, 다시 들어와도 그 값이 저장 되는지 궁금했다.

UserDefaults는 앱 내에서만 사용되며, 시스템의 "기본값" 저장소에 해당한다고 한다.

실제로는 해당 값들이 파일 시스템에 저장되는데, 이는 일반적으로 앱 샌드박스 내의 파일 시스템에 위치한다.

그래서 사용자가 앱을 재설치하거나, 앱 데이터가 삭제되지 않는 한 값이 유지된다.

 

 

어떻게 사용하나요?

그럼 이제 어떻게 사용하는지 정리해보자.

UserDefaults를 사용하는 방법은 다양한데, 나는 JSONEncoder/Decoder 방식을 선택했다.

먼저 필요한 데이터를 구조체 형태로 저장해주었다. 

Codable 타입으로 저장하여 인코딩과 디코딩 할 때 데이터 변환이 쉽게 이루어지도록 했다.

struct UserInfo: Codable {
    var isAnimation : Bool
    var isHaptic : Bool
}

 

 

다음으로 userInfoManager 클래스를 생성하였다.

이 클래스는 UserInfo 데이터를 관리하는 역할을 할 것이다.

즉, UserInfo에 있는 애니메이션과 햅틱 설정을 UserDefaults를 사용하여 앱을 다시 실행해도 이 설정 값들이 유지되도록 관리하기 위함이다.

class userInfoManager {
    static let shared = userInfoManager() // 1️⃣ 싱글톤패턴
    private let key = "userInfo"
    
    var userInfo: UserInfo {
        get {
            if let data = UserDefaults.standard.data(forKey: key), // 2️⃣ UserDefaults에서 데이터를 가져옴
               let decoded = try? JSONDecoder().decode(UserInfo.self, from: data) { // 3️⃣ JSONDecoder를 사용해 디코딩
                return decoded // 4️⃣ 디코딩 성공하면 값을 반환
            }
            return UserInfo(isAnimation: true, isHaptic: true) // 5️⃣ 저장된 값이 없으면 기본값 반환
        }
        set {
            if let encoded = try? JSONEncoder().encode(newValue) { // 6️⃣ JSONEncoder를 사용해 인코딩
                UserDefaults.standard.set(encoded, forKey: key) // 7️⃣ UserDefaults에 저장
            }
        }
    }
}

 

1. 싱글톤 패턴

static let shared = userInfoManager()

싱글톤 패턴을 사용해 앱 전체에서 단 하나의 인스턴스만 존재하게 된다. 이렇게 싱글톤 패턴을 사용함으로써 동일한 데이터를 접근하고 수정할 때 유용하게 할 수 있다.

 

2. UserDefaults에서 데이터 가져오기

UserDefaults.standard.data(forKey: key) 로 데이터를 가져온다.

코드를 쉽게 설명해보면,

 

• UserDefaults란?
  • UserDefaults는 간단한 데이터 저장소로, 앱을 종료하고 다시 실행해도 데이터를 유지할 수 있다. 
• forKey: key란?
  • forKey: key는 저장된 데이터를 찾을 때 사용하는 식별자이다.
  • 데이터는 key라는 이름으로 저장되고, 이 이름을 통해 나중에 데이터를 불러올 수 있다.
• data(forKey:)란?
  • data(forKey:)는 UserDefaults에 저장된 데이터를 바이트 배열 형식으로 가져온다.
  • 이 데이터는 우리가 원하는 타입으로 변환해야 사용할 수 있다.
  • 예를 들어, UserDefaults에 저장된 데이터가 UserInfo 구조체라면, 이를 JSONDecoder로 디코딩하여 UserInfo 객체로 변환해야 한다.

3~6. UserDefaults 에 있는 정보 인코딩, 디코딩 하기

 

위 코드를 보면 디코딩과 인코딩 과정이 있다.

크게 get과 set으로 나뉘는데, UserDefaults는 Bool, Int, Double, String, Data, Array, Dictionary 같은 기본 타입만 저장할 수 있다.

하지만 위에서 정의한 UserInfo는 구조체이므로 그대로 저장할 수 없다.

그렇기 때문에 JSONEncoder로 변환(인코딩)하고, 다시 불러올 때 JSONDecoder로 변환(디코딩)하는 것이다.

 

7. UserDefaults에 정보 저장하기

UserDefaults.standard.set(encoded, forKey: key)

정보를 저장할 때는 set함수를 사용하여 정보를 저장한다.

이 때, nil 값을 저장하게 된다면, 이는 데이터를 지우는 것과 같다고 한다.

즉, 데이터를 삭제하려면, nil을 넣어주면된다 !

 

 

전체 코드는 다음과 같다.

 

전체 코드

struct UserInfo: Codable {
    var isAnimation : Bool
    var isHaptic : Bool
}

class userInfoManager {
    static let shared = userInfoManager() // 1️⃣ 싱글톤패턴
    private let key = "userInfo"
    
    var userInfo: UserInfo {
        get {
            if let data = UserDefaults.standard.data(forKey: key), // 2️⃣ UserDefaults에서 데이터를 가져옴
               let decoded = try? JSONDecoder().decode(UserInfo.self, from: data) { // 3️⃣ JSONDecoder를 사용해 디코딩
                return decoded // 4️⃣ 디코딩 성공하면 값을 반환
            }
            return UserInfo(isAnimation: true, isHaptic: true) // 5️⃣ 저장된 값이 없으면 기본값 반환
        }
        set {
            if let encoded = try? JSONEncoder().encode(newValue) { // 6️⃣ JSONEncoder를 사용해 인코딩
                UserDefaults.standard.set(encoded, forKey: key) // 7️⃣ UserDefaults에 저장
            }
        }
    }
}

 

 

이렇게 UserDefaults를 사용하여 사용자가 설정한 내용을 저장해보았다.

UserDefaults를 사용하니 싱글톤 패턴을 써서 아무곳에서나 필요할 때 불러오고, 업데이트 할 수 있어 편리했다.

 

 

다른 뷰에서 사용하기

let savedUser = UserInfoManager.shared.userInfo
if savedUser.isHaptic == true {
    HapticManager.shared.hapticImpact(style: UIImpactFeedbackGenerator.FeedbackStyle.light)
}

이런식으로 savedUser 변수에 저장돼 있는 정보를 다시 저장하고, 해당 내용이 true로 설정되어 있으면 그에 맞는 햅틱을 주었다.

toggleSwitch.isOn = savedUserInfo.isAnimation

그리고, 만약 사용자가 설정을 바꾸면 바뀐 내용을 다시 UserDefaults에 업데이트 해주었다.

 

 

지금까지 잘 알지도 못하면서 UserDefaults에 냅다 저장해서 데이터를 쉽게 불러오곤 했었는데 이제야 제대로 알게됐다.

시간은 꽤 걸렸지만, 그래도 알고 나니 더 잘 사용할 수 있을 것 같다 !