Datastore 사용하기(Preferences DataStore)

DataStore는 코루틴과 flow를 사용하는 SharedPreferences의 개선판이라고 할 수 있다. SharedPreferences를 사용할 때는 보통 설정값과 같은 단순 데이터 셋인 key-value로 묶이는 값들을 저장하는데, primitive type만 저장할 수 있다는 단점과, String으로 만든 JSON을 저장한다고 쳐도 불시에 발생하는 런타임에러를 피할 수 없었다.

또한 생성되는 파일이 XML파일이고 실제 파일작업을 하기 때문에 UI 쓰레드에서 돌려버리면 ANR이 발생하거나 런타임에러가 발생할 가능성이 농후하다. 비동기 기능도 유연하지않다. DB수준의 데이터를 저장해야 한다면 당연히 Room을 사용해야한다.

 

DataStore를 사용하게 된 계기는 서버에서 받아오는 access token을 저장해놔야 api 요청할 때 헤더에 토큰을 넣어서 요청하는데, SharedPreferences는 파일이 남아있어 안전하지 않아 DataStore를 선택했다.

 

이 글에서 SharedPreference -> DataStore 마이그레이션은 다루지 않는다.

DataStore

DataStore는 Preferences DataStore와 Proto DataStore로 나뉜다.

전자는 기존의 SharedPreferences와 거의 동일한 기능, 사용법을 갖고, 후자는 커스텀 데이터타입을 Protocol Buffer를 통해 저장한다. 커스텀 데이터 타입을 사용하기 때문에 Type-Safety를 보장하기 위한 스키마를 미리 지정해야된다는 귀찮음이 있긴하다.

설정법과 같은 건 공식문서를 따라가면 알 수 있는 부분이기 때문에 따로 다루진 않겠다. 또한 이번 프로젝트에서는 Preferences DataStore가 사용됐기 때문에 이걸 다루겠다.

Preferences DataStore

DataStore 클래스와 Preferences클래스를 사용하여 구현한다. Preferences클래스는 Map형식으로 DataStore를 사용하기 위한 타입이다.

싱글톤으로 인스턴스 만들기

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

 

이 과정이 제일 중요하다. 최상위 프로퍼티로 data store인스턴스를 호출해서 싱글톤으로 만드는 작업인데, 싱글톤으로 인스턴스를 만들지 않는다면 아래와 같은 에러메시지를 볼 수 있다.

You should either maintain your DataStore as a singleton or confirm that there is no two DataStore’s active on the same file (by confirming that the scope is cancelled)

동일한 이름을 갖는 datastore인스턴스가 중복으로 생성되어 버린 대참사다.

읽고 쓰기(멀티모듈에서)

쓸 때는 코루틴에서, 읽을 때는 flow로 작동한다. 여기서는 샘플코드 말고 실제로 작업했던 코드를 가져와봤다.

멀티모듈을 사용 중이고 data layer에 작성된 코드다. 전체 코드 먼저 올려놓겠다. 리프레시 토큰, 토큰 재발급 부분도 있지만 편의를 위해서 Access Token부분만 가져왔다.

@Singleton
val Context.tokenDataStore by preferencesDataStore("tokens")

class TokenRepoImpl @Inject constructor(
    private val api: TokenApi,
    @ApplicationContext private val context: Context
): TokenRepo {

    private object PreferenceKeys {
        val ACCESS_TOKEN = stringPreferencesKey("access_token")
    }

    override suspend fun getAccessToken(): String {
        val userAccessToken: Flow<String?> = context.tokenDataStore.data.map {
            it[ACCESS_TOKEN]
        }
        return userAccessToken.first().toString()
    }
    override suspend fun setAccessToken(accessToken: String) {
        context.tokenDataStore.edit {prefs ->
            prefs[ACCESS_TOKEN] = accessToken
        }
    }
}

 

최상위 프로퍼티로 인스턴스를 생성해 싱글톤으로 만들어준다.

@Singleton
val Context.tokenDataStore by preferencesDataStore("tokens")

 

여기서 preferencesDataStore의 파라미터로 들어가는 String값은 일종의 디렉터리다. 여기서는 tokens인데, 앞으로 tokenDataStore로 접근하는 key-value 쌍은 모두 tokens 밑에 생성된다.

private object PreferenceKeys {
        val ACCESS_TOKEN = stringPreferencesKey("access_token")
    }

 

key-value쌍으로 들어갈 값의 Key를 담는 곳이다. 그냥 “access_token”이라고 직접 값을 넣어도 되지만 가독성을 높이기 위해 object로 묶어서 만들어 줬다.

지원되는 PreferencesKey 유형은 여기서 확인할 수 있다.

override suspend fun setAccessToken(accessToken: String) {
        context.tokenDataStore.edit {prefs ->
            prefs[ACCESS_TOKEN] = accessToken
        }
    }

 

datastore에 쓰는 부분이다. SharedPreferences와 유사한 모습인데, edit 메서드는 데이터를 트랜잭션 방식으로 업데이트 한다. 람다로 묶인 부분은 단일 트랜잭션으로 취급된다. suspend fun으로 선언되어 있기 때문에 반드시 코루틴에서 호출해야한다.

override suspend fun getAccessToken(): String {
        val userAccessToken: Flow<String?> = context.tokenDataStore.data.map {
            it[ACCESS_TOKEN]
        }
        return userAccessToken.first().toString()
    }

 

Flow를 통해 값을 읽는 코드다. first()는 Flow의 첫번째 값을 collect하는 메서드인데, 위 코드에서는 값이 하나기 때문에 first로 충분하다.

HTTP통신 헤더에 토큰 값을 넣을 때는 비동기로 처리할 때 값 보장이 안될 수 있어서 runBlocking을 사용했다.

참조:

https://developer.android.com/jetpack/androidx/releases/datastore?authuser=1&hl=ko#:~:text=kotlin%20%ED%8C%8C%EC%9D%BC%EC%9D%98%20%EC%B5%9C%EC%83%81%EC%9C%84%20%EC%88%98%EC%A4%80%EC%97%90%20%EB%B0%B0%EC%B9%98%ED%95%98%EB%A9%B4%20%EC%9D%B4%20%EC%9D%B8%EC%8A%A4%ED%84%B4%EC%8A%A4%EA%B0%80%20%ED%95%98%EB%82%98%EB%A7%8C%20%EC%83%9D%EA%B9%81%EB%8B%88%EB%8B%A4.

https://medium.com/androiddevelopers/introduction-to-jetpack-datastore-3dc8d74139e7

https://developer.android.com/topic/libraries/architecture/datastore?authuser=1&hl=ko

"댓글, 공감 버튼 한 번씩 누르고 가주시면 큰 힘이 됩니다"