[ iOS ] UserDefaults - 커스텀 타입 저장하기 (Attempt to insert non-property list object 오류)

 

 

UserDefaults와 non-property list 오류

UserDefaults는 Float, Double, Int, URL 등 기본 타입에 대한 편리한 메서드들을 제공한다. 게다가 NSData, NSString, NSNumber, NSDate, NSArray, NSDictionary 타입이라면 UserDefaults에 자유롭게 저장 및 불러올 수 있다. 하지만 개발을 할 때에는 보통 아래 예시와 같이 커스텀한 타입을 사용한다. 

struct User {
   let name: String
   let age: String
}

 

이 커스텀 타입의 객체를 생성해 UserDefaults에 저장해보자.

let user = User(name: "사용자", age: "12")

Userdeafaults.standard.setValue(user, forKey: "userSave")

 

 

아쉽게도 UserDefaults는 NSData, NSString, NSNumber, NSDate, NSArray, NSDictionary 등 standard 타입이 아니면 저장하거나 불러올 수 없으며, 아래의 오류가 발생한다.

"Attempt to insert non-property list object 파일명.User(~~) for key userSave "

여기서 Property list는 객체 직렬화를 위한 파일이다. plist라는 확장자를 가지며 우리가 아는 info.plist가 바로 property list이다.

즉 위의 저 오류는 객체 직렬화 파일이 아닌 User 객체를 UserDefaults에 저장하려 해서 발생한 오류이다.

 

 

UserDefaults의 공식문서를 참고하면, UserDefaults는  property list 여야 한다고 나와있다. 그리고 Apple은 개발자가 커스텀한 타입의 객체를 UserDefaults에 할당하고 싶은 경우 객체를 NSData 타입으로 변환하는 것을 권장한다. 여기서 NSData는 property list 타입 중 하나이다. 우리는 Object-C 관련한 코드가 없으므로 Data 타입으로 변환해보자.

default 객체는 NSData, NSString, NSNumber, NSDate, NSArray, NSDictionary의 인스턴스와 같은  property list가 되어야한다. (또는 컬렉션 타입인 경우 인스턴스의 조합이어야 한다.)
 만약 다른 타입의 객체를 저장하길 원한다면, 객체를 NSData 인스턴스로 만들어 보관해야 한다.

 

 

 

들어가기 전 Serializarion 공부하기

[ Swift ] Serialization이란?

 

 

 

 

 

커스텀 객체를 Serializarion하기

이와 관련한 Apple의 공식문서 Archives and Serialization 를 보면, serializarion을 하기 위해서는 Encoder와 Decoder API들을 사용하라고 나와있다.

앱의 메모리 내 타입을 입출력과 네트워크 인터페이스를 통한 직렬화(Serialization) 또는 장기간의 저장에 적합한 표현으로 변환하기 위해 이 API들을 사용하라.
 
Swift에서, standard 라이브러리는 Encodable, Decodable과 Codable 타입들(Int, String 등)을 정의하고, 덧붙여 'Encoding, Decoding, and Serialization'에서 설명되어있듯이 encoding과 decoding을 수행하는 Encoder와 Decoder APIs를 정의한다. 

 

 

그럼 커스텀 객체에 Encoder, Decoder를 사용해 바로 Serialization을 할 수 있을까? 아쉽지만 커스텀 타입는 standard 타입들과 다르게 Codable하지 않다. 따라서 선언부의 상속 목록에 Codable을 채택해줌으로써 Codable하게 만들어주자. 만약 decoding이 필요없는 커스텀 타입라면 Encodable을, encoding이 필요없는 커스텀 타입이라면 Decodable을 명시하자. Apple의 공식문서인 Encoding and Decoding Custom Types 를 보면 예시가 잘 나와있다.

struct Coordinate: Codable {    
    var latitude: Double    
    var longitude: Double
}

struct Landmark: Codable {    
    // Double, String, and Int all conform to Codable.    
    var name: String    
    var foundingYear: Int
    
    // Adding a property of a custom Codable type maintains overall Codable conformance.    
    var location: Coordinate
}

 

 

커스텀 타입이 이제 Codable하니 Endcoder를 통해 커스텀 객체를 Data 타입으로 변환할 차례이다. Encoder 프로토콜을 준수하는 class 중 PropertyListEncoder가 있다. 아래의 encode 메서드를 사용하면 Data 타입을 반환받을 수 있다. 만약 JSON 타입을 사용하는 네트워크 통신을 할 계획이라면 JSONEncoder를 통해 Serializarion 해줄 수도 있다.

func encode<Value>(_ value: Value) throws -> Data where Value : Encodable

 

 

커스텀 객체를 Serializion해 UserDefaults에 저장하고 꺼내오기 예시

struct MessageModel: Codable {
    let text: String
}

let message = MessageModel(text: "저장하기 버튼을 눌렀습니다.")
let userDefault = UserDefaults.standard

//UserDefaults에 저장하기
let pEncoder = PropertyListEncoder()
let encodedData = try? pEncoder.encode(message)
userDefault.set(encodedData, forKey: "BlogTestEx_PropertyListEncoder")

//UserDefaults에서 꺼내오기
let userData = userDefault.object(forKey: "BlogTestEx_PropertyListEncoder")
guard let object = userData as? Data else { return }
        
let pDecoder = PropertyListDecoder()
let decodedData = try? pDecoder.decode(MessageModel.self, from: object)
if let message = decodedData {
    self.textLabel.text = message.text
}