在 wpf 中快速生成视图模型属性

本文关键字：视图 模型 属性 wpf | 更新日期: 2023-09-27 18:31:27

阅读本文后，我的PersonViewModel类中有以下代码：

public Jurisdiction CountryResidence
{
    get
    {
        return Model.CountryResidence;
    }
    set
    {
        if (Model.CountryResidence == value)
            return;
        else
        {
            Model.CountryResidence = value;
            base.OnPropertyChanged("CountryResidence");
        }
    }
}
public Jurisdiction CountryBirth
{
    get
    {
        return Model.CountryBirth;
    }
    set
    {
        if (Model.CountryBirth == value)
            return;
        else
        {
            Model.CountryBirth = value;
            base.OnPropertyChanged("CountryBirth");
        }
    }
}

我还有CountryDomiciled，CountryPassport和LegalJurisdiction，格式都相同。同样，我有很多String属性，所有这些属性都共享它们的格式。

这会导致大量的 samey 代码！但是，我无法弄清楚如何使其更简洁。

有没有更好的方法来生成这些属性，使它们保持强类型化？

在 wpf 中快速生成视图模型属性

我使用 Visual Studio 的代码片段，它为我生成具有后备存储和事件引发的属性。只需创建名称为propchanged（或其他名称，如果您愿意）和以下内容的 xml 文件：

<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>propchanged</Title>
      <Shortcut>propchanged</Shortcut>
      <Description>Code snippet for property (with call to OnPropertyChanged) and backing field</Description>
      <Author>lazyberezovsky</Author>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
        <Literal>
          <ID>type</ID>
          <ToolTip>Property type</ToolTip>
          <Default>string</Default>
        </Literal>
        <Literal>
          <ID>property</ID>
          <ToolTip>Property name</ToolTip>
          <Default>MyProperty</Default>
        </Literal>
        <Literal>
          <ID>field</ID>
          <ToolTip>The variable backing this property</ToolTip>
          <Default>myVar</Default>
        </Literal>
      </Declarations>
      <Code Language="csharp">
        <![CDATA[private $type$ $field$;
    public $type$ $property$
    {
        get { return $field$;}
        set 
    {
       if ($field$ == value)
          return;
       $field$ = value;
       OnPropertyChanged("$property$");
    }
    }
    $end$]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

并将其放入文件夹C:'Users'YourName'Documents'Visual Studio 2010'Code Snippets'Visual C#'My Code Snippets'.

接下来，我从某个基本视图模型继承我的视图模型，它实现了INotifyPropertyChanged界面并提供受保护的方法OnPropertyChanged以生成"属性更改"事件。 

public class ViewModel : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;
    protected void OnPropertyChanged(string propertyName)
    {
        if (PropertyChanged != null)
            PropertyChanged(this, new PropertyChangedEventArgs(propertyName);
    }
}

现在，当您在 Visual Studio 中键入 propchanged 时，它将询问您输入属性类型和名称，并为您生成代码。

public class PersonViewModel : ViewModel
{
    // type here 'propchanged' (or other shortcut assigned for snippet)
}

更新：

另一种选择是通过像PostSharp这样的AOP框架生成代码。在这种情况下，代码将在编译期间生成和添加（因此您的类将保持干净）。下面是通过 PostSharp 属性更改的实现 INotifyProperty 的示例：

[Notify]
public class PersonViewModel
{
    public Jurisdiction CountryResidence { get; set; }
    public Jurisdiction CountryBirth { get; set; }
}

更新：NotifyPropertyWeaver 已被弃用，并继续作为 PropertyChanged.Fody 存在。这是解决此问题的绝对超酷的方法。这是一个仅编译时的解决方案。

这里有一些东西可以节省你的代码和麻烦：NotifyPropertyWeaver

使用上述方法，您可以在没有任何INotifyPropertyChanged相关代码的情况下实现您的属性，并且构建步骤将为您处理连接。

这是一个简单的项目包含（也可通过Nuget获得），它会自动将OnPropertyChanged回调注入到实现INotifyPropertyChanged的任何类的属性中。 它在编译时执行此操作（因此不会在运行时命中），并且您的代码只能具有自动实现的属性（在您的情况下除外，您使用的是单独的支持对象）。

它

甚至包括值相等性检查，因此它涵盖了完整的逻辑。 我还没有使用手动实现的属性对其进行测试，但值得一试。

编辑：我现在已经测试过它，它工作正常：手动实现的属性将"正常工作"。

不是你要找的，但作为旁白，您可以通过反转逻辑测试为每个属性保存两行：

public Jurisdiction CountryResidence
{
    get
    {
        return Model.CountryResidence;
    }
    set
    {
        if (Model.CountryResidence != value)
        {
            Model.CountryResidence = value;
            base.OnPropertyChanged("CountryResidence");
        }
    }
}
我不知道

有任何内置方法，但您可以录制一个宏来为您生成代码。我发现最简单的方法是开始录制宏，然后仅使用键盘创建您想要的任何内容（您可以在此处找到方便的键盘快捷键列表）

例如，我有一个生成属性的公共版本，所以我只需键入private string _someValue;并点击我的宏，它将生成公共属性以及属性更改通知。

也就是说，请记住，为了简单和方便起见，在 MVVM 中将整个模型公开给视图是完全有效的。因此，您只需为 Model 对象创建单个属性，而不是单独公开模型的每个属性。

public Model SomeModel
{
    get
    {
        return Model;
    }
    set
    {
        if (Model == value)
            return;
        else
        {
            Model= value;
            base.OnPropertyChanged("SomeModel");
        }
    }
}

并绑定到模型的属性，如下所示：

<TextBox Text="{Binding SomeModel.SomeProperty}" />

若要获取对属性名称的"强类型"引用（这是启用重构所必需的），您可以使用表达式。将以下方法（可能放在视图模型的基类中）：

protected void RaisePropertyChanged<T>(Expression<Func<T>> property)
{
    var handler = PropertyChanged;
    if (handler == null) return;
    var propertyName = NotifyPropertyChangedHelper.GetPropertyNameFromExpression(property);
    handler(sender, new PropertyChangedEventArgs(propertyName));
}

然后，在视图模型中，您将能够执行以下操作：

public Jurisdiction CountryResidence
{
    get { return Model.CountryResidence; }
    set 
    {         
        if (Model.CountryResidence == value)
            return;
        Model.CountryResidence = value;
        OnPropertyChanged(() => CountryResidence);
    }
}

现在，重构属性名称会自动选取，因为引用是针对实际属性的。

这解决了硬编码属性名称的痛点，尽管它仍然需要 4-5 行样板代码。面向方面的方法，如notifypropertyweaver和PostSharp，确实消除了视图模型中的所有手动编码。

你没有尝试过使用Visual Studio代码片段，如prop或propfull吗？只需键入它并按两次 Tab 键。问题是propfull代码段不会引发属性更改事件。

但实际上应该有此类任务的第三方片段。这是我发现的： INPC 的属性代码段

相关文章：