ReactiveProperty の注意点

　UniRx の提供する ReactiveProperty は大変強力で便利な機能ですが、注意すべき点もいくつかあります。

　特に非同期処理になれないうちは、エラーの原因として ReactiveProperty が作用している部分が見えにくく、エラー解決ができにくいという部分もあります。
複数の人が携わるプロジェクトとなると、なおさら煩雑になりがちです。
またオブザーバーパターンの理解が深まらないと、どのクラスで購読されていて、どのタイミングで動いているのかなど、通常の処理に比べてわかりくい挙動も多いです。

　処理の内容をしっかりと理解した上で、適切な用法で利用していくことが求められます。

１．null チェックの方法

　ReactiveProperty は、値型または参照型のデータをラップすることができます。
具体的には、ジェネリックな性質を持っており、どんな型でもラップすることができます。
そのため、int や float などの値型だけでなく、string や object、 GameObject、自作クラスなどの参照型もラップすることができます。

　例えば、ReactiveProperty<int>は値型である int 型の値をラップしますが、
ReactiveProperty<string>は参照型である string 型の値をラップします。
そして、それぞれの ReactiveProperty インスタンスは、その型に応じた値を持ちます。

　ReactivePropertyが値型をラップする場合、その値はnullになることはありません。
一方、参照型をラップする場合、その値はnullになる可能性があります。

　C# の値型（int、float、boolなど）を宣言した ReactiveProperty の場合、通常は null チェックは必要ありません。
値型は null になることができないためです。(null 許容型である場合を除きます)

　ですが、参照型のプリミティブ型(string、object など)であったり、GameObject やコンポーネントの型、自作クラスなどを宣言した ReactiveProperty の場合には、null チェックが必要になります。
参照型の変数は null になる可能性があるためです。

　例えば、ReactiveProperty<Rigidbody>のようにコンポーネントの型のクラスを宣言した ReactiveProperty の場合、
Rigidbody が null である可能性があります。ReactivePropertyは参照型のデータをラップしていますが、自体が null であることもあるためです。

　通常の変数と ReactivePropertyの違いは、ReactivePropertyはクラスであり、そのインスタンスが null である可能性がある点です。
その場合、ReactivePropertyのnullチェックは次のように行う必要があります。

public class Test_A {
    public int count;
}

public class Test_B {

    public ReactiveProperty<Test_A> TestProperty = new();

    void Start() {

        if (TestProperty == null || TestProperty .Value == null) {
            return;
        }
    }
}

　このように、TestProperty が null であるかどうかをチェックし、
その後に TestProperty.Value が null であるかどうかをチェックすることで、正しく null チェックを行うことができます。

２．CompositeDisposable を利用した場合の購読停止のタイミング

　UniRx の処理は AddTo メソッドを利用して購読停止を行うケースがあります。
ただし、オブジェクトプールなどを併用している場合には、AddTo で紐づいているオブジェクトが破壊されないため、購読停止が行われません。
そのため、別途、Dispose する必要があります。

　その際、CompositeDisposable を利用して複数の UniRx や ReactiveProperty を監視している場合、
CompositeDisposable は一度 Dispose すると同じストリームでは購読が再開されません。

　購読処理を再開させる予定がある場合には、Clear メソッドを利用して購読停止するか、単体で停止できるように IDisposable 型を利用しましょう。
あるいは新しいインスタンスを作成して利用していく方法を採用してください。

　サンプルコードです。

using UniRx;
using UnityEngine;


/// <summary>
/// ライフ管理用基底クラス
/// </summary>
public class LifeBase {

    public ReactiveProperty<int> Hp = new();
    protected int maxHp;

    protected readonly CompositeDisposable disposables = new();
    public CompositeDisposable Disposables { get => disposables; set => disposables.Add(value); }


    protected void Dispose() {

        // Dispose ではなく Clear で購読を停止する
        disposables.Clear();

　　　　// あるいは新しいインスタンスを作成する
　　　　disposables = new();
    }

    protected void OnDestroy() {
        Dispose();
    }
}

　Hp を購読する場合には、下記のように指定します。

private LifeBase myLife;

