PropertyChanged.Fody 技术文档

本文档旨在帮助用户安装和使用 PropertyChanged.Fody 项目，以及了解其 API 使用方法。

1. 安装指南

用户可以通过 NuGet 包管理器安装 PropertyChanged.Fody。以下是安装步骤：

1. 打开 PowerShell 或命令提示符。
2. 运行以下命令安装 Fody NuGet 包：

Install-Package Fody

3. 运行以下命令安装 PropertyChanged.Fody NuGet 包：

Install-Package PropertyChanged.Fody

4. 在 FodyWeavers.xml 文件中添加以下内容：

<Weavers>
  <PropertyChanged/>
</Weavers>

2. 项目的使用说明

PropertyChanged.Fody 是 Fody 的一个插件，它能够自动为实现了 INotifyPropertyChanged 接口的类注入代码，以在属性设置器中触发 PropertyChanged 事件。

在类中实现 INotifyPropertyChanged 接口之前，您的代码如下：

public class Person : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;
    
    public string GivenNames { get; set; }
    public string FamilyName { get; set; }
    public string FullName => $"{GivenNames} {FamilyName}";
}

实现后，编译生成的代码会包含属性更改通知的注入：

public class Person : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;

    string givenNames;
    public string GivenNames
    {
        get => givenNames;
        set
        {
            if (value != givenNames)
            {
                givenNames = value;
                OnPropertyChanged(InternalEventArgsCache.GivenNames);
                OnPropertyChanged(InternalEventArgsCache.FullName);
            }
        }
    }

    string familyName;
    public string FamilyName
    {
        get => familyName;
        set 
        {
            if (value != familyName)
            {
                familyName = value;
                OnPropertyChanged(InternalEventArgsCache.FamilyName);
                OnPropertyChanged(InternalEventArgsCache.FullName);
            }
        }
    }

    public string FullName => $"{GivenNames} {FamilyName}";

    protected void OnPropertyChanged(PropertyChangedEventArgs eventArgs)
    {
        PropertyChanged?.Invoke(this, eventArgs);
    }
}

internal static class InternalEventArgsCache
{
    internal static PropertyChangedEventArgs FamilyName = new PropertyChangedEventArgs("FamilyName");
    internal static PropertyChangedEventArgs FullName = new PropertyChangedEventArgs("FullName");
    internal static PropertyChangedEventArgs GivenNames = new PropertyChangedEventArgs("GivenNames");
}

3. 项目 API 使用文档

由于 PropertyChanged.Fody 是一个编译时 Weaver，它的 API 主要用于配置和扩展其功能。以下是一些可用的 API 和特性：

• 自动实现 INotifyPropertyChanged 接口：通过 [AddINotifyPropertyChangedInterface] 特性，可以自动为类添加 INotifyPropertyChanged 接口。
• 属性依赖：使用 [DependsOn] 特性可以指定一个属性依赖于其他属性。
• 通知拦截：可以使用 [OnPropertyChanged] 特性或全局/类级别的拦截来拦截属性更改通知。

4. 项目安装方式

如前所述，项目安装方式主要通过 NuGet 包管理器进行。具体步骤请参考“1. 安装指南”。

本文档介绍了 PropertyChanged.Fody 的安装方法、使用说明以及 API 使用方法，旨在帮助用户更好地使用这个强大的 Fody 插件。