CancellationToken.Register メソッドと using ステートメントの組み合わせ例

　CancellationToken.Register メソッドは CancellationTokenRegistration 型のオブジェクトを返し、このオブジェクトは IDisposable インターフェースを実装しています。
このため、using ステートメントを使うことで、スコープ終了時に自動的にリソースを解放することができます。

　その結果、コードの信頼性とリソース管理が向上し、よりメンテナブルで効率的なキャンセル処理が実現されます。

組み合わせるメリット

　using ステートメントと CancellationToken.Register メソッドを組み合わせることで、以下のようなメリットが得られます。

１．デリゲートの登録とスコープ内での管理

　CancellationToken.Register メソッドを使ってキャンセルが発生したときに実行するデリゲートを登録できます。
このデリゲートは、using ステートメントのスコープ内で管理されます。
スコープ外にリソースが残ることを防ぐため、登録されたデリゲートの生存時間をusing スコープ内に限定できます。

２．スコープ終了時の自動的なリソース解放

　using ステートメントを使用することで、スコープが終了するタイミングでDispose メソッドが自動的に呼び出されます。
これにより、CancellationTokenRegistration が破棄され、不要なデリゲートの登録を解除します。
スコープ終了時にリソースが確実に解放されるため、リソースリークを防止します。

３．各段階(キャンセル前、キャンセル時、キャンセル後)における適切な処理

　キャンセル前：通常通り登録されているデリゲートが実行されない。
　キャンセル時：登録されているデリゲートが確実に呼び出され、適切なキャンセル処理が行われる。
　キャンセル後：using ステートメントを抜けるとデリゲートが解除され、不要なデリゲートが残らない。

　これにより、キャンセル処理の信頼性が向上し、不要なデリゲートがオブジェクトに残らないようにすることで、メモリリークや予期しない動作を防ぐことができます。

概要

　CancellationToken.Register メソッドは、指定されたデリゲート（キャンセルされるときに実行される処理）を CancellationToken に登録します。
このメソッドは CancellationTokenRegistration 型のオブジェクトを返します。このオブジェクトは、登録を解除するための IDisposable インターフェースを実装しています。

　using ステートメントを使用して IDisposable オブジェクト（ここでは CancellationTokenRegistration）を管理すると、
using ブロックが終了したタイミングで Dispose メソッドが自動的に呼び出され、リソースが解放されます。
この場合、登録されたデリゲート（キャンセルハンドラー）は Dispose メソッドが呼び出されるときに解除されます。
つまり、using ブロックを抜けるとデリゲートが破棄され、CancellationToken のキャンセル時には呼び出されません。

サンプルコード

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;
using Cysharp.Threading.Tasks;
using DG.Tweening;
using System.Threading;
using System;
using UniRx;

public class BackPackInItem : MonoBehaviour
{
    [SerializeField]
    private Image imgIconGauge;

    public ItemData itemData;

    public float currentCoolTime;
    public float currentAccuracy;
    public float currentAttackSpeed;
    public int currentMinDamage;
    public int currentMaxDamage;
    public float currentStaminaCost;
    public float currentStaminaSpeed;

    private Tweener tweener;
    private Subject<Unit> onCancel = new Subject<Unit>();
    public IObservable<Unit> OnCancel => onCancel;


