简单的小型 INotifyPropertyChanged 实现

Question

假设我有以下课程：

public MainFormViewModel
{
    public String StatusText {get; set;}
}

使我对 StatusText 的更改反映到绑定到它的任何控件的最简单的最小方法是什么？

显然我需要使用 INotifyPropertyChanged，但是有没有一种很酷的方法可以做到这一点，并且不会使我的代码变得混乱？需要很多文件吗？ ETC？

注意：如果这是一个骗局，那么我很抱歉。我搜索后找不到任何东西，但使用 T4 代码生成听起来并不容易（至少设置起来）。

Answer 1

不幸的是，C# 没有提供一种简单的机制来自动执行此操作...它已经 建议创建这样的新语法：

public observable int Foo { get; set; }

但我怀疑它是否会被包含在该语言中。 一个可能的

解决方案是使用像 Postsharp 这样的 AOP 框架，这样你只需要用属性：（

public MainFormViewModel : INotifyPropertyChanged
{
    [NotifyPropertyChanged]
    public String StatusText {get; set;}
}

还没有尝试过，但我很确定 Postsharp 允许你做那种事情......）

---

更新：好的，我设法让它工作。请注意，这是一个非常粗略的实现，使用私有字段上的反射来检索委托...它当然可以改进，但我将把它留给您;)

[Serializable]
public class NotifyPropertyChangedAttribute : LocationInterceptionAspect
{
    public override void OnSetValue(LocationInterceptionArgs args)
    {
        object oldValue = args.GetCurrentValue();
        object newValue = args.Value;
        base.OnSetValue(args);
        if (args.Instance is INotifyPropertyChanged)
        {
            if (!Equals(oldValue, newValue))
            {
                RaisePropertyChanged(args.Instance, args.LocationName);
            }
        }
    }

    private void RaisePropertyChanged(object instance, string propertyName)
    {
        PropertyChangedEventHandler handler = GetPropertyChangedHandler(instance);
        if (handler != null)
            handler(instance, new PropertyChangedEventArgs(propertyName));
    }

    private PropertyChangedEventHandler GetPropertyChangedHandler(object instance)
    {
        Type type = instance.GetType().GetEvent("PropertyChanged").DeclaringType;
        FieldInfo propertyChanged = type.GetField("PropertyChanged",
                                                  BindingFlags.Instance | BindingFlags.NonPublic);
        if (propertyChanged != null)
            return propertyChanged.GetValue(instance) as PropertyChangedEventHandler;

        return null;
    }
}

请注意，您的类仍然需要实现 INotifyPropertyChanged接口。您只是不必在属性设置器中显式引发该事件。

Answer 2

尝试一下http://code.google.com/p/notifypropertyweaver/

全部你需要做的是实现INotifyPropertyChanged

所以你的代码看起来像

public MainFormViewModel : INotifyPropertyChanged
{
    public String StatusText {get; set;}

    #region INotifyPropertyChanged Implementation
}

构建任务将编译这个（你永远不会看到下面的代码）

public MainFormViewModel : INotifyPropertyChanged
{
    public String StatusText {get; set;}
    private string statusText;

    public string StatusText 
    {
       get { return statusText; }
       set
       {
           if (value!= statusText)
           {
               statusText = value;
               OnPropertyChanged("StatusText");
           }
       }
    }

    #region INotifyPropertyChanged Implementation
}

Answer 3

通过利用EqualityComparer.Default，您可以减少属性setter 代码缩减为一行，如下所示：

private int unitsInStock;
public int UnitsInStock 
{
  get { return unitsInStock; }
  set { SetProperty(ref unitsInStock, value, "UnitsInStock"); }
}

public event PropertyChangedEventHandler PropertyChanged;

protected void SetProperty<T>(ref T field, T value, string name) 
{
  if (!EqualityComparer<T>.Default.Equals(field, value)) 
  {
    field = value;
    var handler = PropertyChanged;
    if (handler != null) 
    {
      handler(this, new PropertyChangedEventArgs(name));
    }
  }
}

如果您的视图模型继承自定义 SetProperty 方法和 PropertyChanged 事件的基类，则支持所需的代码量子视图模型中的 INotifyPropertyChanged 变得非常小（1 行）。

这种方法比其他答案中提到的代码编织方法更详细，但不需要您修改构建过程来完成它。

请务必查看即将发布的 C# 5 调用者信息属性 以及看起来它们将允许我们避免在方法中使用魔术字符串，而不需要反射的性能成本。

更新（2012 年 3 月 1 日）：.

NET 4.5 Beta 已经发布，有了它，您可以进一步细化上述代码，从而消除了调用者中对字符串文字的需要：

private int unitsInStock;
public int UnitsInStock
{
    get { return unitsInStock; }
    set 
    { 
        SetProperty(ref unitsInStock, value);
    }
}

public event PropertyChangedEventHandler PropertyChanged;

private void SetProperty<T>(ref T field, T value, [CallerMemberName] string name = "")
{
    if (!EqualityComparer<T>.Default.Equals(field, value))
    {
        field = value;
        var handler = PropertyChanged;
        if (handler != null)
        {
          handler(this, new PropertyChangedEventArgs(name));
        }
    }
}

我有一个 博客文章 对此进行了更详细的讨论。

Answer 4

我一直喜欢这种方法

private string m_myString;
public string MyString
{
    get { return m_myString; }
    set 
    {
        if (m_myString != value)
        {
             m_myString = value;
             NotifyPropertyChanged("MyString");
        }
    }
}


private void NotifyPropertyChanged(string property)
{
    if (PropertyChanged != null)
         PropertyChanged(this, new PropertyChangedEventArgs(property));
}

或者减少代码膨胀

set 
{
    m_myString = value;
    NotifyPropertyChanged("MyString");
}

Answer 5

我有一个名为“Model”的基类。它公开了一个名为 DataPoints 的受保护对象，它本质上是一个字典。

C#

public String StatusText {
    get { 
        return (string)DataPoints["StatusText"]; 
    } 
    set { 
        DataPoints["StatusText"] = value; 
    }
}

VB

public Property StatusText as String 
    get 
        return DataPoints!StatusText 
    end get 
    set
        DataPoints!StatusText = value
    end set
end property

当您在 DataPoints 字典中设置值时，它会执行以下操作：

1. 检查以确保值实际更改。
2. 保存新值
3. 将 IsDirty 属性设置为 true。
4. 引发指定属性以及 IsDirty 和 IsValid 属性的 Property Changed 事件。

由于它是字典，因此它还使得从数据库或 XML 文件加载对象变得非常容易。

现在您可能认为读取和写入字典的成本很高，但我一直在进行大量性能测试，并且在我的 WPF 应用程序中没有发现这有任何明显的影响。

Answer 6

PropertyChanged.Fody NuGet 包执行此操作。

https://github.com/Fody/PropertyChanged

• 添加 PropertyChanged.Fody打包到您的项目中。
• 在模型中引用 PropertyChanged：using PropertyChanged;
• 将 [ImplementPropertyChanged] 属性添加到您的类中。

类中的所有属性现在都将神奇地实现 INotifyPropertyChanged。注意 - Fody 通过修改发出的 IL 来工作，因此您永远不会在 VS 中实际看到代码 - 它只是神奇地做到了这一点。

附加文档：
https://github.com/Fody/PropertyChanged/wiki/Attributes