// Hp の購読
myLife.Hp
    .Subscribe(hp => Debug.Log($"hp : {hp}")
　　.AddTo(myLife.Disposables);

　AddTo の引数に先ほど作成したクラス内の CompositeDisposable のプロパティを指定することで購読停止を実行することができます。

３．代入処理での注意点(例：Mathf クラスとの併用)

　ReactiveProperty に対して代入処理を行う場合、右辺に左辺と同じ ReactiveProperty を利用してしまうと、2回分の購読処理が動きます。

    public ReactiveProperty<int> Hp = new();

    void Start() {
        Hp.Value = 10;
        Hp.Value = Hp.Value + 10;
    }

　そのため Mathf クラスなどに ReactiveProperty を一緒に利用する場合、その引数内に ReactiveProperty を利用すると購読処理が複数回動きます。

　例えば Mathf.Clamp メソッドを利用して、ReactiveProperty を制限値内に収めたい場合、Clamp メソッド内で代入処理を挟んでしまうと
ReactiveProperty の計算処理の時点で1回購読され、さらにその値が Clamp の制限値を超えた場合には数値が再度更新されるため、
もう1回購読処理が動きます。

　そのため、予期していない値での購読処理が行われる可能性が高いため、
①一度、ローカル変数を作成し、その値を Mathf クラスで制限してから ReactiveProperty に代入するようにする
②あるいは、Clamp 内では ReactiveProperty に代入処理しない(＋＝で処理しない)ことで安全に運用できます。

using UniRx;
using UnityEngine;

/// <summary>
/// ライフ管理用基底クラス
/// </summary>
public class LifeBase : MonoBehaviour {

    public ReactiveProperty<int> Hp = new();
    protected int maxHp;


    /// <summary>
    /// 初期設定
    /// </summary>
    /// <param name="initHp"></param>
    protected virtual void SetUpLife(int initHp) {
        Hp.Value = initHp;
        maxHp = initHp;
    }

    /// <summary>
    /// Hp 計算処理
    /// 生存判定付
    /// </summary>
    /// <param name="amount"></param>
    /// <returns></returns>
    public virtual bool CalcLife(int amount, int effectIndex, string seType) {

　　　　// ①－１　ローカル変数に ReactiveProperty を代入し、直接計算しないようにする
        int hp = Hp.Value;

        // ①－２　hp の計算を Clamp で制限することで、Value への代入を1回だけにする
        Hp.Value = Mathf.Clamp(hp += amount, 0, maxHp);

        // ②あるいは、＋ のみで加算する(代入処理を挟まない)
        Hp.Value = Mathf.Clamp(Hp.Value + amount, 0, maxHp);

        return Hp.Value > 0;
    }
}

　下記のように処理を書くと、Clamp メソッド内で ReactiveProperty の購読処理が2回が動く可能性があります。
　

    public virtual bool CalcLife(int amount, int effectIndex, string seType) {

　　　　// ReactiveProperty の計算を直接 Clamp 内で行うと、第1引数の計算時に1回、Clamp の制限時に1回、購読処理が動く可能性がある
        Hp.Value = Mathf.Clamp(Hp.Value += amount, 0, maxHp);

        return Hp.Value > 0;
    }

　これを避けるようにコーディングしましょう。

４．最初の購読処理の実行タイミング

　ReactiveProperty<T>はデフォルトで「Hot Observable」として動作します。つまり、Subscribeを呼び出した時点(設定した時点)で、現在の値が購読されます。
ReactiveProperty<T>は初期値を持っており、サブスクリプションが設定されると即座にその初期値を購読者に通知します。このため、「Cold 状態」でスタートするわけではありません。

　確認のため、以下のコードを見てみましょう。

using UnityEngine;
using UniRx;

public class ReactiveExample : MonoBehaviour
{
    // ReactivePropertyの初期化
    private ReactiveProperty<long> remainGold = new ReactiveProperty<long>();

    private void Start()
    {
        // ReactivePropertyの値に対して購読
        remainGold.Subscribe(value => Debug.Log("Value changed to: " + value));
    }

    private void Update()
    {
        // スペースキーが押されたらReactivePropertyの値を変更
        if (Input.GetKeyDown(KeyCode.Space))
        {
            remainGold.Value += 10;
        }
    }
}

　上記のコードでは、Start メソッドで購読を設定していますが、Subscribeメソッドを呼び出した直後に Console ビューに「Value changed to: 0」が出力されます。
これは、ReactiveProperty<long>が初期値 0 を持っているため、その初期値が即座に購読者に通知されるためです。

　 Updateメソッドでスペースキーが押されたらremainGoldの値を10ずつ増加させます。
そのタイミングで Console ビューに「Value changed to: 10」「Value changed to: 20」のように、1回ずつログが出力されます。

　まとめると、ReactiveProperty<T>はデフォルトで「Hot Observable」として動作し、Subscribeを呼び出した時点で現在の値を即座に購読者に通知します。
そして購読処理が初期値で1回行われます。

５．名前空間

　using UniRx; と宣言することで ReactiveProperty<T> や、それ以外のライブラリの機能を利用できます。

　Unity ではない C# の場合、using Reactive.Bindings; の宣言を行います。
ReactiveProperty<T>を含むReactive.Bindingsライブラリ全体をインポートするための宣言です。
using Reactive.Bindings; を宣言することで、下記の機能が利用可能になります。この名前空間にはReactiveProperty<T>以外にも、以下のようなさまざまなクラスやユーティリティが含まれています：

ReactiveCommand：コマンドのリアクティブ処理をサポート。
ReadOnlyReactiveProperty<T>：読み取り専用のリアクティブプロパティ。
ReactiveCollection<T>：コレクションが変更されたときに通知を受けるためのクラス。
各種拡張メソッド：Observableの変換や操作に使用するものなど。

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

印刷する

コメント（0）

ReactiveProperty の注意点 - i-school 先頭へ

コメントをかく

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

i-school