[Android] SharedPreferences보다 안전하게 DataStore를 이용하여 데이터 저장하기

🧐 들어가며

 안드로이드에서 단순한 데이터셋을 로컬에 저장하기 위해서 흔히 SharedPreferences를 사용한다.

안드로이드에 기본적으로 내장되어 있는(=Since api level 1) 것으로 필자도 자주 사용했다.

하지만 Primitive data만 저장 가능했으며, 커스텀 데이터 타입 저장을 위해 GSON을 통해 Json String으로 변환하여 저장하는 코드들이 생겨났다. 그리고 미숙한 처리에 종종 런타임 에러, ANR을 발견할 수 있었다.

 

 이제는 Jetpack DataStore를 통해 더 안전하게 데이터를 저장할 수 있다. 알아보도록 하자.

 

---

👎 SharedPreferences 단점

 SharedPreferences를 적절하게 사용하지 못했을 때 여러 단점들을 찾을 수 있다.

• 실제 XML 파일 I/O 작업을 하는 것으로 UI Thread에서 작업할 경우 안전하지 않다.
• Runtime Exception으로부터 안전하지 않다.
• XML 파일이기에 외부에서 쉽게 파일을 읽을 수 있다. (DataStore도 읽을 수는 있다)
• 비동기 API를 제공하지만 Listener를 통해서만 값을 읽을 수 있다.
• Type-Safety를 제공하지 않는다.

 

---

🤔 DataStore?

 도입에서 설명했듯이 SharedPreferences를 대체하기 위해 Jetpack에서 발표한 라이브러리다.

 Kotlin coroutine과 Flow를 사용하여 비동기적으로, 일관되게 데이터를 저장할 수 있다.

 

DataStore에는 SharedPreferences처럼 key-value 형태로 저장할 수 있는 Preferences DataStore,
커스텀 데이터 타입을 Protocol buffer를 통하여 저장하는 Proto DataStore로 나뉜다.

 

 Preferences DataStore은 아쉽게도 Type-Safety를 제공하지는 않는다.

그러나 Proto DataStore에서 미리 정의된 schema를 통하여 Type-Safety를 보장한다.

 

 아래 표를 통해서 SharedPreferences를 대체하여 DataStore를 왜 사용해야 하는지, 비교하며 알아갈 수 있다.

 

출처 : Android Developers Blog

 

---

🔨 Implementation

 해당 포스팅에서는 Preferences DataStore의 구현만 다루도록 하겠다. (Proto DataStore 추후 포스팅)

 

 Preferences DataStore에 알람 ON/OFF 값(boolean)을 저장하는 예시를 다루겠다.

 

📌 Dependency 추가

 build.gradle에 DataStore Preferences를 추가한다.
Proto DataStore는 다른 dependency를 추가해야하므로 공식 문서를 참고하자. 공식 문서

 

dependencies {
        implementation("androidx.datastore:datastore-preferences:1.0.0-rc01")
}

 

 

📌 DataStore Instance 생성

 상단 파일(Top-Level) 또는 Application 클래스, 싱글톤 형태 등 적절한 위치에 Instance를 한 번만 생성하여 사용해야한다.
preferencesDataStore라는 Read-only의 위임 프로퍼티(delegated properties)를 사용하여 만든다.

 필자는 파일을 생성하여 글로벌한 레퍼런스를 갖도록 하였다. 

 

val Context.dataStore: DataStore<Preferences> by preferencesDataStore(
	name = DataStoreKey.DATA_STORE_NAME // like "user_info"
)

 name 매개 변수는 필수적으로 입력해야하며 DataStore의 이름을 입력해주면 된다. 폴더라고 생각하면 쉽다.

 

 

📌 DataStore Key 정의

 저장하고자 하는 데이터의 형태에 따라서 Key의 이름을 입력한다.

 포스팅 예시에서는 알람 ON/OFF 상태를 표시하기 위해 boolean 형태를 사용할 것이며, Int, String 등 다른 타입을 사용하기 위해서는 다른 함수를 사용하면 된다.

 

val IS_NOTIFICATION_ON = booleanPreferencesKey("is_notification_on")

 DataStore Key는 데이터를 저장하거나 읽어올 때 필요하다.

어플리케이션 개발을 하다보면 여러 키의 관리가 필요할 수 있으니 DataStore Key를 관리하는 object를 만들어 저장하는 것도 방법이다.

 

 

