NSUserDefaults(UserDefaults)로 간단하게 데이터 저장하기

안녕하세요, 레몬킴 입니다 🍋 요새 UserDefaults와 씨름할 일이 생긴 김에, 아는 대로 정리해보고 있습니다.

 

목차 

1. NSUserDefaults?

2. 어떤 때 사용할까?

3. 특징

4. 간단하게 사용하기

5. 커스텀 클래스 객체 저장하고 꺼내오기

6. UserDefaults를 딕셔너리 형태로 보기

NSUserDefaults?

https://developer.apple.com/documentation/foundation/userdefaults

 

애플에서 제공해주는 간단한 String Key-Value 형태의 저장소입니다. 내부적으로 DB를 사용한다고 합니다. (어떤 DB인지는 못 찾았네요... )여기에 저장되는 값들을 Preferences 라고도 부르기도 합니다.

 

어떨 때 사용할까?

- 앱이 꺼져도 특정한 값이 저장되길 원하는 경우 (첫 번쨰 앱 런칭 여부 등)

- 사용자 설정 (로컬 알림 설정 여부)

- 앱이 꺼져도 특정한 값이 저장되지만, 앱이 삭제되면 같이 사라지길 원하는 경우 

 

특징

1. 앱이 꺼져도 데이터들이 유지되며, 앱이 삭제될 시 데이터들은 함께 사라집니다.

만일 앱이 삭제되어도 데이터가 유지되길 원하신다면 Core Data 혹은 KeyChain, NSKeyedArchiever등을 이용한 파일 형태로 저장하는 것을 추천합니다.

(Volatile Domain을 사용하면 앱이 꺼질 때 자동으로 데이터가 사라지게도 할 수 있습니다)

 

2. String Key-Value 형태의 저장소이며, 저장할 수 있는 값은 Int, Double, Float, String, Bool, Data와, 이로 이루어진 Array, Dictionary만 가능합니다.

 

키로는 String만 사용 가능하고, 저장할 수 있는 값은 Int, Double, Float, String, Bool, Data와, 이로 이루어진 Array, Dictionary만 가능합니다.

 

안타깝게도 커스텀 클래스를 바로 저장할 수 있는 방법은 없으며, NSKeyedArchiever 등을 사용해 Data로 전환한 뒤에 저장해야 합니다.

 

 

 

간단하게 사용하기

standard를 이용한 저장 / 꺼내오기

앱의 공용 기본 NSUserDefaults 를 가져옵니다. standard는 initWithSuite(nil)과 동일합니다.

 

//키로 String을 사용합니다.
let stringKeyForUserDefault = "stringKey"
let immuatablestringKeyForUserDefault = "immutablestringKey"
let floatKeyForUserDefault = "floatKey"

//저장
UserDefaults.standard.set("졸려유", forKey: stringKeyForUserDefault)
UserDefaults.standard.set(4.5, forKey: floatKeyForUserDefault)
UserDefaults.standard.set(NSMutableString(string: "결국 나오는 건 Immutable ~.~"), forKey: immuatablestringKeyForUserDefault)

//꺼내오기
print(UserDefaults.standard.string(forKey: stringKeyForUserDefault))
print(UserDefaults.standard.float(forKey: floatKeyForUserDefault))
print(UserDefaults.standard.string(forKey: immuatablestringKeyForUserDefault))

커스텀 클래스 객체를 저장하고 꺼내오기

안타깝게도 커스텀 클래스의 객체를 바로 저장할 수는 없습니다. 애플에서는 NSKeyedAchiever를 이용해 Data(NSData) 형식으로 변환해서 저장하라고 권장하고 있습니다.

 

1. 저장할 클래스를 NSObject의 하위클래스로, NSCoding 프로토콜을 준수하게 변경

2. NSKeyedArchiever로 Data로 변경 후 저장

3. NSkeyedUnArchiever로 원하는 객체를 복구해오기

 

1. 저장할 클래스를 NSObject의 하위클래스로, NSCoding 프로토콜을 준수하게 변경

(NSObject가 아니면 methodForSignature 메소드를 못 찾는다며 에러를 퉤 뱉습니다... )

//Person. NSObject와 NSCoding


class Person : NSObject ,NSCoding {

    
    var name : String
    var age : Int
    
    init(name aName :String, age aAge : Int) {
        self.name = aName
        self.age = aAge
    }
    
    //NSCoding Protocol 구현
    
    required init?(coder: NSCoder) {
        self.name = coder.decodeObject(forKey: "name") as! String
        self.age = coder.decodeInteger(forKey: "age")
    }
    
    func encode(with coder: NSCoder) {
        coder.encode(self.name, forKey: "name")
        coder.encode(self.age, forKey: "age")
    }
    
}
        

 

2. NSKeyedAchiever로 Data로 변경 후 저장

 
  	do {
		//Data로 클래스를 변경합니다.
		//secureCoding을 true로 하려면, 클래스가 NSSecureCoding을 따라야 합니다.
		let mePropertyListData = try NSKeyedArchiver.archivedData(withRootObject: me, requiringSecureCoding: false)
    
    	//저장합니다
		UserDefaults.standard.set(mePropertyListData, forKey: "me")
	}
	catch
        {
            print(error)
        }
        
        
        
         
        

 

3. NSkeyedUnArchiever로 원하는 객체를 복구해오기

 

