12月 | 2009 | ++C++; // 未確認飛行 C ブログ

Archive for 12月 2009

INotifyPropertyChanged の実装

with 3 comments

追記：色々更新した

前々から気になってはいたんだけども。

今の C# だと、手書きだけで INotifyPropertyChanged の実装をうまくやろうと頑張るのは厳しいと思うんですよね。コードスニペット使うのを前提に考えるのが一番いい妥協だと思います。

ということで、以下のようなものを作成。

ヘルパークラス（C#）
- とりあえず同じプロジェクトにぶち込むなりライブラリ化するなり
コードスニペット
- マイドキュメントの下の、Visual Studio のフォルダー以下、Code SnippetsVisual C#My Code Snippets にコピって置いてください

あとは、propnotify ってタイピングしてタブを押して、型名とプロパティ名を打つだけ。

例：

例えば、以下のような感じ（青いところがコードスニペットで生成した部分）になります。

public class CodeSnipet前提な実装 : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;

    public string Name
    {
        get { return _fieldName; }
        set
        {
            if (_fieldName == value) return;
            _fieldName = value;
            PropertyChanged.Raise(this, PropertyNameName);
        }
    }

    private string _fieldName;
    private string _propertyNameName;
    private string PropertyNameName
    {
        get
        {
            if (_propertyNameName == null)
                _propertyNameName = PropertyChangedEventHandleExtensions.PropertyName(() => Name);
            return _propertyNameName;
        }
    }
}

public static partial class PropertyChangedEventHandleExtensions
{
    public static string PropertyName<T>(Expression<Func<T>> property)
    {
        var memberExp = property.Body as MemberExpression;
        if (memberExp == null)
        {
            throw new ArgumentException();
        }

        var senderExp = memberExp.Expression as ConstantExpression;
        if (senderExp == null)
        {
            throw new ArgumentException();
        }

        return memberExp.Member.Name;
    }

    public static void Raise(this PropertyChangedEventHandler handler, object sender, params string[] propertyNames)
    {
        if (handler == null)
        {
            return;
        }

        foreach (var name in propertyNames)
        {
            handler(sender, new PropertyChangedEventArgs(name));
        }
    }
}

ポイント

コードスニペットにしておけば、タイピング量は大したことない
- 上のコードでいうと、string と Name しか打たない
プロパティ名はキャッシュしておく
- 式木操作は結構重たいんで、毎回 exp.Member.Name を取得するのは避けたい
- これを避けるだけで、普通の実装とほとんど変わらない性能が出る
コードスニペット使うのに OnPropertyChanged(“Name”) にしない理由
- 文字列にしちゃうと、Name をリネームしても "Name" の部分は書き換わってくれない
- C# の場合、ツールサポートが最大限得られるように作るのが一番実入りいい
  - なので、() => Name から式木経由でプロパティ名を取るのはなかなかいい案だと思う
Raise の propertyName は params にして複数受け取れるようにした方がいいかも
- 1つ更新されたときに、他のプロパティ値も一緒に変化する場合も結構あるんで