안녕 DataStore, 안녕SharedPreferences👋 - Android📱 - Part 1: Preference DataStore

Ashton Yoon·2021년 4월 17일

이 글은 Hello DataStore, Bye SharedPreferences👋 — Android📱 — Part 1: Preference DataStore을 번역한 포스트.

DataStore?

Jetpack DataStore는 데이터를 저장하기 위한 수단이다.
이를 통해 SharedPreferences처럼 Key-Value Pair나 Protocol Buffer를 이용한 Typed Objects를 저장할 수 있다. (다음 포스트에서 다룰 예정)
DataStore는 Kotlin, Coroutine 및 Flow를 사용하여 일관성과 트랜잭션을 지원함으로서 데이터를 비동기적으로 저장한다.
간단히 말해서 DataStore는 SharedPreferences를 대체하는 새로운 데이터 저장수단이다.

DataStore를 사용하는 이유

가장 좋아하는 이유로는 Kotlin, Coroutine 및 Flow를 사용하기 때문이다.
SharedPreferences는 동기 API를 제공하는 것과 MAIN 스레드로부터 안전하지 않은 단점이 있다 반면 DataStore는 내부적으로 Dispatchers.IO를 사용하기 때문에 UI 스레드에서 사용하기에 안전하다.
런타임 에러로부터 안전하다.
SharedPreference에서 DataStore로 마이그레이션할 수 있는 방법도 제공해준다.
Protocol Buffer를 사용하여 Type safety 한 코드를 작성할 수 있다

그리고 DataStore는...

데이터를 저장하기 위해 두 가지 타입 구현을 제공하는데

Preference DataStore : 데이터를 저장하기 위해 Key-Value Pair을 사용한다. 그러나 이건 Type safety 하지 못함
Proto DataStore : 데이터를 Protocol Buffer를 사용하여 커스텀 타입의 형태로 저장한다 (다음 포스트에서 다룰 예정)

DataStore에 대한 소개는 이정도면 충분한 것 같고 이제 코드를 작성해보자

코딩 시작

DataStore에 관한 예제는 이 Repository에서 클론하거나 참조할 수 있다.

사용자의 UI 모드를 (Ex : 🌞 Light Mode 또는 🌑 Dark Mode) 저장하는 샘플 Android 애플리케이션을 개발할 것이다.

dependencies {
    // Preferences DataStore
    implementation "androidx.datastore:datastore-preferences:1.0.0-alpha08"
}

먼저 앱 모듈의 build.gradle에 Gradle 종속성을 추가한다.

First of all, let’s add a Gradle dependency in build.gradle of your app module. Currently 1.0.0-alpha01 is the latest release. You can keep an eye here to get info about the latest version.

원글이 작성된 시점에는 1.0.0-alpha01이 최신 버전이였지만 현재는 1.0.0-alpha08이 최신버전이다. 가장 최신버전은 여기서 확인할 수 있다

DataStore 구현하기

Dark나 Light같은 UI 모드를 위한 enum class를 아래처럼 생성해준다

enum class UiMode {
    LIGHT, DARK
}

그 다음에 SettingsManager라는 클래스를 만들어줄건데 이 클래스는 앱에서 사용자가 설정한 값을 관리해주는 역할

class SettingsManager(context: Context) {

    private val dataStore = context.createDataStore(name = "settings_pref")
    ...

이 클래스는 dataStore 필드를 DataStore를 이용해 settings_pref 라는 이름으로 초기화된다.

createDataStore()는 context의 익스텐션 메서드

이제 UI 모드를 키를 이용하여 (SharedPreference처럼) 설정할건데 키는 아래처럼 생성되어있다.

아래 코드를 SettingsManager 클래스 내부에 작성해야함

companion object {
    val IS_DARK_MODE = preferencesKey<Boolean>("dark_mode")
}

👆 이것이 생성된 키인 IS_DARK_MODE고 이건 boolean 값으로 저장되는데 false면 Light mode, true면 Dark mode. 이런 식으로 사용한다.

이렇게 사용하는 이유는 DataStore는 스키마를 미리 정의하지 않았기 때문이고

DataStore<Preferences>에 저장해야하는 각 값에 대한 키를 정의하려면 반드시 Preferences.preferencesKey()를 사용해야한다.

이제 UI/Acitivty에서 UI 모드를 설정하는 메서드를 만들차례인데

참고 : Preferences DataStore는 DataStore의 값을 transactional하게 업데이트하는 edit() 메서드를 제공한다

suspend fun setUiMode(uiMode: UiMode) {
    dataStore.edit { preferences ->
        preferences[IS_DARK_MODE] = when (uiMode) {
            UiMode.LIGHT -> false
            UiMode.DARK -> true
        }
    }
}

이제 설정을 가져와야하는데 DataStore는 Flow를 이용해서 설정 값을 드러내주는 data라는 프로퍼티를 제공한다.

Flow를 활용할 때다. 아래 코드를 참조 👇

val uiModeFlow: Flow<UiMode> = dataStore.data
    .catch {
        if (it is IOException) {
            it.printStackTrace()
            emit(emptyPreferences())
        } else {
            throw it
        }
    }
    .map { preference ->
        val isDarkMode = preference[IS_DARK_MODE] ?: false

        when (isDarkMode) {
            true -> UiMode.DARK
            false -> UiMode.LIGHT
        }
    }

👆 Flow를 사용한 것을 볼 수 있다. uiModeFlow 필드는 설정이 편집/업데이트 될 때마다 값을 내 보냄. 우리는 데이터 저장소에 boolean을 저장한다.

map {}을 사용하여 boolean 값을 Ui 모드, 즉 UiMode.LIGHT 또는 UiMode.DARK에 매핑한다.

참고 : DataStore는 값 읽기에 실패하면 IOException을 발생시킴. 그래서 우리는 emptyPreferences ()를 방출함으로써 예외를 처리했다.

이것이 DataStore 설정에 관한 모든 것이다 😃, 이제 UI를 디자인 해보면

액티비티 설정

액티비티에는 UI 모드를 기반으로 한 이미지 리소스, 즉 🌞 및 🌘이있는 ImageButton 만 있고

class MainActivity : AppCompatActivity() {

    private lateinit var settingsManager: SettingsManager
    private var isDarkMode = true

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        settingsManager = SettingsManager(applicationContext)

        observeUiPreferences()
        initViews()
    }

initViews()에서는 ImageButton을 클릭할 때 UI 모드를 변경해주는 처리를 설정해준다.

private fun initViews() {
    imageButton.setOnClickListener {
        lifecycleScope.launch {
            when (isDarkMode) {
                true -> settingsManager.setUiMode(UiMode.LIGHT)
                false -> settingsManager.setUiMode(UiMode.DARK)
            }
        }
    }
}

observeUiPreferences()에서는 설정이 업데이트 될 때마다 값을 내보내는 Flow🌊 인 SettingsManager에 존재하는 uiModeFlow 필드를 사용하여 UI 모드 기본 설정을 observe한다.

private fun observeUiPreferences() {
    settingsManager.uiModeFlow.asLiveData().observe(this) { uiMode ->
        when (uiMode) {
            UiMode.LIGHT -> onLightMode()
            UiMode.DARK -> onDarkMode()
        }
    }
}