voidメソッドの中で非同期で取得する値を待ちたい

Question

現在Unityでゲームを作っており、Firebaseを使ってデータの管理をしようと考えています。
実際にデータの登録はできる状態で、取得するところで詰まっています。

登録したデータを呼び出すのに、以下のコードを使用しています。

あるタイミングでGetValue()を実行し、非同期でGetIntOfInformationを呼び出し、代入しています。

    int i = 0;
    void GetValue(string path)
    {
        i = GetIntOfInformation(path);
        Debug.Log(i);
    }
    
    public int GetIntOfInformation(string path)
    {
        int num = 0;
        FirebaseDatabase.DefaultInstance
         .Child("Information")
         .Child(path)
         .GetValueAsync().ContinueWith(task =>
         {
             if (task.IsFaulted)
             {
                 Debug.Log("Faulted");
             }
             else if (task.IsCompleted)
             {
                 snapshot = task.Result;
                 num = int.Parse(snapshot.ToString());
             }
         });

        return num;
    }

しかしこのやり方だと、非同期で値をサーバーから取得している間にGetValueの流れは終わってしまい、結果0のままです。

実際にコード中の**num = int.Perse(snapshot.ToString())**の下にデバッグを入れるとサーバーに保存されている数値が表示されるので間違ってはいないと思います。

**GetValue()**の流れを、numに値が入って戻り値となるまで止めることはできるのでしょうか。

##追記

**num = int.Perse(snapshot.ToString())の下とかにGotValue(num)**なんて付けて、

    void GotValue(int i)
    {
        Debug.Log(i);
    }

こんな風にしたら楽なんですけど、取得したい値のキーはこれだけじゃなくて、汎用性がなくなっちゃうので、非同期処理を待つようなことはできないか知りたいです。

##追記2

####例外 Input string was not in a correct format. が発生する件について

    void Start()
    {
        Invoke("GetVal", 5);
    }

    private async void GetVal()
    {
        int getScore = await FirebaseController.GetIntOfInformation("Score");
        Debug.Log("Score"); //ここでスコアを取得したい
    }

    public async Task<int> GetIntOfInformation(string name)
    {
        try
        {
            var snapshot = await FirebaseDatabase.DefaultInstance
             .GetReference("USERS")
             .Child(id) //ユーザー識別(FirebaseAuthment)で取得したユーザーid
             .Child("Information")
             .Child(name)
             .GetValueAsync().ConfigureAwait(false);

            return int.Parse(snapshot.ToString());
        }
        catch (Exception exception)
        {
            Debug.LogError(exception);
            return 0;
        }

    }

このコードで**Debug.LogError(exception);**が常に呼び出されてしまいます。
Firebaseコンソール上では __USERS/"ユーザーid"/Information/Score__に値が入っています。

ちなみに、例外処理が起きるということは戻る数値も正しくないのでエラーにしちゃったほうがいいですよね？
（適当な数字を戻して上書きしてしまったりするのを防ぐにはエラーにする以外あるのでしょうか。）

######エラー(例外)内容

System.FormatException: Input string was not in a correct format.

at System.Number.StringToNumber (System.String str, System.Globalization.NumberStyles options, System.Number+NumberBuffer& number, System.Globalization.NumberFormatInfo info, System.Boolean parseDecimal) [0x00057] in <567df3e0919241ba98db88bec4c6696f>:0
at System.Number.ParseInt32 (System.String s, System.Globalization.NumberStyles style, System.Globalization.NumberFormatInfo info) [0x00013] in <567df3e0919241ba98db88bec4c6696f>:0
at System.Int32.Parse (System.String s) [0x00007] in <567df3e0919241ba98db88bec4c6696f>:0
at FirebaseController+<GetIntOfInformation>d__10.MoveNext () [0x000cd] in C:\Users\users\UnityProjects\project\Assets\FirebaseController.cs:133
UnityEngine.Debug:LogError(Object)
<GetIntOfInformation>d__10:MoveNext() (at C:/Users/user/UnityProjects/TestProject/Assets/FirebaseController.cs:137)
System.Threading.Tasks.TaskCompletionSource1:SetResult(DataSnapshot) Firebase.Database.<WrapInternalDataSnapshotTask>c__AnonStorey0:<>m__0(Task1) (at Z:/tmp/tmp.hapPVC8cw6/firebase/database/client/unity/proxy/Query.cs:139)
System.Threading._ThreadPoolWaitCallback:PerformWaitCallback()

