WPF中使用CallerMemberName簡化InotifyPropertyChanged的實現

Posted on by

在WPF中，當我們要使用MVVM的方式綁定一個普通對象的屬性時，界面上往往需要獲取到屬性變更的通知，

    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));
            }
        }
    }

這麼做有一個比較大的隱患，那就是用瞭字符串的硬編碼的方式傳遞瞭屬性名稱，一旦拼寫錯誤或因為重構代碼忘記去更新這個字符串時，這樣就會導致界面上得不到更新。（本身硬編碼的方式來保證兩者的一致性就是不靠譜的行為）

雖然這本身並不是問題，但卻不是很好的實踐。也有人通過一些手段來解決這個問題，有的是通過表達式樹，還有的通過Attribute註入的方式。

從性能上來講，註入是一個比較好的方式，但往往引入瞭比較復雜的框架。實際上，在C# 5.0中就引入瞭一個調用方信息的語法方便我們獲取調用方的函數名稱和位置，通過它可以非常簡單快捷的解決上面的這個問題：

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

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


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

代碼很簡單，這裡就不多介紹瞭。

更進一步

有的時候，為瞭減少通知的頻率，往往會把通知寫出如下形式：

    private int number;
    public int Number
    {
        get { return number; }
        set
        {
            if (number == value)
                return;

            number = value;
            OnPropertyChanged();
        }
    }

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

            text = value;
            OnPropertyChanged();
        }
    }

這種寫法非常單調，並且在屬性多的時候代碼就顯得很累贅瞭。這裡我就寫瞭一個通用點的函數把他們統一起來，下次就可以直接用瞭。

    private int number;
    public int Number
    {
        get { return number; }
        set { UpdateProper(ref number, value); }
    }

    private string text;
    public string Text
    {
        get { return text; }
        set { UpdateProper(ref text, value); }
    }

    protected void UpdateProper<T>(ref T properValue, T newValue, [CallerMemberName] string properName = "")
    {
        if (object.Equals(properValue, newValue))
            return;

        properValue = newValue;
        OnPropertyChanged(properName);
    }

由於C#的語法限制，不能在類外部調用event，因此不能寫成擴展方法，這裡就簡單的寫成一個對象，下次就直接照著改好瞭：

    class NotifyObject : INotifyPropertyChanged
    {
        private int number;
        public int Number
        {
            get { return number; }
            set { UpdateProper(ref number, value); }
        }

        private string text;
        public string Text
        {
            get { return text; }
            set { UpdateProper(ref text, value); }
        }

        protected void UpdateProper<T>(ref T properValue, T newValue, [CallerMemberName] string properName = "")
        {
            if (object.Equals(properValue, newValue))
                return;

            properValue = newValue;
            OnPropertyChanged(properName);
        }

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

到此這篇關於WPF中使用CallerMemberName簡化InotifyPropertyChanged的文章就介紹到這瞭。希望對大傢的學習有所幫助，也希望大傢多多支持WalkonNet。

推薦閱讀：