読者です 読者をやめる 読者になる 読者になる

UniRxを1日勉強してみた感想

c# Unity

結論

まず最初に結論を。ゲーム開発がメインの私的にはObserveEveryValueChanged, Timer, AddTo(安全のため必須)あたりを使えれば十分かなぁという感想。実は、気づいていないすごい便利な使い方とかあるかもしれないので、オススメの使い方がありましたら教えて頂けると嬉しいです。

あと、ここに載せたの以外にも色々とあるらしいのですが、全然キャッチアップできていません(><)

説明

UniRxとはneueccさんが開発されている Reactive Extensions をUnity用に実装した+アルファなライブラリです。

Reactive Extensionsとは、非同期な処理を関数型プログラミングっぽい感じでかけるライブラリです。

例えば、3秒後に○○したいとか、0.5秒間隔で○○したいとか、特定の変数の値が変わった時に○○したいっていうのが簡潔に掛けます。

以下、細かい説明。

Timer

ちょっと遅延させて実行してくれる。今までは遅延させたい時はInvokeを使っていたけど、いちいちそのために関数に切り出してたので、これは便利。

var timer = Observable.Timer( System.TimeSpan.FromSeconds( 3 ) );
timer.Subscribe( _ => Debug.Log( "Hello!" ) );//3秒後にプリント

Delay, DelayFrame

ちょっと遅延させて実行してくれる、その2。
こちらは、修飾的(?)なものなので、Observableなオブジェクトに大して後ろからくっつける。

var delay = Observable.Return(Unit.Default).Delay( System.TimeSpan.FromSeconds( 3 ) );
delay.Subscribe( _ => Debug.Log( "Delayed log" ) );//3秒後にプリント
var delay = Observable.Return(Unit.Default).DelayFrame( 120 );
delay.Subscribe( _ => Debug.Log( "Delayed log" ) );//120Frame後にプリント

Interval

定期的に実行してくれる。ゲームで制限時間とか表示する時に使えそう。

var interval = Observable.Interval( System.TimeSpan.FromSeconds( 1 ) );
interval.Subscribe( x => Debug.Log( ( x + 1 ).ToString() + "秒" ) );//1秒,2秒,3秒...

EveryUpdate

毎フレーム実行してくれる。

var every = Observable.EveryUpdate();
every.Subscribe( _ => Debug.Log( "Hello!" ) );

たいていUpdate関数内に掛けば済むので使い所があまり思い浮かばない。

遅延させた後に毎フレーム実行したいときとか?

var every = Observable.EveryUpdate();
var delayed_every = every.Delay( System.TimeSpan.FromSeconds( 3 ) );
delayed_every.Subscribe( _ => Debug.Log( "Hello!" ) );

ObserveEveryValueChanged

値が変わった時に処理が走る。使いやすい。他のと違ってgameObjectの拡張メソッドになっているので注意が必要。

public int hoge;

void Start () {
    var change = gameObject.ObserveEveryValueChanged( _ => hoge );
    change.Subscribe( x => Debug.Log(x) );//hogeの値が変わると、呼ばれる
}

ReactiveProperty

ObserveEveryValueChangedのラッパーみたいなの。個人的にはObserveEveryValueChangedの方が使いやすくない?って思う。

例:スコアが変わったら、UI上の表記を変えてる

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;
using UniRx;

public class Test : MonoBehaviour {
    [SerializeField]
    Text scoreText;

    ReactiveProperty<int> score = new ReactiveProperty<int>();

	// Use this for initialization
	void Start () {
        score.Subscribe( x => scoreText.text = x.ToString() ).AddTo( this );
	}
	
	// Update is called once per frame
	void Update () {
        score.Value += 1;
	}
}

OnClickAsObservable

ボタンをクリックしたときの処理が書ける。

var on_click = button.OnClickAsObservable();
on_click.Subscribe( _ => Debug.Log("clicked") );//クリックするとclickedがプリントされる

しかし、

button.onClick.AddListener( () => Debug.Log("clicked") );

で同じことができるので、どういうときに有効なのかが今のところ分からない。

Range

引数で指定した値の範囲分、処理を回してくれます。連番の配列を作る時に良いかも。例えば100個あるステージ名の配列を作るとか。

const int cMaxStage = 100;
string[] stage_names = new string[cMaxStage];
var range = Observable.Range(0,cMaxStage);
range.Subscribe( x => stage_names[x] = "stage" + x );

for文を使うよりもかっこいい... っと言えなくもない。
これだけだと、イマイチだけど、範囲指定の処理をいろんな場所で行うなら、一回Rangeを作っておいて、色んな場所で回すってのがスマートにできそう。

Where

処理を行うものを条件でフィルタリングする。if文掛けば済むことが多いけど、こっちの場合フィルターしたものを変数として持ち運べるのが便利。

var even_range = range.Where( x => x % 2 == 0 );
even_range.Subscribe( x => stage_names[x] = "stage" + x );
even_range.Subscribe( x => Debug.Log( stage_names[x] ) );//stage0, stage2, stage4 と出力される

Return

値を返すだけのオブザーバブルなオブジェクト。今のところ使用例が思いつかないけど、複雑なことをしたいときの道具として使うんじゃなかろうか。

var ret = Observable.Return( 10 );
ret.Subscribe( x => Debug.Log( x ) );//10

兎にも角にもなんでも良いからオブザーバブルなオブジェクトを作りたいときってときは、引数にUnit.Defaultを取るのが通例の模様。

var ret = Observable.Return( Unit.Default );
ret.Subscribe( x => Debug.Log( x ) );//()

購読停止

Subcribeで走っている処理を止めたい時は、IDisposableのDisposeを呼ぶ。
(using System;してないと、IDisposableなんてありませんよーっていうエラーになるので注意。)

var every = Observable.EveryUpdate();
IDisposable disposer = every.Subscribe( _ => Debug.Log( "Hello!" ) );
disposer.Dispose();

AddTo

AddToの説明の前にUniRxのSubscribeの仕組みについて。

Subscribeを呼ぶとDon't destroyなオブジェクトができるので、UniRxのSubscribeは、おそらくそこにコルーチンを登録しているのだと思う。

そこで、問題なのがコルーチンを登録したままGameObject等を破棄した場合。
別な言い方をすると購読が停止されないままに購読者が死んじゃった場合。
この場合、コルーチンだけ残って処理を続けようとするので、処理的に無駄だったり、死んでしまった購読者にアクセスしようとするからNullアクセス例外が発生したりする。

そういうのを回避するためにあるのが、AddTo。

Subscribe( ... ).AddTo( this )

ってしておけば、thisが死んだ時に登録しておいた処理も破棄してくれる。基本的にSubscribeとAddToはペアで呼ぶものと覚えておいたほうが良さそう。

this以外にも渡せるので、寿命をともにしたいものをAddToすると便利そう。