⚠️

非同期メソッド内で Unity オブジェクトを正しくハンドリングする

に公開

何が問題なのか

細かいですが、await を超えた後は別フレームの可能性が高いので再チェックが必要だという話です。

public class DestroyTest : MonoBehaviour
{
    public async void OnEnable()
    {
        await TestAsync(this.destroyCancellationToken);
    }

    async Task TestAsync(CancellationToken ct)
    {
        try
        {
            if (ct.IsCancellationRequested)
                return;

            Debug.Log(this.name);
            Destroy(this);
            Debug.Log(this.name + "(実はまだアクセスできる…!) null? " + (this == null));

            await Task.Delay(1);
            Debug.Log("ココから次のフレーム");

            // ちゃんとやるには全ての await 以後に CT チェックが必要
            // ※ MissingReferenceException が出るだけなのでやらなくても問題ないっちゃない
            //if (ct.IsCancellationRequested) return;

            Debug.Log(this.name);
        }
        catch (Exception e)
        {
            Debug.LogException(e);
        }
    }
}

👇 実行結果

Main Camera
Main Camera(実はまだアクセスできる…!) null? False
ココから次のフレーム
MissingReferenceException: The object of type 'Test.DestroyTest' has been destroyed but you are still trying to access it.
Your script should either check if it is null or you should not destroy the object.

CancellationToken で良いのか問題

上記のサンプルは同じメソッド内なので分かりやすいですが、実際は別の場所から破棄される可能性もあります。

なので、残念ながら CancellationToken を渡しても魔法のようにすべてが解決するわけではありません。というかキャンセルトークンは渡す意味がない、メソッドパラメーターに cancellationToken = default 追加するのヤメろまであります。

  • CT として .destroyCancellationToken を渡すには非同期メソッド内でアクセスされる Unity オブジェクトの存在を「呼び出し側」が知っていなければならない
    • ❌ ダメでしょw
  • 非同期メソッド側が能動的に .destroyCancellationToken を見に行く
    • そうであるべき感
    • ⚠ メインスレッドからのアクセスが確定しているのに CancellationToken の性質上スレッドセーフな処理が行われる
      • (気にしなくて良いレベルで)無駄な処理が走る
      • CreateLinkedTokenSource もそれなりの処理+アロケーション
      • 普通にヌルチェックで良い
  • そもそもファイル/ネットワークアクセスが絡まない場合はミリ秒で処理が終わる

まとめると…

  • 「MonoBehaviour 絡み」で CancellationToken 使うの微妙
  • if (unityObj != null) で十分/むしろ信頼性が高いのでは?
    • 呼び出し側が非同期メソッドの実装詳細を知る必要がなくなる
    • そもそもキャンセルトークンはヌルチェックの為じゃないし

ちゃんとやらなくても MissingReferenceException が出るだけなので(エラーログを収集していない限りは)たいした問題ではないですが!

アナライザーで解決する

問題と解決方法が見えたので、後は AI が働くだけです。

👇 生成したアナライザーを使った結果がコチラ

鬱陶しいエラーを防ぐには、「Unity オブジェクトのヌルチェックのみで構成された if 文」の中でアクセスを行う必要があります。

if (this != null)  // '!= null' と '&&' のみ許可(早期リターンは else 内で行う)
{
    // このブロック内はエラーが出ない
    Debug.Log(this.name);

    await FooAsync();  // が! セーフブロック内での await は内容問わず警告が出る
}
else
{
    return;  // 早期リターンは else 内で行う
}

フロー解析

上記の通り、早期リターンには対応していません。

Roslyn にはフロー解析する為の API(ControlFlowGraph/DataFlowAnalysis)があるみたいですが、パッと見た感じ

  • 良い感じに最初の await 以後かを判断する
  • 早期リターンでヌルチェックが済んでいるか判断する

これらを自動でやってくれる訳じゃなさそうなので、

  • 上から見ていって最初に見つかった await
    • または最初のラベルの位置を探す
  • await が foreach や while 等ブロック要素の中だった場合、親ブロックの先頭を「最初の await」とする
    • ループを考慮するとブロック内はアンセーフの可能性

て感じで処理しています。要は過度にエラー判定される可能性があるってことです。

上手いことやりたいですが、片手間でやるにはフロー解析は大変ですからね。AI の生成したコードの正当性を検証する為には結局自分も知識を得なければなりませんし。

外部ライブラリーで結構エラーが出る

プロジェクトに導入するとかなりのエラーが出ます。特にサンプル系は動けば良い的な雑な実装が多いので3ケタ以上見つかります。

エラーが出た個所を見てみると、確かにヌルになる可能性が微レ存という感じです。特にループとかは分かり辛い。

foreach (var obj in unityObjects)
{
    obj.name = "hello";  // ループ2周目はヌルの可能性
    await FooAsync();
}

なので、使う場合は Unity プロジェクトに .dll を取り込むのではなく、Directory.Build.props 等で参照して IDE 上でのみエラーが出る状態にするのがおススメです。

もし Unity に取り込んだ場合は、csc.rsp に以下を追加すれば IDE 上ではエラーが出る状態でコンソールのエラーを抑制できます。(抑制するのはエラーですが nowarn です)

-nowarn:SIUA001,SIUA002

おまけ

複数のプロジェクトで .cs ファイルを共有する方法

👇 SharedAcrossProjects というフォルダー以下に shared/ 内のすべての .cs が元のファイル名のまま共有される。

<Project Sdk="Microsoft.NET.Sdk">

  <!-- ... -->

  <ItemGroup>
    <Compile Include="../shared/*.cs" Link="SharedAcrossProjects/%(Filename)%(Extension)" />
  </ItemGroup>

</Project>

パッケージングの関係でアセンブリーを参照してしまうと都合が悪い場合に特に有用。AI に「ファイル名ベタ書きはイヤなんだよねー」とか言ったら教えてくれました。

再帰的に Directory.Build.props を読み込む

.editorconfig と違い、Directory.Build.props は再帰的に読み込まれません。

親フォルダーの .props を読み込ませたい場合は、冒頭に以下を追加します。

<Project>

  <Import Project="$(MSBuildThisFileDirectory)../Directory.Build.props"
          Condition=" Exists('$(MSBuildThisFileDirectory)../Directory.Build.props') "
  />

  <!-- ... -->

</Project>

おわりに

👇 アドベントカレンダーの投稿に加えるには長かったので!

https://zenn.dev/sator_imaging/articles/9e5c963298fbf1

以上です。お疲れ様でした。

Discussion