[iOS, Swift] UserDefault 사용해서 데이터 저장, 사용하기

⭐️ UserDefault 란 ?

• iOS에서 데이터를 보관하기 위한 방법 중 하나
• 기본적으로 메모리 상에서 모든 데이터를 관리한다. 즉 메모리 캐싱을 한다.
• 사용자의 정보라던가 게시물에 대한 정보처럼 대용량의 데이터를 저장할 때 사용하지 않고,
• 자동 로그인 여부, 아이디 저장, 환경설정에서 설정하는 설정 데이터 값(사용자가 선호하는 측정 단위나 미디어 재생 속도 등) 같은 단일 데이터 등을 UserDefaults로 담아서 보관

 

공식 문서 : https://developer.apple.com/documentation/foundation/userdefaults

Apple Developer Documentation

---

⭐️ UserDefault 특징

• 런타임 환경(앱이 실행되는 동안)에서 동작, 앱이 실행되는 동안 기본 데이터베이스에 접근해 key-value의 형태로 데이터를 기록하거나 가져온다.
• [데이터(value), 키(key)]으로 데이터를 저장
  • 키(key)의 값은 String
  • 데이터(value)는 모든 객체 가능

• 우리가 iOS에 앱을 설치하면 앱이 실행되는 시점에 데이터를 저장할 수 있는 기본 데이터베이스가 생성된다.
• 기본 데이터베이스는 Property List를 기반으로 하며, .plist 파일에 xml 형식으로 데이터가 저장된다.
• 이 plist 파일은 SandBox 내의 Bundle Container에 저장 > 앱 삭제 시 같이 삭제된다.

---

⭐️ UserDefault 사용하기 - Swift

1. set

let userName = "여닝"
UserDefaults.standard.set(userName, forKey: "name")

2. get 

UserDefaults.standard.string(forKey: "name")

3. remove 

UserDefaults.standard.removeObject(forKey: "name")

4.  전체 UserDefault 객체 목록 조회

for (key, value) in UserDefaults.standard.dictionaryRepresentation() {
  print("\(key) = \(value) \n")
}

---

⭐️  UserDefault 사용하기 - Objective-C

1. set

[[NSUserDefaults standardUserDefaults] setObject:false forKey:@"TEST_INVALID"]

2. get 

[[NSUserDefaults standardUserDefaults] objectForKey:@"TEST_INVALID"]

---

⭐️ UserDefault 잘 저장 되었는지 확인하기 - plist 파일 확인

Data container 안의 Library > Preferences 내 plist 파일에서 확인 가능

 

해당 경로 확인하는 법 : NSHomeDirectory 사용

//UserDefaults 데이터 저장
UserDefaults.standard.setValue(true, forKey: "test")
//저장 경로 출력
print("App Directory path : \(NSHomeDirectory())")

[출력값]

출력된 경로에서 Library > Preferences  > 앱번들ID.plist 파일 확인

plist 파일을 열면 다음과 같이 저장이 잘 되어 있다!

---

⭐️ UserDefault에 struct 저장하기

“Attempt to insert non-property list object” 오류 해결하기

 

아래 블로그 참고를 많이 했다.

https://ios-development.tistory.com/702

 

요약 정리하자면,

Swift는 메모리 혹은 디스크에 객체 정보를 저장할 때, byteBuffer를 사용해서 저장

> 저장할 때, 아카이빙을 통해 바이트 형태로 변경하는 작업이 필요

> 기본타입인 Int, Double, String은 Userdefault에 저장할 때 내부적으로 작업이 진행

> 하지만, Struct의 경우 직접 아카이빙 작업을 수행해 줘야함!!!!!

> 따라서 위 에러는 아카이빙해주지 않아 발생하는 에러~~~~

아래는 Solution!

먼저, Struct에 Codable 프로토콜 준수해야 함

struct SubjectModel: Codable {
    let code: Int
    let value: String
    let topic: String
}

propertyWrapper를 이용하여 아카이빙, 언아카이빙 내부적으로 구현해준다.

struct UserDefaultsManager {
    @UserDefaultWrapper(key: "subjectList", defaultValue: nil)
    static var subjectList: [SubjectModel]?
}

//UserDefaultWrapper 정의
@propertyWrapper
struct UserDefaultWrapper<T: Codable> {
    private let key: String
    private let defaultValue: T?

    init(key: String, defaultValue: T?) {
        self.key = key
        self.defaultValue = defaultValue
    }
    
    var wrappedValue: T? {
        get {
        	// 언아카이빙 정의 : JSONDecoder 사용
            if let savedData = UserDefaults.standard.object(forKey: key) as? Data {
                let decoder = JSONDecoder()
                if let lodedObejct = try? decoder.decode(T.self, from: savedData) {
                    return lodedObejct
                }
            }
            return defaultValue
        }
        set {
        	// 아카이빙 정의 : JSONEncoder 사용
            let encoder = JSONEncoder()
            if let encoded = try? encoder.encode(newValue) {
                UserDefaults.standard.setValue(encoded, forKey: key)
            }
        }
    }
}

저장하고 볼러올 때는 아래와 같이 사용했다.

let dataString = String(data: response.data!, encoding: .utf8)
let data = dataString!.data(using: .utf8)!
if let jsonArray = try JSONSerialization.jsonObject(with: data, options : .allowFragments) as? [Dictionary<String,Any>]{
    UserDefaultsManager.subjectList = []
    for subject in jsonArray{
        let subjectData = SubjectModel(code: subject["code"] as! Int,
                                       value: subject["value"] as! String,
                                       topic: subject["topic"] as! String)
        //저장하기                            
        UserDefaultsManager.subjectList!.insert(subjectData, at: 0)
    }
}
//불러오기
print(UserDefaultsManager.subjectList)