compose와 preferences datastore 이용하기

도입 배경 

프로젝트에서 세탁카드에 충전한 금액을 입력하면  앞으로 남은 세탁 횟수와 남은 잔액을 확인 할 수 있는 화면을 구현하고 있다.

이 때 각 사용자의 잔액을 로컬 db에 저장하기 위해 원래 로컬 db로서 일반적으로 알고 있던 shared prefereces를 사용하기 위해 자료를 찾아보던 중!  preferences datastore와 proto datastore이라는 데이터 저장 방법이 있다는 것과

이 방법이 shared preferences의 단점을 극복하기 위해 나왔다는 것을 알게 되었다. 

 

따라서 shared preferences를 보완한 preferences datastore을 프로젝트에 적용하기로 결정했다.

 

 

개념 이해하기

datastore은 개선된 신규 데이터 저장소 솔루션으로 우리가 알고 있는 shared preferences를 대체하는 방법이다!!

kotlin 코루틴과 Flow를 기반으로 하여 두 가지 종류가 존재하는데 첫 번째는 타입 객체를 저장하는 proto datastore이고, 두번째는 키-값 쌍을 저장하는 preferences datastore이다. 

 

사용하려는 preferences datastore은 로그인 세부 정보 저장이나 어두운 모드 설정, 글꼴 크기 등 작고 간단한 데이터 세트에 적합하다. Datastore는 온라인 식료품점 인벤토리 목록이나 학생 데이터 베이스와 같은 복잡한 데이터 세트에는 적합하지 않다. 대용량 또는 복잡한 데이터 세트를 저장해야한다면 Datastore 대신 room 사용을 권장하고 있다

 

내가 저장하고자 하는 데이터는 남은 금액으로 간단한 데이터이다. 따라서 datastore 중 preference datastore가 더 적합한 방식이라고 생각했다.

 

로직 이해하기

 

[ 로직 ]

사용자가 세탁 카드에 충전한 금액을 기록하면 화면에 남은 금액에 충전한 금액이 합해진 금액이 보여진다.

이 때 남은 금액은 사용자의 로컬에 저장되어서 앱을 끄고 다시 실행해도 남아있어야한다.

 

세탁카드에 남은 금액을 저장하기 위해 뷰모델과 preferences datastore을 이용해보았다.

 

[순서]

1. Datastore 만들기

2. PreferencesKeys 정의

3. 충전 금액에 대한 Flow 생성

4. 충전 금액 저장 

5. ViewModel에서 충전 금액 업데이트

 

1.Preferences Datastore 만들기

// Datestore 만들기
private const val PREFERENCES_NAME = "user_preferences"

// Create a DataStore instance using the preferencesDataStore delegate, with the Context as
// receiver.

val Context.dataStore : DataStore<Preferences> by preferencesDataStore(name = PREFERENCES_NAME)

 

"user_preferences" 는 인스턴스화할 preferences datastore의 이름이다. 

preferencesDataStore 위임을 사용하여  "user_preferences" 라는 이름의 DataStore 인스턴스를 만든다.

Context는 receiver 역할이라고 한다! 

 

kotlin 파일의 최상위 수준에서 DataStore 인스턴스를 한번 만들고 애플리케이션의 나머지 부분에서 이 속성을 통해 인스턴스에 액세스하는 것이 좋다고 한다. 이렇게 하면 DataStore을 싱글톤으로 유지할 수 있다.

 

DataStore 인스턴스가 여러 개 만들어질 필요가 없기 때문에 싱글톤을 사용한다

 

2. PreferencesKeys 정의

private object PreferencesKeys {
    val CHARGED_MONEY = intPreferencesKey("charged_money")
}

 

intPreferencesKey를 사용하여 "charged_money" 라는 키를 정의한다. 이 키는 데이터 스토어에서 정수값을 저장하고 검색하는데 사용된다. 

 

preferences datastore은 사전 정의된 스키마를 사용하지 않는다.

DataStore<Preferences> 인스턴스에 저장해야하는 각 값의 키를 정의하려면 거기에 맞는 키 유형 함수를 사용해야한다. 나는 남은 금액이라는 Int형 값의 키를 정의하고자 했으므로 intPreferenceKey( )를 사용하였다.

 

그 후 DataStore.data 속성을 사용하여 Flow를 사용한 적절한 저장 값을 노출한다.

 

3. 충전 금액에 대한 Flow 생성 : Preferences Datastore에서 읽기

val chargedMoneyFlow: Flow<Int> = dataStore.data
    .catch {
        exception -> if (exception is IOException) {
            emit(emptyPreferences())
    } else{
        throw exception
    }
    }
    .map { preferences ->
        preferences[PreferencesKeys.CHARGED_MONEY] ?: 0 }

 

dataStore.data 속성은 datastore에서 데이터를 비동기적으로 가저오기 위해 Flow를 제공해준다.

이 Flow를 통해 앱의 여러 부분 에서 데이터를 관찰하고 사용할 수 있다. 

 

dataStore.data는 datastore에 저장된 데이터를 Flow에 노출해준다. 

datasotre 객체는 Preferences DataStore을 나타낸다.

.data는 데이터스토어에서 데이터를 읽는 데 사용되는 속성이다.

 

* chargedMoneyFlow는 데이터 스토어에 저장된 충전 금액 값을 방출하는 Flow이다.

* .catch는 예외 처리를 위해 작성해주었고, IOException이 발생한 경우 빈 preference를 방출한다.

 

* .map은

preferece를 실제 충전 금액 값으로 반환해준다. 

