WPF OnPropertyChanged 不起作用 - C#

如果你正在使用WPF构建应用程序，并且在使用OnPropertyChanged方法来通知UI元素更新时遇到了问题，那么这篇文章就是为你准备的。

什么是 OnPropertyChanged

在WPF中，OnPropertyChanged是一种用来实现数据绑定的方法，当你修改了某个属性的值时，可以通过调用该方法来通知UI元素更新。这个方法一般是在属性的属性访问器(setter)中调用的，具体实现如下：

public class MyViewModel : INotifyPropertyChanged
{
    private string _myProperty;

    public string MyProperty
    {
        get => _myProperty;
        set
        {
            if (_myProperty != value)
            {
                _myProperty = value;
                OnPropertyChanged(nameof(MyProperty));
            }
        }
    }

    public event PropertyChangedEventHandler PropertyChanged;

    protected void OnPropertyChanged(string propertyName)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }
}

在这个例子中，当你修改了MyProperty属性的值时，会触发OnPropertyChanged方法，该方法会通知绑定到MyProperty的UI元素更新。

常见问题

但是，在实际开发中，我们经常会遇到一些问题，比如：

• UI元素不会自动更新
• 绑定的属性不会触发OnPropertyChanged
• 调试时无法进入属性的属性访问器

这些问题通常都是由一些常见的错误导致的，下面我们来逐一讲解解决方法。

UI元素不会自动更新

这个问题比较常见，如果你修改了绑定属性的值，但是UI元素并没有自动更新，那么可能是以下原因导致的：

• 数据上下文(DataContext)未设置正确
• 绑定的属性名拼写错误
• 静态属性未正确实现OnPropertyChanged

你可以按照以下顺序检查：

1. 确认数据上下文(DataContext)设置正确

<Window.DataContext>
    <local:MyViewModel />
</Window.DataContext>

在这个例子中，MyViewModel是你自己的视图模型(ViewModel)，需要将其实例设置为窗口的数据上下文。

2. 确认绑定属性名拼写正确

<TextBlock Text="{Binding MyProperty}" />

在这个例子中，MyProperty是你需要绑定的属性名，需要确保其拼写和大小写完全一致。

3. 确认静态属性正确实现OnPropertyChanged

如果你需要绑定一个静态属性，那么你需要确保其正确实现了OnPropertyChanged。比如：

public static string MyStaticProperty
{
    get => _myStaticProperty;
    set
    {
        if (_myStaticProperty != value)
        {
            _myStaticProperty = value;
            OnPropertyChanged(nameof(MyStaticProperty));
        }
    }
}

private static string _myStaticProperty;

绑定的属性不会触发OnPropertyChanged

如果你修改了绑定的属性的值，但是OnPropertyChanged并没有被调用，那么可能是以下原因导致的：

• 你错误的使用了 backing field
• 继承了一个错误的基类
• 没有调用OnPropertyChanged方法

你可以按照以下顺序检查：

1. 确认 backing field 正确使用

通常情况下，我们都会在属性的getter和setter中使用backing field来存储属性的值。但是，如果你直接修改了backing field的值，是无法触发OnPropertyChanged的。因此，在修改属性的值时，你应该始终通过属性的setter来实现。

private string _myProperty;

public string MyProperty
{
    get => _myProperty;
    set
    {
        if (_myProperty != value)
        {
            _myProperty = value;
            OnPropertyChanged(nameof(MyProperty));
        }
    }
}

private void ModifyMyProperty()
{
    // 错误做法
    _myProperty = "new value";

    // 正确做法
    MyProperty = "new value";
}

2. 确认基类正确

如果你的视图模型类需要实现INotifyPropertyChanged接口，那么你需要确保它是拓展正确的基类。通常情况下，这个基类应该是System.ComponentModel命名空间下的BindableBase类。

public class MyViewModel : BindableBase
{
    // 省略代码...
}

3. 确认调用了OnPropertyChanged方法

当你修改属性的值时，为了确保OnPropertyChanged被调用，你需要在属性的setter中调用其方法。

private string _myProperty;

public string MyProperty
{
    get => _myProperty;
    set
    {
        if (_myProperty != value)
        {
            _myProperty = value;
            OnPropertyChanged(nameof(MyProperty));
        }
    }
}

调试时无法进入属性的属性访问器

当你在调试时发现无法进入属性的属性访问器(setter/getter)，这可能是由于编译器优化造成的。你可以尝试按照以下方法来解决问题：

1. 在属性定义前添加[DebuggerStepThrough]特性

[DebuggerStepThrough]
public string MyProperty
{
    // 省略代码...
}

这个特性会告诉调试器，当你单步执行代码时，无需进入该属性的属性访问器，可以直接跳过。

2. 在项目属性中禁用对属性的优化

如果你无法进入某个属性的属性访问器，你可以在项目属性->生成->高级->在调试时优化代码处勾选或不勾选以解决该问题。

结论

在WPF中使用OnPropertyChanged是实现数据绑定的重要方法之一，但是，在实际开发过程中我们可能会遇到一些问题。这些问题通常都是由一些常见的错误导致的，在检查之后，你应该可以解决它们了。