Do I need to mention the coroutine dispatcher while working with Retrofit and Room?

user_11204066 0
Viewed 1086

Recently I saw this - Most data sources already provide main-safe APIs like the suspend method calls provided by Room or Retrofit. Your repository can take advantage of these APIs when they are available.

What does this mean? Is the dispatcher under the hood Dispatcher.IO for Retrofit and Room? Or do I need to mention that explicitly, while making the request? Thank you.

withContext(Dispatchers.IO) {
    // Some retrofit call or room query
}
android-room retrofit kotlin-coroutines kotlin android
3 Answers

No you don't need to mention dispatchers for Retrofit and Room. For Room when you mark a dao function as suspend fun it is guaranteed that it will not block main thread.

You can read this article https://medium.com/androiddevelopers/room-coroutines-422b786dc4c5

from the article

Room calls the CoroutinesRoom.execute suspend function, which switches to a background dispatcher, depending on whether the database is opened and we are in a transaction or not.

user_148430750

No, you don't need to switch context when calling suspend functions of Retrofit and Room. I'm not sure if they use Dispatcher.IO under the hood, maybe they use their custom context composed of thread pools, but it is guaranteed to be called in background thread.

For example you can call suspend Dao functions in ViewModel class like the following:

viewModelScope.launch {
    val user dao.getCurrentUser()
    // Update UI using user
}

assuming getCurrentUser() is a suspend function:

suspend fun getCurrentUser(): User
user_17316260

Marking your Retrofit HTTP request methods and Room DAO query methods as suspend tells both respective libraries to do the asynchronous work for you, meaning that you don't have to explicitly change threads with Dispatchers.IO at all.

Furthermore, even when a Room DAO method isn't marked suspend, but it returns a value wrapped in an Observable such as Kotlin's Flow, or RxJava's Flowable, or Jetpack's LiveData, Room will then run those queries asynchronously for you as well. As per the documentation.

That being said, you should still launch coroutines in that case, whenever you call your async, non-blocking methods with lifecycleScope or viewModelScope depending on where you're calling them from (Activity/Fragment or ViewModel) to harness the full power of suspending functions. lifecycleScope and viewModelScope use Dispatchers.Main.immediate by default, as already stated, you will not need to change Dispatchers.

user_91335690
Related