WPF插件之 - PropertyChanged.Fody使用详解

总目录

---

---

一、PropertyChanged.Fody是什么？

• PropertyChanged.Fody 主要是实现了INotifyPropertyChanged 接口的，然后通过特性对外提供相关属性通知功能。
• 引用该插件能够使我们属性通知的代码更为简洁。
• 源码：https://github.com/Fody/PropertyChanged

如在阅读本文后，后续遇到文中没有提及的问题或知识点，可以查看源码说明文档

二、PropertyChanged.Fody的安装

1.首先添加PropertyChanged.Fody的Nuget程序包

如果通过程序包管理器控制台安装，则如下操作

• 先调出控制台，然后根据需求修改程序包源和需要安装程序包的项目
  
• 输入程序包的安装命令，即可完成程序包的安装

PM> Install-Package Fody
PM> Install-Package PropertyChanged.Fody

2.再者添加FodyWeavers.xml 文件

一般安装完PropertyChanged.Fody程序包后，会自动创建FodyWeavers.xml 文件；如果没有自动创建FodyWeavers.xml 文件，此时我们可以重新生成项目，然后项目生成时会自动在项目根目录下创建FodyWeavers.xml 文件，此时还没有包括在项目中，我们需要先显示所有文件，然后将FodyWeavers.xml 文件包含在项目中即可。如果以上操作均没有生成FodyWeavers.xml 文件，则自行在项目中创建FodyWeavers.xml 文件，然后在文件中，配置如下代码：

<Weavers>
  <PropertyChanged/>
</Weavers>

三、PropertyChanged.Fody的功能

当我们介绍完安装完程序包后，下面就需介绍如何使用该程序包中提供的功能。

1. 特性

PropertyChanged.Fody的核心功能就是提供了一系列的特性供我们使用，通过给属性和类上标注特性，是我们的代码更加的简洁

1 实现属性通知的功能

通常我们自己手动实现INotifyPropertyChanged接口后，会需要将我们自己的ViewModel继承自实现类，然后在属性中调用方法来实现属性通知。如下示例中，ViewModelBase为自行实现INotifyPropertyChanged接口的实现类：

    public class MainViewModel:ViewModelBase
    {
        private double _num;
        public double Num
        {
            get { return _num; }
            set { _num = value; OnPropertyChanged(); }
        }
    }

当我们使用了PropertyChanged.Fody插件后，可通过以下方式来实现一样的功能

• 方式1：直接将ViewModel的类继承自INotifyPropertyChanged类，所有实现INotifyPropertyChanged的类都将向属性设置器注入通知代码
• 方式2：在ViewModel的类上添加AddINotifyPropertyChangedInterface特性，旧版是添加ImplementPropertyChanged 特性，但该特性已弃用

方式1 示例代码：

    public class MainViewModel : INotifyPropertyChanged
    {
        public double Num { get; set; }

        public event PropertyChangedEventHandler PropertyChanged;
    }

方式2示例代码：

    [AddINotifyPropertyChangedInterface]
    public class MainViewModel
    {
        public double Num { get; set; }
    }

以上两种方式作用是一样的，都可以实现属性通知，并且还可以使我们属性通知的代码量大大的减少，编码界面更为简洁清晰。

通过下图了解一下通过以上方式，实现属性通知后的反编译代码

下面我们通过一个完整的案例了解一下具体的使用，案例中实现Num1+Num2=Total：

反编译后的代码：

通过以上案例我们知道：

• 当我们在添加AddINotifyPropertyChangedInterface特性的类中，A属性引用了B和C属性，那么B和C属性代码中就会插入通知A属性更新的代码；如上面的案例中，Total属性中引用了Num1和Num2，反编译后Num1和Num2的属性访问器中就会添加<>OnPropertyChanged(<>PropertyChangedEventArgs.Total); 这样的一句代码，表示Num1和Num2属性更新后，不仅会通知自身，还会通知Total。
• 当属性中有了业务逻辑代码，则不会插入属性更新的代码，如上案例Total属性的get访问器中有了业务代码，那么Total将不具有属性更新通知的功能

注意：只有在类上标注AddINotifyPropertyChangedInterface特性或者实现INotifyPropertyChanged接口后，PropertyChanged.Fody中其他的特性才能生效，否则其他特性单独使用是无效的。

2 通知其他属性

通过AlsoNotifyFor特性，我们可以实现在通知自身属性的时候，通知其他的属性进行更新；
实现原理：也仅仅是使用了该特性后，set访问器中会自动插入对应属性的属性通知代码

通过下图的源代码和反编译代码对比图可以加以佐证：
另外建议使用nameof去配置需要 另外通知的属性名，不容易出现低级错误；再者可以通过逗号配置多个需要另外通知的属性。

    [AddINotifyPropertyChangedInterface]
    public class MainViewModel
    {
        [AlsoNotifyFor(nameof(Total),nameof(Num2))]
        public double Num1 { get; set; }
        public double Num2 { get; set; }
        public double Total { get; set; }
    }

4 不进行属性通知

如果ViewModel中的某一些属性，我们并不希望其具有属性通知的功能，可以使用DoNotNotify特性。

    [AddINotifyPropertyChangedInterface]
    public class MainViewModel
    {
        [DoNotNotify]
        public double Num1 { get; set; }
        public double Num2 { get; set; }
        public double Total { get; set; }
    }

3 指定属性更改时将调用的方法