    public async UniTask Hoge(ItemData itemData, CancellationToken token, EntityType myEntityType) {
        try {
            // キャンセルされていない間
            while (!token.IsCancellationRequested) {
                imgIconGauge.fillAmount = 0;

                // バフ、デバフを適用して現在値を算出

                tweener = imgIconGauge.DOFillAmount(1.0f, currentAttackSpeed).SetEase(Ease.Linear).SetLink(gameObject);

                
                // キャンセル時の処理を登録(このスコープ内でキャンセルされた場合に、この処理が実行される)
                using (token.Register(() => {
                    tweener?.Kill();
                })) {
                    // 攻撃までの待機時間
                    // 小数点以下も含めた精度を保つために、適切なスケーリングを行う
                    int attackInterval = Mathf.CeilToInt(currentAttackSpeed * 1000); // 1000 でスケールして切り上げ
                    await UniTask.Delay(attackInterval, cancellationToken: token);
                }

                // どちらかの hp が 0 になっていないか EntityType で判定
                // 残っている場合には下の処理へ。残っていない場合には終了
                // どちらかの hp が 0 になっていないか EntityType で判定
                //bool isEndBattle = BattleManager.Instance.CheckEndCondition();
                //if (isEndBattle) {
                //    break;
                //}

                // スタミナが残っているか判定(スタミナコストのみ見る)
                // 残っている場合には下の処理へ。残っていない場合には終了


                // コスト消費


                // 命中判定
                // currentAccuracy を 0-100 の範囲にスケーリング
                float scaledAccuracy = currentAccuracy * 100f;

                // 0-100 の範囲のランダムな値を生成
                int randomValue = UnityEngine.Random.Range(0, 100);

                // 命中判定
                if (randomValue <= scaledAccuracy) {
                    // 命中した場合の処理
                    Debug.Log("Hit!");

                    // 攻撃力設定
                    int damage = UnityEngine.Random.Range(currentMinDamage, currentMaxDamage);

                    // ダメージ処理

                } else {
                    // 失敗した場合の処理
                    Debug.Log("Miss!");
                }

                // クールタイム設定
                int coolTimeInterval = Mathf.CeilToInt(currentAccuracy * 1000);
                await UniTask.Delay(coolTimeInterval, cancellationToken: token);

                // どちらかの hp が 0 になっていないか EntityType で判定し、0 の場合には break で抜ける
                //isEndBattle = BattleManager.Instance.CheckEndCondition();
                //if (isEndBattle) {
                //    break;
                //}
            }
        }
        catch (OperationCanceledException) {
            // while 文を抜けてキャンセルされた場合の処理
            tweener?.Kill();
            tweener = null;

            // キャンセルされたことを通知
            onCancel.OnNext(Unit.Default);
        }
    }
}

動作の流れ

１．デリゲートの登録

　using ([...A]) は、そのハンドラーをスコープの終わりで解除するための処理を記述する場所です。

　今回、([...A]) の部分には、token.Register(() => { tweener.Kill(); }) が登録されています。
よって、token がキャンセルされたときに実行されるデリゲート(今回は tweener.Kill を実行するデリゲート)が token に登録されます。
このメソッドは CancellationTokenRegistration オブジェクトを返します。
このオブジェクトは IDisposable を実装しており、Register メソッドの戻り値として using ステートメントに渡され使用されます。

MicroSoft
CancellationTokenRegistration
https://learn.microsoft.com/ja-jp/dotnet/api/syste...

２．using ステートメントブロック(スコープ)の中での処理

　using ステートメントブロック内のコードが実行されます。この場合、await UniTask.Delay(attackInterval, cancellationToken: token); が実行されます。
この待機中に token がキャンセルされると(処理中にキャンセルが要求された場合)、登録されたデリゲート（ここでは tweener.Kill()）が実行されます。

３．using ステートメントブロック(スコープ)の終了

　await が完了するか、キャンセルが発生して OperationCanceledException がスローされると、using ブロックの終わりに到達します(ブロックを抜けます)。
ブロックを抜けると、ここで CancellationTokenRegistration.Dispose が自動的に呼び出され、IDisposable が自動的に破棄されます。
これにより、using ステートメントブロックのキャンセルハンドラーに登録されたデリゲート(下記の部分)が解除されます。
（以後そのトークンがキャンセルされてもこのデリゲートは呼び出されません）。

 token.Register(() => {
tweener.Kill();
})

　この部分のリソースを解放し、使われなかったデリゲートを自動的に破棄しています。

４．要点

　１．token.Register はキャンセルハンドラーを登録し IDisposable を返す。
　２．using ステートメントはその IDisposable を利用して、スコープ終了時に自動的にリソースを解放（ここではキャンセルハンドラーの登録を解除）。
　３．using ブロック内には await UniTask.Delay が含まれており、キャンセルが発生すると tweener.Kill() が呼び出される。
　
この理解をもとに、正しくキャンセル処理を行うことができるでしょう。

結論

　CancellationToken.Register メソッドは IDisposable（具体的には CancellationTokenRegistration）を返し、これを using ステートメントで管理することで、キャンセルが要求された時に実行されるデリゲートを登録および解除することができます。
using ステートメントを用いることで、スコープ終了時に自動的にリソース（ここではキャンセルハンドラー）を解放し、デリゲートが不要になったタイミングで適切に破棄されるようにします。
この理解でコードを進めていただければ、正しくキャンセル処理を実装できます。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

CancellationToken.Register メソッドと using ステートメントの組み合わせ例 - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school