UserDefaults

Created

2023/09/28 06:54

UserDefaults는 어디에 저장될까?

우리가 iOS에 앱을 설치하면 앱이 실행되는 시점에 데이터를 저장할 수 있는 기본 데이터베이스가 생성된다.

기본 데이터베이스는 Property List를 기반으로 하며, .plist 파일에 xml 형식으로 데이터가 저장된다.

그리고 기본 데이터베이스인 plist 파일이 SandBox내의 Bundle Container에 저장된다.

Sandboxing

https://emptyhead.oopy.io/f7cdbc28-ea12-4a8f-9b91-5e507f7350c1

plist 파일이 SandBox 내에 존재하기 때문에, 앱을 꺼도 데이터가 유지되며 앱을 삭제한 경우에만 해당 파일에 저장한 데이터가 제거된다.

때문에 UserDefaults를 사용할 때는 대용량의 데이터나 사용자 정보 같은 데이터를 다룰 떄보다는

자동 로그인 여부, 아이디 저장, 알림 설정 여부 등과 같은 단일 데이터를 주로 저장한다.

macOS의 UserDefaults 살펴보기

/Users/사용자이름/Library/Preferences/
Shell
복사

여기에 들어가면 여러 plist 파일을 발견할 수 있다.

파일을 보면 UserDefaults를 통해 저장된 데이터 뿐만 아니라, 인터페이스 빌더 등에서 사용하는 AutoSave 항목 등 앱의 정보 또한 저장되어 있는 것을 알 수 있다.

iOS의 UserDefaults 살펴보기

iOS의 경우, xcode를 활용하여 확인할 수 있다.

먼저 아이폰과 맥 기기를 연결한다.

xcode를 실행하고 다음 경로로 이동한다.

Window > Devices and Simulators

Devices 탭을 보면 연결한 기기의 이름이 나타난다.

plist 파일이 보고 싶은 앱을 선택한 뒤, 연두색 아이콘을 누르고 Download Container를 클릭한다.

이후, 다운로드한 xcappdata 파일을 우클릭해 패키지 내용 보기를 클릭한다.

Appdata > Library > Preferences

위 경로로 이동하면 plist 파일을 확인할 수 있다.

UserDefaults.standard

싱글톤 인스턴스로, 공유된 기본 값 객체를 반환하는 함수이다.

let defaults = UserDefualts.stand
Swift
복사

데이터 저장하기

데이터를 저장할 때는 set 메서드를 사용한다.

defaults.set("value", forkey: "key")
Swift
복사

이때, key 값은 항상 String 이어야 한다.

String 외에도 Float, Int, Bool, URL 등의 타입을 저장할 수 있다.

참고로 nil 값을 저장하면 해당 데이터를 지우는 것과 동일한 효과이다. 필요없다면 nil을 넣으면 된다.

데이터 가져오기

저장한 데이터를 꺼내올 때는 타입에 맞게 가져와야 한다.

let data1 = defaults.objects(forkey: "key") as! String
let data2 = defaults.string(forkey: "key")
Swift
복사

타입을 신경쓰지 않고 꺼낸 뒤, 올바른 타입으로 타입캐스팅을 해주거나, 타입에 맞는 메서드를 사용한다.

전체 데이터 가져오기

기본 데이터베이스에 저장되어 있는 모든 key-value 쌍을 가져올 때는 dictionaryRepresentation() 메서드를 사용한다.

let defaults = UserDefaults.standard

for (key, value) in defaults.dictionaryRepresentation() {
		print("\\(key): \\(value)")
}

_ = defaults.dictionaryRepresentation().map {
		print("\\($0.key): \\($0.value)")
}

defaults.dictionaryRepresentations().forEach {
		print("\\($0.key): \\($0.value)")
}
Swift
복사

dictionaryRepresentation() 메서드만 사용하고 for문이던, map이던 불러오는 형식은 자기 마음이다.

기본 데이터베이스 내의 모든 key 또는 value만 보고 싶을 때는 이렇게

defaults.dictionaryRepresentation().keys
defaults.dictionaryRepresentation().values
Swift
복사

사용자 정의 타입 저장하기

구조체나 클래스의 인스턴스 등 사용자 정의 타입의 경우네는 직접 바꾸어야 한다.

그냥 저장한다면

UserDefaults는 Data형을 따르는데, 이 Data 타입은 Base64 인코딩 형식을 따른다.

즉, 저장할 객체는 모두 Base64 인코딩을 거쳐야 한다.

기본 타입인 Int, String 등은 UserDefaults를 사용할 때 내부적으로 적용되지만, 구조체 같은 경우에는 직접 변환해야 한다.

JSONEncoder / Decoder

JSONEncoder / Decoder를 사용해 객체를 저장 가능한 바이너리 타입으로 인코딩 / 디코딩해서 사용하는 방법

먼저 구조체를 Codable 로 선언한다.

struct Diary: Codable {
	var uuid: String
	var title: String
	var contents: String
}
Swift
복사

데이터를 넣은 뒤, JSONEncoder() 를 사용해 데이터를 저장한다.

let diary = Diary(uuid: "uuid", title: "title", contents: "contents")

let defaults = Userdefaults.standard
let encoder = JSONEncoder()

if let encodedData = try? encoder.encode(diary) {
		defaults.set(encodedData, forkey: "diary")
}
Swift
복사

데이터를 불러올 때는 JSONDecoder() 를 사용한다.

let decoder = JSONDecoder()

if let data = defaults.object(forkey: "diary") as? Diary {
		if let decodedData = try? decoder.decode(Diary.self, from: data) {
				print(decodedData)
		}
}
Swift
복사

Reference

UserDefaults | Apple Developer Documentation

An interface to the user’s defaults database, where you store key-value pairs persistently across launches of your app.

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

[iOS] UserDefaults 박살내기!

뿌셔뿌셔 먹고싶다.

https://velog.io/@gnwjd309/iOS-UserDefaults