Answer 1

こんにちは。

提示のコードには一部不備があるため、推測を含みますが回答してみます。

呼び出し元から直接呼び出す対象が GetValue メソッドであることと、GetValue メソッドの処理が非同期に投げっぱなしになっていれば良いのであれば、両メソッドを非同期メソッドに直し、await を使えば良いです。
具体的には、メソッドシグネチャに async を付け、戻り値を Task にし、該当の非同期処理を await で待機するだけです。
ただ直しただけなら以下のようになります。

    int i = 0;
    async void GetValue()
    {
        i = await GetIntOfInformation(/* 何を渡す？ */);
        Debug.Log(i);
    }

    public async Task<int> GetIntOfInformation(string path/* 何にも使われていない */)
    {
        int num = 0;
        await FirebaseDatabase.DefaultInstance
         .GetReference(id) // id や name がフィールドなのか？
         .Child("Information")
         .Child(name)
         .GetValueAsync().ContinueWith(task =>
         {
             if (task.IsFaulted)
             {
                 Debug.Log("Faulted");
             }
             else if (task.IsCompleted)
             {
                 snapshot = task.Result;
                 num = int.Parse(snapshot.ToString());
             }
         });

        return num;
    }

現状のコードだと、int.Parse が失敗したときに観測されない非同期例外が発生するなどの問題があるため、読みやすさ等も考慮して真っ当な形に書き直すとしたら、こんな感じにしますね。

public async Task<int> GetIntOfInformation(string path, string name)
{
    try
    {
        var snapshot = await FirebaseDatabase.DefaultInstance
         .GetReference(path)
         .Child("Information")
         .Child(name)
         .GetValueAsync().ConfigureAwait(false);

        return int.Parse(snapshot.ToString());
    }
    catch (Exception exception)
    {
        Debug.Log("Faulted");
        // Debug.LogException(exception);
    }
}

Comments

[fiveHundred]

横やりで失礼しますが、Unityのメインスレッド内（Update()やコルーチン内など）でこれを使っても大丈夫なのでしょうか？
（これらはフレーム毎に終了もしくは中断させる必要があり、そうしないとその間フリーズしてしまいます）

[tamoto]

Unity は専門ではないので確証はありませんが、
C# の言語仕様上では、非同期メソッドは await を境に処理をぶつ切りにするものなので、今回のケースでは GetValueAsync メソッドを呼び出した瞬間に制御が呼び出し元スレッドに返されるため、呼び出し元スレッドをフレームを跨ぐほどに長く掴むことにはならないはずです。
質問のコードで結果が 0 となっているということは、マルチスレッド処理自体は Unity 上でも仕様通りに動いているものと思います。

[fiveHundred]

すいません。私が言いたいのは、「Update()内などでawaitを使っても大丈夫なのかどうか」です。
質問のコードだとawaitが無いため、非同期で処理されておりますが、awaitを使うと（私の認識では）処理が終わるまで待機することになるため、その待機中にフレームを跨いでしまうという懸念があるのですが、そのようにしても大丈夫なのでしょうか？

[tamoto]

> awaitを使うと（私の認識では）処理が終わるまで待機することになるため、

待機することにはならないので大丈夫です。
await を呼び出した箇所で、そこから先の処理の実行を待たずに Update() メソッドが終了した扱いになります。だから「非同期メソッド」なのです。
まあ、呼び出し先メソッドの実装次第では、長時間メインスレッドを潰すことも可能ではあるのですが。

今ググった程度の認識ですが、Unity はメインスレッドには SynchronizationContext を持つそうなので、await 後の処理は非同期呼び出しが完了し次第メインスレッドの空き時間にスケジュールされますね。ConfigureAwait(false) を利用することで続きの処理を完全に別コンテキストに流すこともできます。

