FirebaseのaddOnSuccessListenerの処理タイミングについての質問

Question

【やりたいこと】
FirebaseのMLkitの翻訳機能を関数にしたい

【わからないこと】
addOnSuccessListenerやaddOnFailureListenerの処理が実行されてからreturnで関数を終わらせたいのですが，実際にはそれらが実行される前にreturnで関数が終わってしまいます．
改善するためにはどう記述すべきなのでしょうか？

fun firebaseTranslator(word: String): Pair<String, String> {

    var isModelDownloded = false
    var finished = false

    var translatedWord = ""
    var errorMessage = ""

    // 翻訳の設定
    val options = FirebaseTranslatorOptions.Builder()
        .setSourceLanguage(FirebaseTranslateLanguage.EN)
        .setTargetLanguage(FirebaseTranslateLanguage.JA)
        .build()

    val englishJapaneseTranslator = FirebaseNaturalLanguage.getInstance().getTranslator(options)

    englishJapaneseTranslator.downloadModelIfNeeded()
        .addOnSuccessListener {
            isModelDownloded = true
            englishJapaneseTranslator.translate(word)
                .addOnSuccessListener {
                    translatedWord = it
                }
                .addOnFailureListener {
                    errorMessage = "翻訳に失敗しました"
                }
        }
        .addOnFailureListener {
            errorMessage = "翻訳モデルのダウンロードに失敗しました"
        }

return Pair(translatedWord, errorMessage)
}

Comments

[退会済みユーザー]

addOnSuccessListener, addOnFailureListener どちらにもreturn文が書かれていませんが、どういう意味でしょう？

[Hacchi_]

その中にreturnを書くとエラーになるので書けません

[退会済みユーザー]

もしかしてaddOnSuccessListenerで受け取った内容を、firebaseTranslator()の返り値として返したいって言ってます？
それであれば、非同期なのでその方法では無理ですとしか。

[Hacchi_]

そうです，やりたいことはそれです
難しいのですね・・・
了解いたしました

Answer 1

Firebaseは基本的にネットを介して処理をします。ネットを介した処理は時間がかかるため、非同期処理ということをしないとサーバーから返事があるまでアプリはフリーズ状態になります。
つまり、firebaseTranslator関数が値を返すタイミングと翻訳が完了するタイミングは異なります。そのため、関数から直接値を返すことは出来ません。
ですので、以下のように「完了したら実行する処理」として書く必要があります。

fun firebaseTranslator(word: String, listener: (result: String?, errorMessage: String? = null) -> Unit) {

    // 翻訳の設定
    val options = FirebaseTranslatorOptions.Builder()
        .setSourceLanguage(FirebaseTranslateLanguage.EN)
        .setTargetLanguage(FirebaseTranslateLanguage.JA)
        .build()

    val englishJapaneseTranslator = FirebaseNaturalLanguage.getInstance().getTranslator(options)

    englishJapaneseTranslator.downloadModelIfNeeded()
        .addOnSuccessListener {
            englishJapaneseTranslator.translate(word)
                .addOnSuccessListener {
                    listener(it)
                }
                .addOnFailureListener {
                    listener(null, "翻訳に失敗しました")
                }
        }
        .addOnFailureListener {
            listener(null, "翻訳モデルのダウンロードに失敗しました")
        }

}

使用方法

firebaseTranslator("Apple") { result, errorMessage ->
  // 完了後の処理。翻訳結果を必要とする処理を書く。
  // result変数に結果、errorMessage変数にエラーメッセージが格納。エラーがない場合errorMessageはnull。
}

Comments

[Hacchi_]

なるほど，そうなのですね！
ご丁寧に回答頂き，ありがとうございます

Answer 2

Kotlinを使っているのであれば、coroutinesを利用するという手もあります。
coroutinesを使えば非同期処理のチェーンを同期処理的な順序で記述することができます。といっても、非同期処理がどういうものなのかの理解は必須ですのでまずはそちらを勉強してからご利用ください。

以下は org.jetbrains.kotlinx:kotlinx-coroutines-play-services を使った例です。

suspend fun firebaseTranslator(word: String): String {
    val options = FirebaseTranslatorOptions.Builder()
        .setSourceLanguage(FirebaseTranslateLanguage.EN)
        .setTargetLanguage(FirebaseTranslateLanguage.JA)
        .build()

    val englishJapaneseTranslator = FirebaseNaturalLanguage
        .getInstance()
        .getTranslator(options)

    return englishJapaneseTranslator
        .downloadModelIfNeeded()
        .onSuccessTask { englishJapaneseTranslator.translate(word) } // Taskのチェーン
        .await()
}

• 呼び出す側

try {
    val translated: String = firebaseTranslator(word)
    // 翻訳結果を使って任意の処理...
} catch (e: Exception) {
    // OnFailureListenerに渡されるエラーはここでcatchできる
}