Thực thi INotifyPropertyChanged tự động thông qua việc tạo mã T4?

Question

Tôi hiện đang làm việc để thiết lập một dự án mới của tôi và tự hỏi làm thế nào tôi có thể đạt được rằng các lớp ViewModel của tôi có hỗ trợ INotifyPropertyChanged trong khi không phải tự tay mã hóa tất cả các thuộc tính.

Tôi đã xem xét các khung công tác AOP nhưng tôi nghĩ rằng chúng sẽ làm nổ tung dự án của tôi với một sự phụ thuộc khác.

Vì vậy, tôi đã nghĩ đến việc tạo các cài đặt thuộc tính với T4.

Thiết lập sẽ là điều này: Tôi có một lớp ViewModel chỉ khai báo biến nền thuộc tính của nó và sau đó tôi sử dụng T4 để tạo ra các triển khai thuộc tính từ nó.

Ví dụ này sẽ là ViewModel của tôi:

public partial class ViewModel 
{ 
    private string p_SomeProperty; 
} 

Sau đó, T4 sẽ đi qua các tập tin nguồn và tìm kiếm khai báo thành viên mang tên "p_" và tạo ra một tập tin như thế này:

public partial class ViewModel 
{ 
    public string SomeProperty 
    { 
     get 
     { 
      return p_SomeProperty; 
     } 
     set 
     { 
      p_SomeProperty= value; 
      NotifyPropertyChanged("SomeProperty"); 
     } 
    } 
} 

Cách tiếp cận này có một số ưu điểm nhưng tôi không chắc liệu nó có thực sự hoạt động hay không. Vì vậy, tôi muốn đăng ý tưởng của tôi ở đây trên StackOverflow như một câu hỏi để có được một số phản hồi về nó và có thể một số lời khuyên làm thế nào nó có thể được thực hiện tốt hơn/dễ dàng hơn/an toàn hơn.

Answer 1

Here's a great post by Colin Eberhardt khi tạo Thuộc tính phụ thuộc từ T4 bằng cách kiểm tra thuộc tính tùy chỉnh trực tiếp từ Visual Studio với EnvDTE. Nó không phải là khó khăn để thích ứng với nó để kiểm tra các lĩnh vực và tạo mã một cách thích hợp kể từ khi bài có chứa phương pháp tiện ích đơn giản để duyệt các nút mã.

Lưu ý rằng khi sử dụng T4 từ VS, bạn không nên sử dụng Reflection trên hội đồng của riêng bạn hoặc họ sẽ bị khóa và bạn sẽ phải khởi động lại Visual Studio để xây dựng lại.

Answer 2

Nó chắc chắn sẽ hoạt động.

tôi khuyên bạn nên đầu tiên viết một lớp cơ sở mà thực hiện INotifyPropertyChanged, cho nó một phương pháp protected void OnPropertyChanged(string propertyName), làm cho nó bộ nhớ cache PropertyChangeEventArgs đối tượng của nó (một cho mỗi tên thuộc tính độc đáo - không có điểm trong việc tạo ra một đối tượng mới mỗi khi sự kiện này được nâng lên), và có lớp T4 tạo ra của bạn xuất phát từ cơ sở này.

Để có được các thành viên cần tính thực hiện, bạn chỉ có thể làm điều gì đó như:

BindingFlags flags = BindingFlags.Instance | BindingFlags.NonPublic; 
FieldInfo[] fieldsNeedingProperties = inputType.GetFields(flags) 
    .Where(f => f.Name.StartsWith("p_")) 
    .ToArray(); 

Và đi từ đó:

<# foreach (var field in fieldsNeedingProperties) { #> 
<# string propertyName = GetPropertyName(field.Name); #> 
    public <#= field.FieldType.FullName #> <#= propertyName #> { 
     get { return <#= field.Name #>; } 
     set { 
      <#= field.Name #> = value; 
      OnPropertyChanged("<#= propertyName #>"); 
     } 
    } 
<# } #> 

<#+ 
    private string GetPropertyName(string fieldName) { 
     return fieldName.Substring(2, fieldName.Length - 2); 
    } 
#> 

Và vân vân.

Answer 3

Có rất nhiều cách để làm da mèo này.

Chúng tôi đã và đang đùa giỡn với PostSharp để nạp bản mẫu soạn sẵn INotifyProperty. Điều đó dường như hoạt động khá tốt.

Điều đó đang được nói, không có lý do gì khiến T4 không hoạt động.

Tôi đồng ý với Dan rằng bạn nên tạo triển khai lớp cơ sở của OnPropertyChanged.

Bạn đã xem xét việc chỉ sử dụng đoạn mã?Nó sẽ viết bản mẫu cho bạn. Nhược điểm duy nhất là nó sẽ không cập nhật tự động nếu bạn muốn thay đổi tên thuộc tính vào một số ngày sau đó.

<?xml version="1.0" encoding="utf-8" ?> 
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet"> 
    <CodeSnippet Format="1.0.0"> 
    <Header> 
     <Title>propin</Title> 
     <Shortcut>propin</Shortcut> 
     <Description>Code snippet for property and backing field with support for INotifyProperty</Description> 
     <SnippetTypes> 
     <SnippetType>Expansion</SnippetType> 
     </SnippetTypes> 
    </Header> 
    <Snippet> 
     <Declarations> 
     <Literal> 
      <ID>type</ID> 
      <ToolTip>Property type</ToolTip> 
      <Default>int</Default> 
     </Literal> 
     <Literal> 
      <ID>property</ID> 
      <ToolTip>Property name</ToolTip> 
      <Default>MyProperty</Default> 
     </Literal> 
     </Declarations> 
     <Code Language="csharp"> 
     <![CDATA[private $type$ _$property$; 

    public $type$ $property$ 
    { 
     get { return _$property$;} 
     set 
    { 
     if (value != _$property$) 
     { 
     _$property$ = value; 
     OnPropertyChanged("$property$"); 
     } 
    } 
    } 
    $end$]]> 
     </Code> 
    </Snippet> 
    </CodeSnippet> 
</CodeSnippets>