FirestoreのaddOnSuccessListener内でreturnする方法

Question

①のコード

private fun dbCheck(userid:String):String?{
        var dbError:String? = null
        val db = FirebaseFirestore.getInstance()
        val docRef = db.collection("Users").document(userid)
            docRef.get().addOnSuccessListener { document->
                dbError = if(document.exists()){
                    "既に利用されているIDです"
                }else {
                    null
                }
            }
        return dbError
    }

②のコード

private fun dbCheck(userid:String){
        var dbError:String? = null
        val db = FirebaseFirestore.getInstance()
        val docRef = db.collection("Users").document(userid)
            docRef.get().addOnSuccessListener { document->
                dbError = if(document.exists()){
                    "既に利用されているIDです"
                }else {
                    null
                }
                return@addOnSuccessListener dbError //ここがエラーになる
            }
    }

そこで入力されたUserIDのdocumentが存在すればエラーを返すというコードを書きました。
しかし、
➀のコードだとdbErrorの変数が更新されずにnullのまま返されてしまいます
➁のコードだとreturn文でエラーが出てしまいます

どこを改善すればエラーを返すことができるのでしょうか？

Answer 1

addOnSuccessListener の時点では「OnSuccess 時の処理を登録する【だけ】」です.
登録するだけで, 実際に「OnSuccess と呼ばれる状況」になるまでは何もしないのです.
逆に, OnSuccess となったときには登録した処理が実行されます.

当然, 登録した時点ではエラーも何も起きようがありません.
その時点では何も処理していないのですから.

解決の選択肢としてはいくつか考えられます:

1. dbCheck() を実装しているオブジェクトに OnSuccessListener インタフェースを実装し, addOnSuccessListener(this) する. (OnSuccess 時に onSuccess メソッドが呼び出されるようになる)
2. dbCheck() の引数として完了時の処理を渡してもらうよう (Kotlin なら例えば onChecked: (String) -> Unit など) にし, addOnSuccessListener {} に登録した処理からそれを呼ぶ.
3. dbCheck() は docRef.get().await() し, OnSuccess になるまで完了しないよう待機する. (メインスレッドを止めないよう注意. コルーチンなどを併用するかも)

Comments

[kkpps]

2番の方法を試しましたがうまくいきません

//呼び出し側
fun userid(){
　　var error:String? = null
　　dbCheck(userid,{error="既に利用されているIDです"},{error=null})
}

private fun dbCheck(userid:String,errorLog:()-> Unit, successLog:()->Unit) {
　　val db = FirebaseFirestore.getInstance()
　　val docRef = db.collection("Users").document(userid)
　　docRef.get().addOnSuccessListener { document->
　　　if(document.exists()){
　　　　errorLog()
　　　}else{
　　　 　successLog()
　　　 }
　　 }
}

このコードで試してみたのですが、addOnSuccessListener内のerrorLog()とsuccessLog()が動作していないです。

どこに問題点がありますか？

[kagilinn]

`error` に代入した値はどのように使われていますか？

[kkpps]

fun userid():String?{
　　var error:String? = null
　　dbCheck(userid,{error="既に利用されているIDです"},{error=null})
return error
}

でuseridを呼び出している関数にerrorを戻り値として渡しています

[kagilinn]

その時点でもまだ

```
{error="既に利用されているIDです"},{error=null}
```

のどちらも呼び出されませんよ.

`dbCheck()` 自体, 処理を登録することしかやっていないのですから.

[kkpps]

登録した処理を実行するには実際どのようなコードになるのでしょうか？

[kagilinn]

まず「error を戻してもらう」発想から離れましょう.
続きの処理は error を受け取った側の処理で行うことが出来るはずです.

[kkpps]

それだとaddOnSuccessListener内の処理は実行されていなくて、error内に値を代入するのは別の箇所で処理しないといけないという認識でよろしいですか？

[kagilinn]

「error内に値を代入する」必要があるのかどうかも, そのコードからは読み取れません.
ただ, 別の箇所で処理する必要はありません.
わざわざ error に入れずに, そのままブロック内で続きの処理をしてはどうでしょうか.

[kagilinn]

結局, コードを出そうにも error を最終的にどうしたいのかが判らないので書けないんです.
・dbCheck() から呼び出し元の userid() に error を戻そうとしていた.
・userid() を呼び出している関数に error を戻り値として渡そうとしている.

...で, その先はどうなんでしょうか.
戻した先が自分が手を入れられないフレームワークとかだったら仕方ありませんが,
最終的にはログに出力するなり表示するなりするはずです.