[Android] DataStore

🙄 구글 로그인 구현 후의 고찰

구글 로그인을 구현한 후, 사용자의 이메일을 저장하기 위해 어떤 방식을 써야 할까 고민했다. 처음엔 Bundle에 이메일 값을 넣어 프래그먼트 간 이동시에 전달해야겠다는 생각을 했었다. 그런데 프래그먼트나 액티비티가 한두개도 아니고, 하나의 프래그먼트에서만 사용할 것도 아니고 여러군데서 써야 하기 때문에 너무 비효율적일 것 같았다. 어차피 이메일만 저장하면 되니까, 복잡한 것 필요 없이 SharedPreferences나 DataStore을 사용하면 되겠다는 판단이 들었고, SharedPreferences는 나온지 좀 오래된 애고 DataStore가 안정성 면에서 훨 좋기 때문에 이참에 DataStore를 제대로 써보기로 했다.

✅ DataStore

DataStore는 키-값 쌍 형식으로 데이터를 로컬에 저장할 수 있는 Jetpack의 데이터 저장소 솔루션이다. Coroutine 및 Flow를 사용해서 비동기적으로 데이터를 저장하며, SharedPreferences와 달리 UI 스레드 호출 및 런타임 에러로부터 안전하다는 장점이 있다. DataStore는 보통 간단한 문자열과 같은 소규모 데이터를 저장하기 위해 사용한다(복잡하거나 대규모의 데이터는 Room 사용을 권장한다). DataStore는 2가지로 구분할 수 있다.

✔ Preferences DataStore vs Proto DataStore

Preferences DataStore는 키를 사용해서 데이터를 저장하고 읽어온다. 스키마를 정의할 필요는 없지만 Proto DataStore와 달리 안전성을 제공하지 않는다. Proto DataStore는 프로토콜 버퍼를 사용하여 스키마를 정의해야 하며, 안전성을 제공한다. 더 안전하다는 면에서 Proto DataStore를 사용하는 것이 더 낫겠지만, 빠르게 결과를 보고 싶었던 나는 이전에 찍먹해봤던 Preferences DataStore를 사용하기로 했다.

1. 사용 준비

https://kangmin1012.tistory.com/47 님의 글을 참고해서 원활하게 수행할 수 있었다 👍

DataStore를 사용하기 전, build.gradle(module)에 preferences datastore에 대한 종속성을 추가한다.

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

2. 코드 작성

먼저 나는 사용자의 이메일과 어떤 방식으로 로그인했는지(일반 로그인인지 SNS 계정을 이용한 로그인인지) 여부에 대해 저장할 변수가 필요했다. 따라서 DataStore를 사용하기 위한 클래스를 생성하고, 각 값을 저장하고 읽기 위한 key 변수에 대해 선언했다. key의 type은 저장하고자 하는 변수 타입에 따라 다르게 선언해준다.

class DataStoreModule(private val context : Context){

	//preferences DataStore 생성
    //DataStore를 싱글톤으로 관리하기 위해 파일 최상단에 배치, 이렇게 하면 DataStore를 하나만 생성할 수 있음
	private val Context.datastore by preferencesDataStore(name = "datastore")
    
    
    private val emailKey = stringPreferencesKey("USER_EMAIL") //사용자의 이메일
    private val loginTypeKey = intPreferencesKey("LOGIN_TYPE") //로그인 여부
    
}

값을 읽어오기 위해 DataStore.data를 사용한다. map()을 이용해 DataStore에 저장되어 있는 값을 미리 지정해둔 키를 통해 가져온다. 이 때 반환되는 값은 Flow이 된다.
또한 값을 읽어오는데에 실패하면 IOException이 발생할 수 있는데, catch()문을 이용해 exception이 발생했을 경우 빈 값을 전달하도록 한다.

val email : Flow<String> = context.datastore.data
	.catch{ exception ->
    	if(exception is IOException){
        	emit(emptyPreferences())
        }else{
        	throw exception
        }
     }.map{
     	it[emailKey] ?: ""
	}
     

DataStore에 값을 저장할 때는 edit()을 사용한다. DataStore에 값을 저장할 때는 반드시 비동기로 작업해야 하기 때문에, suspend를 통해 값을 작성하는 함수가 코루틴 영역에서 동작할 수 있도록 한다.

suspend fun setEmail(email : String){
	context.datastore.edit{
        it[emailKey] = email
	}
}

DataStore는 싱글톤으로 관리되어야 한다. 따라서 Application()을 상속하는 클래스를 생성하고, DataStore 클래스의 context로 AppicationContext를 넘겨준다.

class App : Application() {

    private lateinit var datastore : DataStoreModule

    companion object{
        private lateinit var app : App
        fun getInstance() : App = app
    }

    override fun onCreate() {
        super.onCreate()
        app = this
        datastore = DataStoreModule(this)
    }

    fun getDataStore() : DataStoreModule = datastore
}

액티비티나 프래그먼트에서 DataStore의 값을 가져올 때는 DataStore 클래스에서 선언한 변수에 접근하여 Flow() 객체를 반환받아 값을 읽어와야하기 때문에, 해당 작업은 CoroutineScope 내에서 실행해야 한다. 만약 내가 원하는 타이밍에 한 번만 값을 받아와서 사용하고 싶다면 first()를 호출하면 된다. 값을 저장하는 것도 마찬가지로 CoroutineScope 내에서 실행하면 된다.

//값 읽어오기
CoroutineScope(Dispatchers.Main).launch{
	val loginType = App.getInstance().getDataStore().email.first()
}

//값 저장하기
CoroutineScope(Dispatchers.Main).launch {
	App.getInstance().getDataStore().setEmail("user-email")
}

References

https://developer.android.com/topic/libraries/architecture/datastore?hl=ko
https://kangmin1012.tistory.com/47