[MVVM] UIスレッドへの通知を適切なコンテキストで行うBindableBase｜Denso IT Laboratory researcher's blog sites

ホーム　>　技術ブログ　>　 [MVVM] UIスレッドへの通知を適切なコンテキストで行うBindableBase

増谷修増谷修

研究開発グループ

記事一覧

201311/22

プログラミング

[MVVM] UIスレッドへの通知を適切なコンテキストで行うBindableBase

[MVVM]　便利で間違えのないプロパティ変更通知を行うBindableBaseの実装

で、表記を短く、タイプセーフに、ポータブルに書く方法を紹介しました。

ところで、重いワーカースレッドを持つような処理だと、そもそもプロパティ変更通知自体がスレッド越えをしないといけないシーンが増えます。

特にモデルから直接ビューへデータバインディングをしているような場合は、適切なスレッド管理をするのは難しそうです。

これに透過的に対処するBindableBaseというのはどのようになるのでしょうか？

ヘルパーライブラリなどには例が無いようですが、ネット上にいくつかこれにトライしたものがあります。

DispatcherをBindableBase内部で用いるパターン

A better BindableBase – ZAG LOG

Zag Studioのブログに書かれている例ですが、CoreWindowなどからゲットしたUIスレッドのディスパッチャーをもってこれを直接呼び出します。

protected void OnPropertyChanged([CallerMemberName]
    string propertyName = null)
{
    if (_dispatcher == null || _dispatcher.HasThreadAccess)
    {
        var eventHandler = this.PropertyChanged;
        if (eventHandler != null)
        {
            eventHandler(this,
                new PropertyChangedEventArgs(propertyName));
        }
    }
    else
    {
        IAsyncAction doNotAwait =
            _dispatcher.RunAsync(CoreDispatcherPriority.Normal,
            () => OnPropertyChanged(propertyName));
    }
}

コードビハインドなどで書いている場合はこれで十分ですね。

Making sure OnPropertyChanged() is called on UI thread in MVVM WPF app – stackoverflow

ただこれはUIElementなどに近い場所で使うにはいいのですが、Modelの奥深くでこれをやるのはどうかなと思ったりします。

SynchronizationContextを利用したPortable Class Library対応パターン

またPortable Class LibraryではDispatcherクラスは扱えないので、SynchronizationContextを使った実装をしてみました。

public event PropertyChangedEventHandler PropertyChanged;
protected virtual void RaisePropertyChanged([CallerMemberName] string propertyName = null)
{
    var handler = PropertyChanged;
    if (handler == null) return;
  
    var context = SynchronizationContext.Current;
    if (context == null)
    {
        handler(this, new PropertyChangedEventArgs(propertyName));
    }
    else
    {
        context.Post((obj) =>
        {
            handler(this, new PropertyChangedEventArgs(propertyName));
        }, null);
    }
}

事前にSynchonizationContext.Currentに、Viewからもらったコンテキストを入れておく必要がありますが、それだけです。

contextが存在しない場合は元々UIスレッドで、実行されているという制御をやるべきなのですが、そこはまだできていません。

こういうデータバインディングで勝手にスレッド超えをしてしまう場合の対処を、ベースクラスに任せてしまうのは、エレガントといえるとは思いますが、見えないオーバーヘッドを多数作ってしまうので、使用には気を付けたいですね。

ObservableCollectionをラップしてスレッド越え対応にするパターン

この目的でいくと当然ながらObservableCollectionについても対応しないといけません。

これも同様の対応でいけると思いますが、ラップするのは少々大変です。

かずきさんがこれをトライされています。

マルチスレッド環境下でのコレクションの操作　-

if (IsValidAccess())
{
    // UIスレッドならそのまま実行
    base.OnCollectionChanged(e);
}
else
{
    // UIスレッドじゃなかったらDispatcherにお願いする
    Action<NotifyCollectionChangedEventArgs> changed = OnCollectionChanged;
    this.EventDispatcher.Invoke(changed, e);
}