[fiveHundred]

ご説明の内容を元に、色々試して、納得いたしました。
どうも「Update()の呼び出し後は最後の行かreturn文までたどりつかないといけない」という固定概念が有ったので、そこで勘違いしていたみたいです。
ご説明ありがとうございました。

（ただ、色々試している際に、「非同期メソッドの実行後、エディタ上で停止させると、停止したのにも関わらず続きの処理が実行される（ver:2019.2.19f1）」といったことがあったので、使う人は一応気を付けたほうがいいかもしれません）

[_Beginner]

回答ありがとうございます。
GetIntOfInformation()の引数には欲しい値のキー名を入れるつもりでしたが、間違えて"name"や"id"を入れていました。
async Task<>、試してみようと思います。

[_Beginner]

すみません。
やってみたのですがうまく呼び出されません。
voidメソッド内で
Task<int> getScore = GetIntOfInformation("score");
Debug.Log(getScore.Result.ToString());
を実行しているのですがデバッグされません。

非同期処理は今まで全くやってこなかったので理解できていません...
どうすれば呼び出せるのでしょうか。

[_Beginner]

また、tamotoさんに教えていただいた一つ目のコードを試してみると
i = await GetIntOfInformation(/* 何を渡す？ */);
の部分でUnity Editorがフリーズしてしまいます。

[fiveHundred]

そのフリーズ中に他のスクリプトは動作していますか？
（もし動作しているのであれば、GetIntOfInformation()の処理が終わってからawait以降の処理が行われるので、意図した動作…のはず）

[tamoto]

何をやってるのか書いてないので知りませんが、Task の Result にアクセスすると非同期処理にならないので、デッドロックを起こしてフリーズすることはあるかもしれません。

[_Beginner]

エディターがフリーズするのは僕が間違っていました。
GetIntOfInformation()を呼び出すメソッドはasyncにしないといけないことに気が付きませんでした。

また、try/catchの文にしたら常に
System.FormatException: Input string was not in a correct format.
と、失敗が続きます。

例えば abcde/Information/Score の整数値をとりたい場合は回答内の２つ目のコードで
path = "abcde", name = "Score"
を代入しているのですが間違えているのでしょうか。

[fiveHundred]

エラー文の発生箇所も記載してください。
それと、現状のコードがどうなっているか分からないので、記載したほうが分かりやすいと思います。

[_Beginner]

追記2に書きました。

調べてみたところこのエラー/例外は
int i2 = int.Parse("1.5");
などの時に出るものらしいのですがそれらしい型の間違いところもないような気がします。

[tamoto]

はい、それはつまり、今までも int.Parse で例外が出て動いてなかったことに気付いていなかったのが、書き換えによってようやく判明したという話ですね。
例えば "1.5" は明らかに int 型ではないので、int.Parse で読むことはできません。同様に、snapshot.ToString() の中身が何か int 型になりえない文字列だということでしょう。Log などに出力して確認してみれば良いです。

[_Beginner]

デバッグしてみたのですが、
Debug.Log(snapshot.ToString());

結果は
DataSnapshot { key = Score, value = 0 }
と、数値は整数でした。

コンソール上でこの値を変更しても正しい数値が返ってきます。

これは"{ key = Score, value = 0 }"という文字列をパーズしようとしているのでしょうか。
valueの数値だけを取得するには何を使えばいいのでしょうか。

[BluOxy]

> valueの数値だけを取得するには何を使えばいい
リファレンスを見てください。GetValue(bool useExportFormat) を使えば良さそうですよ。https://firebase.google.com/docs/reference/unity/class/firebase/database/data-snapshot
追記: AndroidではなくUnityのURLに変えました

[_Beginner]

Debug.Log(snapshot.GetValue(false).ToString())
これでうまくいきました。

ここまで教えていただいたお二人ありがとうございます。
勉強になりました。

[_Beginner]

>>BluOxyさん
ありがとうございます。
ちょうどコメント書いてて見えなかったのですが、教えていただきありがとうございます。
もっと細かくリファレンス見ようと思います。