C#優雅的實現INotifyPropertyChanged接口

Posted on by

INotifyPropertyChanged接口在WPF或WinFrom程序中使用還是經常用到，常用於通知界面屬性變更。標準寫法如下：

    class NotifyObject : INotifyPropertyChanged
    {
        private int number;
        public int Number
        {
            get { return number; }
            set { number = value; OnPropertyChanged("Number"); }
        }

        private string text;
        public string Text
        {
            get { return text; }
            set { text = value; OnPropertyChanged("Text"); }
        }

        public event PropertyChangedEventHandler PropertyChanged;
        protected void OnPropertyChanged(string propertyName = "")
        {
            PropertyChangedEventHandler handler = PropertyChanged;
            if (handler != null)
            {
                handler(this, new PropertyChangedEventArgs(propertyName));
            }
        }
    }

這種寫法的兩個問題是

  • 對屬性名使用瞭字符串硬編碼，容易寫錯，也不方便重構
  • 冗餘代碼，如果屬性較多的時候寫得想吐

 我在博客文章使用CallerMemberName簡化InotifyPropertyChanged的實現中介紹瞭通過Caller Information解決屬性名稱字符串硬編碼的問題。但是仍然不能解決冗餘代碼的問題。對於第二個問題，往往是通過AOP的方式實現，一般的實現方式有兩種：

  • 通過代理對象封裝
  • 通過編譯期間代碼註入的方式實現

我增在項目中使用過DynamicObject封裝來實現過，主要原理是用實現一個PocoNotifyWrapper的DynamicObject類，托管其屬性的讀寫動作，並附加IntofyPropertyChanged接口實現。

這種方式是動態的AOP瞭，是一個通用的方式，並且擴展性比較器，可以通過繼承PocoNotifyWrapper來實現多態。用它做ViewMode層還是比較方便。

不過一個不大好的地方是DynamicObject是丟失瞭屬性類型信息的，有時綁定時會出錯（如將一個TextBox的Text綁定到一個封裝後的Int類型對象時會不進行自動類型轉換）。要解決它還需要實現一些其它的接口，實現起來還是有些復雜的，並且項目進度比較緊張，沒有太多時間來完善它。

另外一種方式是通過編譯期間代碼註入方式來實現：

最開始見的是PostSharp的一個實現： http://doc.postsharp.net/inotifypropertychanged-add。不過PostSharp是收費的，後來也逐漸由瞭許多其它的免費的解決方案。本文這裡介紹的是一個開源的解決方案：Fody。

使用它非常簡單，首先通過Nuget安裝庫：PM> Install-Package PropertyChanged.Fody。然後在需要實現屬性通知的類上加一個[ImplementPropertyChanged]即可：

　　[ImplementPropertyChanged]
　　public class Person
　　{

　　　　public string GivenNames { get; set; }
　　　　public string FamilyName { get; set; }

　　　　public string FullName => string.Format("{0} {1}", GivenNames, FamilyName);
　　}

編譯後生成的代碼如下：

public class Person : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;

    string givenNames;
    public string GivenNames
    {
        get { return givenNames; }
        set
        {
            if (value != givenNames)
            {
                givenNames = value;
                OnPropertyChanged("GivenNames");
                OnPropertyChanged("FullName");
            }
        }
    }

    string familyName;
    public string FamilyName
    {
        get { return familyName; }
        set 
        {
            if (value != familyName)
            {
                familyName = value;
                OnPropertyChanged("FamilyName");
                OnPropertyChanged("FullName");
            }
        }
    }

    public string FullName
    {
        get
        {
            return string.Format("{0} {1}", GivenNames, FamilyName);
        }
    }

    public virtual void OnPropertyChanged(string propertyName)
    {
        var propertyChanged = PropertyChanged;
        if (propertyChanged != null)
        {
            propertyChanged(this, new PropertyChangedEventArgs(propertyName));
        }
    }
}

基本上對代碼沒有註入，不需要安裝插件，也不影響調試，實現非常簡單，非常方便。

需要註意的是，如果實現瞭INotifyPropertyChanged接口，即使沒有[ImplementPropertyChanged]標記，默認也會註入。

以上就是這篇文章的全部內容瞭，希望本文的內容對大傢的學習或者工作具有一定的參考學習價值，謝謝大傢對WalkonNet的支持。如果你想瞭解更多相關內容請查看下面相關鏈接

推薦閱讀：