📌 값 저장하기

 DataStore.edit()에 트렌젝션 방식으로 값을 저장할 수 있는 transform 람다 블록을 제공한다.

 해당 블록의 인자인 MutablePreferences(하단 코드는 pref로 지칭)의 변경할 Key에 값을 넣어준다.

 

class SomeWhereActivity : AppCompatActivity() {
	val dataStore = applicationContext.dataStore
    
    suspend fun saveUserNotificationState(state: Boolean) {
        dataStore.edit { pref ->
            pref[DataStoreKey.IS_NOTIFICATION_ON] = state
        }
    }
    
    //..
}

 

 

📌 값 불러오기

 Preferences DataStore는 Flow<T> 데이터를 반환한다. Preferences 전체에 접근한 것이므로 map() 연산자를 통해 Key 값을 적절하게 반환할 수 있도록 처리한다.

 또한 데이터를 읽어오는 도중에 오류가 발생할 경우 IOException을 발생시키는데 Flow의 연산자인 catch()를 통해 예외 처리할 수 있다.

 

 공식 문서에서는 IOException일 때만 emptyPreferences()를 통해 빈 아이템을 반환시키고 이외는 예외를 그대로 발생시키는 것이 좋다고 추천하고 있다.

 

class SomeWhereActivity : AppcompatActivity() {
	// ..
    
        suspend fun getUserNotificationState(): Flow<Boolean> = dataStore.data
            .catch { e ->
                if (e is IOException) {
                    emit(emptyPreferences())
                } else {
                    throw e
                }
            }.map { prefs ->
                prefs[DataStoreKey.IS_NOTIFICATION_ON] ?: false
            }
}

 

📌 UI 작업

 데이터가 방출되면 SnackBar를 통해서 현재 상태를 나타내고 Action 버튼을 만들어 현재 상태와 반대되도록 설정할 수 있는 간단한 코드이다.

 

class SomeWhereActivity : AppCompatActivity() {

	//..

    private fun getUserNotificationState() {
        lifecycleScope.launch {
            getUserNotificationState().collect { state ->
                withContext(Dispatchers.Main) {
                    makeSnackBar(state)
                }
            }
        }
    }

    private fun makeSnackBar(state: Boolean) {
        Snackbar.make(binding.root, "알림이 현재 ${if (state) "ON" else "OFF"} 상태입니다.", Snackbar.LENGTH_LONG)
            .setAction(if (state) "OFF하기" else "ON하기") {
                lifecycleScope.launch {
                    saveUserNotificationState(!state)
                }
            }
            .show()
    }

}

 

 

📌 SharedPreferences에서 Migration!

 Migration하는 방법은 매우 간단하다.

 Instance를 생성할 때 preferencesDataStore 매개 변수에 produceMigrations를 이용한다.

SharedPreferencesMigration 두 번째 매개 변수에 SharedPreferences에서 사용하던 이름을 넣어주면 모든 key-value가 복사되며 기존에 존재하던 XML 형태의 데이터는 삭제된다.

 

 주의해야할 점은 데이터가 한 번만 이전되기에 DataStore로 Migration한 이후에는 더 이상 SharedPreferences의 사용은 멈춰야한다.

val Context.dataStore: DataStore<Preferences> by preferencesDataStore(
	name = DataStoreKey.DATA_STORE_NAME, 
	produceMigrations = { context -> listOf(SharedPreferencesMigration(context, "ex_shared_name")) }
)

 

---

👋 마치며

 Coroutine과 Flow를 사용하기에 해당 내용의 학습이 이루어지지 않는다면 어렵겠지만,

알고만 있다면 어렵지 않고 SharedPreferences의 단점을 상당히 보완할 수 있다고 생각한다.

 

 Dependency 추가를 할 때처럼 아직은 Stable release 상태가 아니다.

그래도 초기에 공개된 이후로 꾸준한 업데이트로 현재 RC 버전까지 올라갔기에 Migration을 고민해봐도 좋을 것 같다.

 

 Proto DataStore는 Proto Buffer의 syntax가 조금 포함되지만 이 또한 어렵지 않게 적용할 수 있다고 생각한다.

기회가 된다면 추후 포스팅으로 다루도록 하겠다.

 

 Repository를 사용하여 적용된 예시 프로젝트는 깃허브에서 확인할 수 있다. 깃허브 바로가기

 

📕 References

안드로이드 공식 문서