NSKeyedUnarchiver로 복호화 할 수 있습니다. do - catch 블럭으로 감싸주어야 합니다.

let achievedData = UserDefaults.standard.object(forKey: objectKey)
        
do {
	let person = try NSKeyedUnarchiver.unarchiveTopLevelObjectWithData(achievedData as! Data) as! Person
	print(person.name)
	print(person.age)
}
catch {
	print(error)
}

 

UserDefaults를 Dictionary 형태로 가져오기

dictionaryRepresentation()로 UserDefaults를 Dictionary형태로 가져올 수 있습니다. 

let standard = UserDefaults.standard
print(standard.dictionaryRepresentation())

출력하면 넣은 적이 없는 많은 기본 요소들과 함께, 위에서 저장했던 값들이 들어가 있는 모습을 볼 수 있습니다...

["AppleITunesStoreItemKinds": <__NSCFArray 0x600001153980>(

eBook,

artist

)

, "objectKey": <62706c69 73743030 d4010203 04050607 0a582476 65727369 6f6e5924 61726368 69766572 5424746f 7058246f 626a6563 74731200 0186a05f 100f4e53 4b657965 64417263 68697665 72d10809 54726f6f 748001a4 0b0c1314 55246e75 6c6cd30d 0e0f1011 12546e61 6d655361 67655624 636c6173 73800210 22800359 4c656d6f 6e204b69 6dd21516 17185a24 636c6173 736e616d 65582463 6c617373 65735f10 1a467261 6d65776f 726b506c 61796772 6f756e64 2e506572 736f6ea2 191a5f10 1a467261 6d65776f 726b506c 61796772 6f756e64 2e506572 736f6e58 4e534f62 6a656374 08111a24 29323749 4c515358 5e656a6e 7577797b 858a959e bbbedb00 00000000 00010100 00000000 00001b00 00000000 00000000 00000000 0000e4>, "PKKeychainVersionKey": 6, "NSInterfaceStyle": macintosh, "AddingEmojiKeybordHandled": 1, "stringKey": 졸려유, "AppleLanguagesSchemaVersion": 1001, "me": <62706c69 73743030 d4010203 04050607 0a582476 65727369 6f6e5924 61726368 69766572 5424746f 7058246f 626a6563 74731200 0186a05f 100f4e53 4b657965 64417263 68697665 72d10809 54726f6f 748001a4 0b0c1314 55246e75 6c6cd30d 0e0f1011 12546e61 6d655361 67655624 636c6173 73800210 22800359 4c656d6f 6e204b69 6dd21516 17185a24 636c6173 736e616d 65582463 6c617373 65735f10 1a467261 6d65776f 726b506c 61796772 6f756e64 2e506572 736f6ea2 191a5f10 1a467261 6d65776f 726b506c 61796772 6f756e64 2e506572 736f6e58 4e534f62 6a656374 08111a24 29323749 4c515358 5e656a6e 7577797b 858a959e bbbedb00 00000000 00010100 00000000 00001b00 00000000 00000000 00000000 0000e4>, "AKLastIDMSEnvironment": 0, "CarCapabilities": {

    CarCapabilitiesDefaultIdentifier =     {

        CRCapabilitiesDisabledFeatureKey = 0;

        CRCapabilitiesUserInterfaceStyleKey = 2;

        CRCapabilitiesVersionKey = "";

        CapabilitiesDashboardRoundedCornersKey = "{{13, 0}, {0, 0}}";

        CapabilitiesNowPlayingAlbumArtKey = 2;

        CapabilitiesViewAreaInsetKey = "{{0, 0}, {0, 0}}";

    };

}, "AKLastEmailListRequestDateKey": 2020-01-23 09:55:52 +0000, "AppleKeyboards": <__NSCFArray 0x60000277ada0>(

en_US@sw=QWERTY;hw=Automatic,

emoji@sw=Emoji,

ko_KR@sw=Korean;hw=Automatic,

en_US@sw=QWERTY;hw=Automatic

)

, "AppleKeyboardsExpanded": 1, "floatKey": 4.5, "AppleLanguages": <__NSCFArray 0x600001153a40>(

en,

ko-KR

)

, "ApplePasscodeKeyboards": <__NSCFArray 0x60000277ad50>(

en_US@sw=QWERTY;hw=Automatic,

emoji@sw=Emoji,

ko_KR@sw=Korean;hw=Automatic

)

, "immutablestringKey": 결국 나오는 건 Immutable ~.~, "NSLanguages": <__NSArrayI 0x600000442b00>(

en,

ko-KR

)

]

+ 이를 이용해서 UserDefaults를 초기화 하는 스니펫이 있다고 합니다! 아래 블로그를 참조해 주세용

http://minsone.github.io/mac/ios/clear-userdefaults-value-in-swift

[Swift]NSUserDefaults 값 초기화하기

 

이렇게 간단하게 UserDefaults를 사용하고, 내용을 조회하는 것까지 정리해보았습니다. 

 

이 외에도 initWithSuite, addSuite를 이용해서 저장소를 분리하거나 합칠 수 있는 방법도 있고,

setVolatileDomain를 이용해 앱이 켜져 있는 동안에만 데이터를 저장하는 것도 있습니다만, 아직 제가 파악이 다 끝나지 않아서... 이건 좀 더 공부하고 정리해봐야겠습니다.

 

이만 정리하고, 다음에 뵙겠습니다. 오늘도 즐거운 하루 되시길 :)