[TIL] 🌼24/05/14🌼#DataStore #Preferences DataStore

[TIL] 🌼24/05/14🌼#DataStore #Preferences DataStore

DataStore

📌참고자료

• [Android] Why DataStore? (부제 : Good-bye SharedPreferences)
• DataStore | Android Developers
• Preferences | Android Developers
• DataStore and dependency injection

SharedPreferences의 문제점

• 비동기(Asynchronous) API 제한적으로 지원
  • read:
    • 동기 read만 지원
    • 값에 변화가 있을 때 OnSharedPreferenceChangeListener로 콜백만 받을 수 있음
  • write:
    • Editor의 commit()이 아닌 apply()를 통한 비동기 write 지원
    • 하지만, apply()도 즉시 비동기 호출 X
      -> pending 되었다가 서비스/액티비티 Start/Stop 시점에 백그라운드에서 동작
      -> 이때 실행되는 fsync() native 함수는 메인 쓰레드 블록함
      -> ANR 가능성 존재
• Runtime Exception에 취약
• UI 쓰레드(메인 쓰레드)에서 안전하지 X
  • Editor의 commit() 함수

DataStore

• DataStore?
  • new and improved data storage solution
  • Built on Kotlin coroutines and Flow
  • aimed at replacing SharedPreferences

• DataStore의 종류

  • Preferences DataStore
    • key-value 쌍 저장에 사용
  • Proto DataStore
    • custum data type 인스턴스 저장에 사용
    • protocol buffers를 사용하여 schema를 정의해야 함
    • type safety 보장됨

• DataStore를 사용할 때 지켜야할 것

  • 하나의 파일에 DataStore 인스턴스 하나 이상 생성 X
    -> 데이터 read/update시 IllegalStateException throw 됨
  • DataStore에 사용되는 generic type 반드시 immutable 해야
  • 하나의 파일에 SinglePrecessDataStore과 MultiProcessDataStore 혼용 X

Preferences DataStore

• Preferences DataStore는 DataStore 클래스와 Preferences 클래스 사용
• Preferences 클래스?
  • Preferences/MutablePreferences는 generic Map/MutableMap과 유사
  • intended for use with DataStore

Preference DataStore 생성하기

• 필요한 dependency

    dependencies {
    	// Preferences DataStore (SharedPreferences like APIs)
        implementation "androidx.datastore:datastore-preferences:1.1.1"
    }

• preferencesDataStore의 property delegate 사용
  -> DataStore<Preferences> 타입의 인스턴스 생성
• Kotlin 파일 최상위에 정의
  -> access this property throughout the rest of your application
  -> singleton으로 사용

// At the top level of your kotlin file:
val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = "settings")

Preference DataStore에서 읽어오기

• Preference DataStore는 미리 정의된 schema 사용하지 X
  -> 저장될 값과 대응되는 타입의 key type function 사용해야
• DataStore.data 프로퍼티 사용
  -> 저장된 값 Flow로 읽어와짐

// key for an int value
val EXAMPLE_COUNTER = intPreferencesKey("example_counter")
val exampleCounterFlow: Flow<Int> = context.dataStore.data
  .map { preferences ->
    preferences[EXAMPLE_COUNTER] ?: 0 // No type safety
}

Preference DataStore에 쓰기

• edit 함수 사용하여 값 update 가능

suspend fun DataStore<Preferences>.edit(
    transform: suspend (MutablePreferences) -> Unit
): Preferences

• transform 파라미터로 값 변경하는 코드 블럭 받음
  -> transform 코드 블럭은 한 개의 transition으로 취급됨
  (= atomic operation)
  -> 값이 disk에 저장된 후에야 coroutine 완료됨

suspend fun incrementCounter() {
  context.dataStore.edit { settings ->
    val currentCounterValue = settings[EXAMPLE_COUNTER] ?: 0
    settings[EXAMPLE_COUNTER] = currentCounterValue + 1
  }
}