Awaitable を使用した非同期プログラミングの概要

Awaitable クラスは待機可能なカスタムの Unity 型で、C# 非同期プログラミングモデルで async の戻り値の型として使用できます。以下を含む Unity の非同期 API のほとんどは、async と await のパターンをサポートします。

• Unity コルーチン: NextFrameAsync、WaitForSecondsAsync、EndOfFrameAsync、FixedUpdateAsync
• バックグラウンドスレッド または メインスレッド への切り替え
• AsyncOperation を継承するすべての型
• Unity Learn：イベント
• 非同期 GPU リードバック

以下のように、Awaitable クラスを await 演算子と async の戻り値の型の両方とともに独自のコードで使用できます。

async Awaitable<List<Achievement>> GetAchievementsAsync()
{
    var apiResult = await SomeMethodReturningATask(); // or any await-compatible type
    List<Achievement> achievements = JsonConvert.DeserializeObject<List<Achievement>>(apiResult);
    return achievements;
}

async Awaitable ShowAchievementsView()
{
    ShowLoadingOverlay();
    List<Achievement> achievements = await GetAchievementsAsync();
    HideLoadingOverlay();
    ShowAchivementsList(achievements);
}

Awaitable と .NET Task の比較

Awaitable は、Unity プロジェクトの非同期コードに、.NET Task に代わるより効率的な方法を提供するように設計されています。Awaitable は効率的ですが、Task と比較して重要な制限があります。

最も重要な制限は、Awaitable インスタンスが割り当てを制限するためにプールされることです。以下の例を考えてみてください。

class SomeMonoBehaviorWithAwaitable : MonoBehavior
{
    public async void Start()
    {
        while(true)
        {
            // do some work on each frame
            await Awaitable.NextFrameAsync();
        }
    }
}

この例の MonoBehavior の各インスタンスは、プーリングを行わないと、フレームごとに Awaitable オブジェクトを割り当て、ガベージコレクターのワークロード を増加させ、パフォーマンスを低下させます。これを軽減するために、Unity は待機後に Awaitable オブジェクトを内部 Awaitable プールに返します。

重要：Awaitable インスタンスのプーリングは、1 つの Awaitable インスタンスを複数回 await することは決して安全ではないことを意味します。これを行うと、例外やデッドロックなどの未定義の動作につながる可能性があります。

Awaitable と .NET ValueTask の比較

.NET ValueTask<TResult> は、Awaitable と同じ主なメリットと制限をいくつか提供します。ValueTask の推奨される一般的な使用法は、ほとんどの場合に同期的に完了すると予想される非同期ワークロードです。詳細については、Understanding the Whys, Whats, and Whens of ValueTask を参照してください。

Awaitable、Task、ValueTask の要約

以下の表は、Unity の Awaitable クラスと .NET Task および ValueTask の機能比較をまとめたものです。

Task または ValueTask よりも Awaitable を使用する場合

API の選択は非同期コードのパフォーマンスプロファイルによって異なりますが、一般的には以下のように選択します。

• Task は、複数回待機する必要がある場合や、複数のコンシューマーから同時に待機する必要がある場合の唯一の選択肢です。
• ValueTask は、ほとんどの場合に同期的に完了する高スループットの非同期コードがある場合に適しています。
• Awaitable は、以下のような場合に適しています。
  • メソッドを複数回待機する必要がなく、ほとんどが非同期的に完了する場合。
  • 非同期タスクに、メインスレッド、Update ループ、FixedUpdate ループといった Unity 固有の概念のビルトインサポートが必要な場合。

Awaitable とイテレーターベースのコルーチンの比較

Awaitable コルーチンは、通常、イテレーターベースのコルーチンよりも効率的です。特に、イテレーターが WaitForFixedUpdate などの null 以外の値を返す場合に適しています。

ただし、多くの Awaitable コルーチンを同時に実行すると、パフォーマンス上のメリットが低下します。例えば、前述のコード例のような MonoBehaviour は、while ループで Awaitable.NextFrameAsync を待機しますが、大規模なプロジェクト内のすべてのゲームオブジェクトにアタッチされると、パフォーマンスの問題が発生する可能性があります。

追加リソース

• Awaitable の完了と継続
• Awaitable のコード例リファレンス