【Unity】UniTaskのキャンセルまとめasync/awaitを使いこなそう

こんにちは、Unityエンジニアのオオバです。

Unityをお使いのみなさまasync/await便利ですよね。
コルーチンと比べてコードがスッキリ しました。
今やUnityで非同期は UniTask一択 です。

async/await登場前の非同期処理は コルーチン でした。
もちろん今でもコルーチンは使えますし、使っている現場はあります。

あわせて読みたい記事

【Unity基礎】コルーチンの使い方と注意点まとめ徹底解説

ゲーム開発で必ず登場する処理の待機。Unityではコルーチンが提供されています。コルーチンは中断と再開が可能な関数。Unity初心者には分かりづらい機能です。本記事では初心者に分かりやすく入門レベルから実践で使えるテクニックを紹介。ぜひ読んでみてください。

しかし、コルーチンと比べて UniTaskのキャンセル処理が難しい という声をよく聞きます。

あわせて読みたい記事

【初心者向け】UniTaskとコルーチンの違いを理解しよう

初心者向けにUniTaskとコルーチンの違いを解説します。

本記事では UniTaskのキャンセル処理について初心者向けに解説 します。

UniTaskにおいてキャンセル処理は鬼門 なので気合を入れて
丁寧に説明していきますね！

【超初心者向け】UniTaskの始め方3つのポイント

→11万文字で徹底解説した「DOTweenの教科書」Unityアニメーションの超効率化ツールはこちら

UniTaskのキャンセルにはCancellationTokenを使う
UniTaskはGameObjectのOFFでは止まらない
UniTaskはCancellationTokenで停止する

CancellationTokenSourceから生まれるCancellationToken

複数のUniTaskを同時にキャンセルさせる
キャンセル処理は例外あつかい
まとめ : async/awaitを使う上でUniTaskのキャンセルは例外処理です

UniTaskのキャンセルにはCancellationTokenを使う

いつもどおり結論から解説はしますが、
いきなり CancellationToken と言われても。。。
という感じかもしれません。

詳しい解説は後ほどしますが、ここでは簡潔にまとめます。

UniTaskはGameObjectのOFFでは止まらない
UniTaskはCancellationTokenで停止する
理想は全てのUniTaskにCancellationTokenを渡すべき

UniTaskはGameObjectのOFFでは止まらない
こちらは前回解説した内容です。
そう、 GameObjectがDestroyしても
UniTaskは動き続けます。

オオバ

正しくUniTaskのキャンセルを理解していないと事故ります（ました😱）

UniTaskのキャンセル処理についての詳細を解説していきます。

UniTaskはGameObjectのOFFでは止まらない

コルーチンからUniTaskに切り替えた時、
最初につまづく点は GameObjectに
UniTaskがひも付かない点です。

💻ソースコード : UniTaskがGameObjectのOFFで停止しないサンプル

async void Start()  
{
    TestUniTask();  
    gameObject.SetActive(false);  
}

async UniTask TestUniTask()  
{
    await UniTask.Delay(1000);  
    Debug.Log("Unitask完了");  
}

UniTask実行直後にGameObjectを非アクティブにしています。
コルーチンなら止まっていたわけですが、
UniTaskは止まりません。

1秒後のログがしっかり出力されます。

つまりUniTaskとGameObjectは分離して考えましょう。

まずはここからです。

UniTaskはCancellationTokenで停止する

UniTaskのキャンセルとは、
非同期処理をするUniTaskの停止 を指します。

UniTaskを停止させるサンプルコードはこちらです。

UniTaskのキャンセルサンプル

async Start()  
{
    var cts = new CancellationTokenSource();  
    CancellationToken token = cts.token;  
    Wait5SecUniTask(token);  
    await UniTask.Delay(TimeSpan.FromSeconds(1));  
    // UniTaskのキャンセル実行  
    cts.Cancel();  
}

async UniTask Wait5SecUniTask(CancellationToken token)  
{
    await UniTask.Delay(TimeSpan.FromSeconds(5), token);  
    Debug.Log("Complete!");  
}

CancellationTokenSourceのCancelメソッドで停止します。

CancellationToken
CancellationTokenSource

登場したこの2つについて解説していきます。
ここはとても重要なところです。

CancellationTokenSourceから生まれるCancellationToken

CancellationTokenとCancellationTokenSourceは
UniTaskのキャンセルに必要な要素です。

var cts = new CancellationTokenSource();  
CancellationToken token = cts.token;

↑のとおりCancellationTokenは、
CancellationTokenSourceから生成します。

cts.Cancel();

↑UniTaskをキャンセルするときは、
CancellationTokenSourceの
Cancelメソッド を呼びます。

例えば UniTask.Delay()はキャンセルに対応しています。

await UniTask.Delay(1000, token);

第2引数にCancellationTokenを代入すれば
キャンセルすることができます。

UniTask（async/await）の世界を渡り歩くためには
CancellationToken、
CancellationTokenSourceの理解は必須です。

あいまいな状態にしておくと
思わぬエラー、メモリリークなどを引き起こします。

複数のUniTaskを同時にキャンセルさせる

CancellationTokenとCancellationTokenSourceの
理解を深めるために複数のUniTaskを
同時にキャンセルさせるサンプルを作ってみます。

複数のUniTaskを同時にキャンセルさせたい場合は、
1つのCancellationTokenSourceから作った
CancellationTokenをそれぞれのUniTaskに渡します。

複数のTaskの同時キャンセル

async void Start()  
{
    var cts = new CancellationTokenSource();  
    CancellationToken token = cts.token;  

    TestUniTask(1, token);  
    TestUniTask(2, token);  
    TestUniTask(3, token);  
    TestUniTask(4, token);  

    await UniTask.Delay(TimeSpan.FromSeconds(1));  
    // ctsに紐づくTaskがキャンセルされる  
    cts.Cancel();  
}

async UniTask TestUniTask(int id, CancellationToken token)  
{
    await UniTask.Delay(TimeSpan.FromSeconds(5), token);  
    Debug.Log($"UniTask : {id} 完了");  
}

なんとなくわかってきましたでしょうか。

オオバ

ややこしいですね。

キャンセル処理は例外あつかい

UniTaskの停止は理解できたと思います。
ではキャンセル後の分岐はどうすればよいか。

結論、try-catchを使います。

次のコードを見てみましょう。

💻ソースコード : UniTaskのキャンセル分岐サンプル

CancellationTokenSource _cts;  

async void Start()  
{
    _cts = new CancellationTokenSource();  
    try {  
        await TestUniTask(_cts.token);  
        Debug.Log("UniTask完了");  
    }
    catch (OperationCanceledException e){  
        // キャンセル時に呼ばれる例外  
        Debug.Log("Taskキャンセル時の処理");  
    }
}

// ボタンをクリックしたらCancel実行  
void OnClick() => _cts?.Cancel();