【kotlin】【android studio】Realmをsuspend関数内で利用するやり方がわからない

Question

#実現したいこと
kotlinでandroid開発をしています。MVPアーキテクチャでrealmを利用しようと思っているのですが、coroutine（suspend関数）で利用するやり方がわからず、開発が難航しています。
テストをやってみましたがエラー解決できません。

エラーの解決方法と参考になるサンプルプログラム等あれば教えていただきたいです。

#発生している問題

java.lang.IllegalStateException: Callback cannot be delivered on current thread. Realm cannot be automatically updated on a thread without a looper.
at io.realm.internal.android.AndroidCapabilities.checkCanDeliverNotification(AndroidCapabilities.java:54)
at io.realm.Realm.executeTransactionAsync(Realm.java:1579)
at com.example.gotcha2.data.source.local.UserLocalDataSource$saveUserPage$2.invokeSuspend(UserLocalDataSource.kt:48)
at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:56)
at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:571)
at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:738)
at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:678)
at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:665)

#コード

class UserLocalDataSource: UserDataSource {

    override suspend fun getUserPage(): Result<User> = withContext(Dispatchers.IO){

        val realm = Realm.getDefaultInstance()

        val userLocalObject = realm.where(UserLocalObject::class.java).equalTo("uid", uid).findFirst()

        realm.close()
        if( userLocalObject == null){
            Result.Error(LocalDataNotFoundException())
        }else{
            val userModel = convertUserLocalToModel(userLocalObject)
            Result.Success(userModel)
        }


    }

    override suspend fun getUserProfile(): Result<UserProfile> {
        TODO("Not yet implemented")
    }

    override suspend fun saveUserPage(user: User): Result<User> = withContext(Dispatchers.IO){
        val realm = Realm.getDefaultInstance()

        var exception: Throwable? = null
        var userLocalObject = convertUserModelToLocal(user)
        var target = realm.where(UserLocalObject::class.java).equalTo("uid", user.uid).findFirst()
        realm.executeTransactionAsync({
            target = userLocalObject
        },{

        },{
            exception = it
        })

        realm.close()

        if(exception == null){
            Result.Success(user)
        }else{
            Result.Error(exception as Throwable)
        }
    }
.
.
.
省略

テストコード

@RunWith(AndroidJUnit4::class)
class UserLocalDataSourceTest
{
    private val UID = "uid"
    var name: String = "name"
    val imageURL: String = "imageURL"
    var updateAt: Timestamp = Timestamp(1,1)
    val lastLogin: Timestamp = Timestamp(1,1)
    var permission: String = "public"
    var purpose: String? = null
    var budget: Int? = null

    var USER = User(UID,name,imageURL,updateAt,lastLogin,permission,purpose,budget)

    private lateinit var userLocalDataSource: UserLocalDataSource

//    @get:Rule val instantTaskExecutorRule = InstantTaskExecutorRule()

    @Before
    fun setup(){
        uid = UID
//        realm = Realm.getDefaultInstance()

        UserLocalDataSource.clearInstance()
        userLocalDataSource = UserLocalDataSource.getInstance()
    }

    @After
    fun cleanup(){
        UserLocalDataSource.clearInstance()
//        realm.deleteAll()
//        realm.close()
    }

    @Test
    fun saveRetrieveUser() = runBlockingSilent {
//        val realmInstance = realm
        userLocalDataSource.saveUserPage(USER)
        val result = userLocalDataSource.getUserPage()
        assertEquals(result, Result.Success(USER))


        verify(userLocalDataSource).saveUserPage(ArgumentMatchers.eq(USER))
        verify(userLocalDataSource).getUserPage()
    }


}

Answer 1

エラーによれば、executeTransactionAsyncはLooperを持たないスレッド上では呼び出せないということなので、メインスレッドもしくは自分で用意したLooperを持つスレッド（HandlerThread）からこのメソッドを呼ぶ必要があります。coroutinesのAPIを眺めた感じだとHandler::asCoroutineDispatcherというのが使えそうです。
もしくは、executeTransationの方を使うかですね。バックグラウンドスレッドからの呼び出しがしたいならこちらの方が適していそうです。

また、Realmのインスタンスは複数スレッド間で共有してはいけないので、その点にも注意してください。ドキュメント

---

下記はメインスレッドから呼び出すようにする修正例です。
実際に試したわけではないのであくまで参考程度にどうぞ。

override suspend fun saveUserPage(user: User): Result<User> = withContext(Dispatchers.Main){
    val realm = Realm.getDefaultInstance()      
    var userLocalObject = convertUserModelToLocal(user)
    var target = realm.where(UserLocalObject::class.java).equalTo("uid", user.uid).findFirst()
            
    try {
        // コールバック形式のイベントを待機する
        suspendCancellableCoroutine<Unit> { cont ->
            val task = realm.executeTransactionAsync({
                target = userLocalObject
            }, {
                cont.resume(Unit)
            }, {
                cont.resumeWithException(it)
            })
            // コルーチンがキャンセルされたらRealmのタスクもキャンセル
            cont.invokeOnCancellation {
                task.cancel()
            }
        }

        Result.Success(user)
    } catch (exception: Throwable) {
        Result.Error(exception)
    } finally {
        realm.close()
    }
}

Comments

[kotatsu828]

返事が遅れてすみません。
ご丁寧な解説ありがとうございます。
executeTransactionAsync()を使用するのをやめて
executeTransaction()を利用してsusupend関数ごとにrealmのインスタンスを生成破棄することで実装できました。
ありがとうございました。