C#優雅的實現INotifyPropertyChanged介面

2022-08-27 22:00:35

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]標記，預設也會注入。

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對it145.com的支援。如果你想了解更多相關內容請檢視下面相關連結

C#優雅的實現INotifyPropertyChanged介面

熱門文章