Flow의 각 이벤트에 대한 변환을 수행한다. preferences는 Flow에서 받아온 Preferences 데이터이다. 

preferences[PreferencesKeys.CHARGED_MONEY] ?: 0 은 CHARGED_MONEY 키에 해당하는 값을 읽어오는데 이 때 값이 null이면 0으로 대체해준다. 

 

따라서 chargedMoneyFlow를 subscribe하면 로컬 데이터 스토어에 저장된 충전 금액을 비동기적으로 감시할 수 있다. 이 Flow는 데이터가 변경될 때마다 해당 변경사항을 적용할 수 있다. 

 

4. 충전 금액 저장하기 : Prefereces DataStore에 쓰기

private suspend fun saveChargedMoney(value: Int) {
    dataStore.edit { preferences ->
        preferences[PreferencesKeys.CHARGED_MONEY] = value
    }
}

 

Preferences Datastore은 Datastore의 데이터를 트랜잭션 방식으로 업데이트하는 edit ( ) 함수를 제공한다.

edit 함수를 통해 데이터 스토어를 수정한다. 

 

트랜잭션 방식?  

트랜잭션 방식이란 

 

여러 연산을 묶어서 일괄적으로 처리하고 이 과정에서 데이터의 일관성을 보장하는 매커니즘을 의미한다.

 

DataStore의 edit 함수의 특징 4가지 

 

1. 원자성(atomicity) : edit 함수 내에서 수행되는 모든 변경 사항은 원자적으로 처리된다. 즉 모든 변경이 성공하거나 실패하는 것을 보장한다.

예를 들어 여러 개의 key-value 쌍을 변경하더라도 모든 변경이 성공하거나 아무것도 변경되지 않는 것이다.

 

2. 데이터 불일치 방지  : edit 함수는 datastore의 데이터를 안전하게 수정하도록 해준다. 여러 스레드 또는 코루틴이 동시에 datastore을 수정하려고할 때 데이터의 일관성을 유지하도록 한다.

 

3. 롤백  : edit 함수 내에서 변경사항을 적용하는 도중에 예외가 발생하면 모든 변경사항이 롤백되어 이전 상태로 돌아간다. 이는 데이터의 일관성을 유지하고 오류 상태에서도 예측 가능한 상태로 복구할 수 있도록 한다.

 

 

Datastor<Preferences>에서 데이터를 변경될 때 사용되는 edit 함수는 아래와  같이 정의되어있다.

public suspend fun DataStore<Preferences>.edit(
    transform: suspend (MutablePreferences) -> Unit
): Preferences {
    return this.updateData {
        // It's safe to return MutablePreferences since we freeze it in
        // PreferencesDataStore.updateData()
        it.toMutablePreferences().apply { transform(this) }
    }
}

 

코드 설명 

tranform : suspend (MutablePreferences) -> Unit : 이 함수는 MutablePreferences를 매개변수로 받아들이는 람다함수이다.

MutablePreferences는 수정 가능한 형태의 Prefereces를 나타낸다. 

suspend 키워드는 이 함수가 코루틴으로 동작가능함을 의미!

 

여기서 tranform 매개변수는 필요에 따라 값을 업데이트할 수 있는 코드 블록을 허용한다. 변환 블록의 모든 코드는 단일 트랜잭션으로 취급된다.

 

this.updateData 부분은 DataStore에서 제공한느 다른 함수인 updateData를 호출한다. 이 함수는 데이터를 업데이트하고 업데이트된 데이터를 반환한다.

 

it.toMutablePreference( ).apply { transform(this) }는 updateData함수 내에서 새로운 MutablePrefereces를 만들고 이를 람다 함수 transform에 전달하여 데이터를 변경한다.

 

return this.updateData {...} 는 업데이트된 데이터를 반환한다. 이는 edit 함수를 호출한 쪽에서 업데이트된 데이터를 사용할 수 있도록 해준다.

 

정리하면

이 edit 함수는 DataStor의 데이터를 수정하기 위한 람다함수 transform을 사용하고 수정된 데이터를 반환한다. 

우리 코드 다시 보기

    private suspend fun saveChargedMoney(value:Int) {
        dataStore.edit { preferences ->
            preferences[PreferencesKeys.CHARGED_MONEY] = value  }

    }

 

우리의 코드에서는 dataStore.edit 함수의 람다 파라미터는 preferences이다. 따라서 이 preferences가 tranform 역할을 한다.

preferences는 MutablePrefereces의 인스턴스로  수정가능한 Preferences를 나타낸다.

preferences[PreferencesKeys.CHARGED_MONEY] = value 코드는 MutablePreferences를 통해 CHARGED_MONEY 키에 대한 값을 value로 변경하는 역할을 한다.

 

5. ViewModel에서 충전 금액 업데이트

var chargedMoney by mutableIntStateOf(0)
    private set

fun updateChargedMoney(input: Int) {
    viewModelScope.launch {
        chargedMoney += input
        saveChargedMoney(chargedMoney)
    }
}

 

updateChargedMoney 함수는 input 만큼 chargeMoney에 합해주어 업데이트를 해준 후 변경된 chargeMoney를 데이터 스토어에 다시 저장해준다.

 

🚨 문제 발생  : 앱이 꺼지고 다시 실행될 경우 또는 네비게이션 후 다시 충전할 경우 기존의 금액에 채운 금액만큼 더해지지 않고  0으로 초기화되어서 채운 금액만큼이 더해진다. 

 

다음 포스팅에서는 뷰모델과 위 문제를 해결한 과정을 기록해볼예정이다!