UniTaskでStart関数で非同期処理を待機し，完了するまでUpdate関数の実行を待機する

Question

実現したいこと

UniTaskでStart関数で非同期処理を待機し，完了するまでUpdate関数の実行を待機する

発生している問題

下記該当のソースコードのように，UniTaskでStart関数内でawaitをするとStart関数が完了する前にUpdateが実行されてしまいます．
期待する動作としては，Start関数で5秒待機した後にUpdateが実行して欲しいのですが．．．
直感的にはうまくいきそうなのですが，なぜ期待通りに動作しないのでしょうか？
ご回答よろしくお願いいたします．

該当のソースコード

Update関数が直ちに呼ばれてしまう例

public class Test : MonoBehaviour
{
    async void Start()
    {
        await UniTask.Delay(5000);
    }
    void Update()
    {
        Debug.Log("start update");
    }   
}

Answer 1

Update()はあくまで毎フレーム実行する関数です。
Start()が終わって無かろうが、全く関係ありません。

awaitは単純に「待機する」ではなく、「処理を途中で中断して、他の処理を行った後に再開する」と考えたほうが分かりやすいかもしれません。

以下のようにすればいいです。

public class Test : MonoBehaviour
{
    bool isFinishStartFunc = false; // Start()が終わったかどうか

    async void Start()
    {
        await UniTask.Delay(5000);
        
        isFinishStartFunc = true;
    }
    void Update()
    {
        if (!isFinishStartFunc)
        {
            // Start()が終わっていなければ何もしない
            return;
        }
    
        Debug.Log("start update");
    }   
}

Comments

[leaf21341]

回答ありがとうございます．

> Update()はあくまで毎フレーム実行する関数です。
> Start()が終わって無かろうが、全く関係ありません。

こちらについてですが，例えばStart関数で非常に重い同期処理があった場合も，Update関数がよばれてしまうのでしょうか？
Unityのライフサイクルでは「最初のフレームのアップデート前に Start が呼び出されます。」とのことでしたので少し混乱しています．

[fiveHundred]

> こちらについてですが，例えばStart関数で非常に重い同期処理があった場合も，Update関数がよばれてしまうのでしょうか？

はい。そうです。

> Unityのライフサイクルでは「最初のフレームのアップデート前に Start が呼び出されます。」とのことでしたので少し混乱しています．

これはStart()が呼ばれるだけで、それが終了したかどうかは関係ありません。
今回の場合、以下のような処理になります。

1. Start()が呼ばれる
2. 「await UniTask.Delay(5000);」で処理が中断される
3. その間にUpdate()が呼ばれる（5秒経過するまで、呼ばれ続ける）
4. 5秒経過したら、Start()の続きが行われる

これはUniTaskではなくコルーチンでも同じです。

[tamoto]

> Start関数で非常に重い同期処理があった場合
これは本当に「同期処理」であるなら、Update に使うスレッドを Start が長時間専有する形になるので、Update の実行が Start の完了後まで遅れる挙動になるのではないでしょうか。

> Unityのライフサイクルでは……
これは Start が通常の同期メソッドである場合の話で、そもそも非同期メソッドにするというのは「メソッドの実行コンテキストを Unity のライフサイクルから外す」という指示なので、Start の実行状況に関係なく Update の回転が始まるのは、あなたがそう指示したからです。

[fiveHundred]

> これは本当に「同期処理」であるなら、Update に使うスレッドを Start が長時間専有する形になるので、Update の実行が Start の完了後まで遅れる挙動になるのではないでしょうか。

すみません、「同期処理」という単語を見落としていました。
私が言ったのは、非同期処理についてです。

「同期処理」の場合、確かにStart()は長時間専有する形になります。
そうなってしまうと、その間はUpdate()どころか、他の処理も行われなくなるので、やってはいけないことの1つです。
言い訳ですが、その前提があったので、「同期処理」であることを、そもそも初めから考えていませんでした。

> これは Start が通常の同期メソッドである場合の話で、そもそも非同期メソッドにするというのは「メソッドの実行コンテキストを Unity のライフサイクルから外す」という指示なので、Start の実行状況に関係なく Update の回転が始まるのは、あなたがそう指示したからです。

UniTaskの場合、コルーチンのように「1フレーム分待機する」などの処理も行えます。
この場合だと、「Unity のライフサイクルから外す」とは言い切れないような気もしますが、どうなのでしょうか？
（それとも、全く別の理由で「Unity のライフサイクルから外す」という言葉を使ったのでしょうか？）

[UnitySoldier]

> Unityのライフサイクルでは……
これは Start が通常の同期メソッドである場合の話で、そもそも非同期メソッドにするというのは「メソッドの実行コンテキストを Unity のライフサイクルから外す」という指示なので、Start の実行状況に関係なく Update の回転が始まるのは、あなたがそう指示したからです。

UniTaskは内部的にPlayerLoopで駆動するからライフサイクルから外れないと思うんですよねえ

https://neue.cc/2021/02/26_599.html
>>UniTaskも基本的にはPlayerLoop上で動かしているのですが、自由に任意の実行箇所を選べるように、28個のループを挿入しています
補足:UniTask.RunOnThreadPoolとか明示的にやれば完全にライフサイクルから外すことはできますし完全なPlayerLoop依存ではない
補足2: どのPlayerLoopを選ぶかも実はカスタムできる https://github.com/Cysharp/UniTask#playerloop
補足3: Await自体はネイティブのタイミングでのチェックなので確かに完全なライフサイクルとの結合ではない。

それに同じ処理をStartCorutineとか完全なGameObject駆動で実行される同じ内容の非同期処理を書いたとしても同じような結果になるので
ライフサイクル云々は関係なく、Update()とStart()はMonoBehaviorに実装されてるコールバックみたいなものなので独立して発火するからそれぞれの内部で非同期処理を入れても関係なく機能するってだけの話ですよね。　
というかUnityの非同期処理は伝統的にPlayerLoop依存の方が多い気がする....TaskとかWebGLでちゃんと動かないし...

[tamoto]

> ……、どうなのでしょうか？
失礼しました、「ライフサイクル」と言ったのは、「オブジェクトの処理が Awake->Start->(Update->Update->...)-> の順序で動く」という最初の取り決めのことを指したつもりでいて、Start やその他の関数を非同期にした場合にこれが成り立たなくなることを表現したつもりでした。
コルーチンや UniTask 含め、非同期はこのメインのフローから外れたコンテキストで動作することを言いたかったのです。

[leaf21341]

①Unityのライフサイクル....
UniTaskはPlayerLoop上で動作しているのでライフサイクルからは外れない
②Start関数で非常に重い同期処理があった場合...
（メインスレッドを長時間占有するが）ライフサイクル通り順次実行される
③UniTaskでStart関数内でawaitをするとStart関数が完了する前にUpdateが実行されてしまいます．
（非同期なStart関数はPlayerLoopによってfire-and-forgetで実行されるので）awaitしてもStart関数自体の完了をメインスレッドが待機するわけではない．

御三方の意見と，他記事を参照して以上のように理解しました．
何かおかしな点があればご指摘をいただけるとたすかります．

[leaf21341]

また，そもそもの表題についてですが
「Start関数で非同期処理をawaitし，完了するまでUpdate関数の実行を待機する方法はフラグ管理以外ではない」
というふうになると理解しました．