默认情况下：如果有一个属性为Num，有一个方法为 OnNumChanged方法，那么在Num属性值更新的时候，就会执行OnNumChanged方法，只要是方法符合以上命名规则，就会自动生成调用代码。

    [AddINotifyPropertyChangedInterface]
    public class MainViewModel
    {
    	//在Num1更新时，自动调用OnNum1Changed方法
        public double Num1 { get; set; }
        public double Num2 { get; set; }

        public double Total { get; set; }

        private void OnNum1Changed()
        {
            Total = Num1 + Num2;
        }
    }

但是，如果我们向明确的指定属性更改时需要调用的方法，则需通过OnChangedMethod特性。

通过下图了解OnChangedMethod特性的原理，原理很简单就是在set访问器中调用特性中配置的方法。

    [AddINotifyPropertyChangedInterface]
    public class MainViewModel
    {
        [OnChangedMethod(nameof(OnNumChanged))]
        public double Num1 { get; set; }

        [OnChangedMethod(nameof(OnNumChanged))]
        public double Num2 { get; set; }
        public double Total { get; set; }

        private void OnNumChanged()
        {
            Total = Num1 + Num2;
        }
    }

以上案例表示当Num1和Num2 更新的时候，就执行OnNumChanged这个方法计算数字和。

5 设置当前属性依赖的属性

我们知道当我们给属性添加了AlsoNotifyFor特性的时候，可以实现在通知自身属性的时候，通知其他的属性进行更新；但是如果多个属性都通过AlsoNotifyFor指向的是同一个属性的时候，逐个添加不免有些麻烦；此时我们就可以使用DependsOn 特性，统一在最终指向的属性上，设置其依赖的属性即可。

    [AddINotifyPropertyChangedInterface]
    public class MainViewModel
    {
        public double Num1 { get; set; }
        public double Num2 { get; set; }

        [DependsOn(nameof(Num1),nameof(Num2))]
        public double Total { get; set; }
    }

6 不检查是否相等

默认情况下，所有属性通知中都会检查属性值是否相等，如果属性值相等，则不会进行通知；原理代码如下：

public string Property1
{
    get
    {
        return property1;
    }
    set
    {
        if (!String.Equals(property1, value))
        {
            property1 = value;
            OnPropertyChanged("Property1");
        }
    }
}

但在某些情况下，我们需要无论是否相等都会进行通知，这个时候，可以在属性上标记DoNotCheckEquality特性以跳过是否相等的检查。

    [AddINotifyPropertyChangedInterface]
    public class MainViewModel
    {
        [DoNotCheckEquality]
        public double Num1 { get; set; }
        public double Num2 { get; set; }
        public double Total { get; set; }

    }

当我们给属性加上DoNotCheckEquality特性的时候，就相当于给去掉了Object.Equals() 这个判断。

7 DoNotSetChangedAttribute

如果在添加了AddINotifyPropertyChangedInterface特性或者实现INotifyPropertyChanged接口的实现类中，有一个属性是IsChanged属性，那么默认情况下，当前类中的所有属性只要发生变化，都会将IsChanged 的属性值设置为True;

public bool IsChanged { get; set; }

如果希望在某个属性变化时，不设置IsChanged的属性值，可以给属性添加DoNotSetChanged特性，如下所示：

    [AddINotifyPropertyChangedInterface]
    public class MainViewModel
    {
        public bool IsChanged { get; set; }
        public double Num1 { get; set; }
        public double Num2 { get; set; }

        [DoNotSetChanged]
        public double Total { get; set; }
    }

2. 配置FodyWeavers.xml文件

1 EventInvokerNames

该配置用于更改激发属性通知事件的方法名称，这是一个以逗号分隔形式接受多个值的字符串。默认值为：

<?xml version="1.0" encoding="utf-8" ?>
<Weavers>
  <PropertyChanged EventInvokerNames="OnPropertyChanged, NotifyOfPropertyChange, RaisePropertyChanged, NotifyPropertyChanged, NotifyChanged"/>
</Weavers>

默认值覆盖了WPF中大多数的MVVM框架对于激发通知事件的方法命名，如Prism和MVVMLight 框架中使用的是RaisePropertyChanged，Caliburn Micro中使用的是NotifyOfPropertyChange。

如果需要指定激发属性通知事件方法的名称，则如下指定即可。（基本是使用默认配置的，因为默认值已经覆盖大多数的框架。）

<?xml version="1.0" encoding="utf-8" ?>
<Weavers>
  <PropertyChanged EventInvokerNames="NotifyPropertyChanged"/>
</Weavers>

2 InjectOnPropertyNameChanged

用于控制是否启用On_PropertyName_Changed功能。默认值为true，启用该功能。

On_PropertyName_Changed 的功能就是：属性更改时执行对应名称的方法（如Num对应的OnNumChanged）以及OnChangedMethod特性所实现的功能

<?xml version="1.0" encoding="utf-8" ?>
<Weavers>
  <PropertyChanged InjectOnPropertyNameChanged='false'/>
</Weavers>

3 CheckForEquality

用于控制是否应创建相等检查。如果为false，将对项目禁用相等检查。默认值为true,创建相等检查

<?xml version="1.0" encoding="utf-8" ?>
<Weavers>
  <PropertyChanged CheckForEquality='false'/>
</Weavers>

---

结语

以上就是本文的内容，希望以上内容可以帮助到您，如文中有不对之处，还请批评指正。