CommunityToolkit / CommunityToolkit/dotnet

Proposal: Implement ViewModel proxy generator for POCO entity graph

オープン
#1,069 コメント 0 件 リアクション 2 件 担当者 0 名 GitHub で見る
feature request :mailbox_with_mail:
主要言語
C#
スター
3.8k
フォーク
400
PR マージ指標
30日以内にマージされた PR はありません

説明

### Overview

I wonder if this has been considered before, we often have complex POCO entity graphs which we want to reuse in our XAML app.

It would be so much easier to have ViewModel wrappers generated for the entire entity graph, that includes:

- Inheriting a common `EntityViewModel` base class
- Wrapper properties for scalar values (similar to what's currently generated in `ObservableProperty`)
- Wrapper `ObservableCollection` properties for `ICollection` etc. entity properties (notify parent for collection changes?)
- Wrapper `EntityViewModel` properties for other entity navigations (notify parent?)
- Wrapper `ObservableCollection` for entity-collection navigations (notify parent?)
- Implement `IChangeTracking` / `IRevertibleChangeTracking`?

### API breakdown

*All code is pseudo prototyping on the fly to give a general idea.

```csharp
public abstract class ViewModelProxyBase(Action? parentPropertyChangedAction, Action? parentPropertyChangingAction = default)
: ObservableValidator, INotifyParentPropertyChange;
{
private Action? ParentPropertyChangedAction;
private Action? ParentPropertyChangingAction;
}

public abstract class ViewModelProxyBase(TModel model, Action? parentPropertyChangedAction, Action? parentPropertyChangingAction = default)
: ViewModelProxyBase(parentPropertyChangedAction, parentPropertyChangingAction)
where TModel : class
{
public TModel Model => model;
}

public abstract class ObservableProxyCollectionSimple : ObservableCollection
{
public ObservableProxyCollectionSimple(Action? parentPropertyChangedAction, Action? parentPropertyChangingAction = default)
{
OnCollectionChanged += (sender, e) => parentPropertyChangedAction?.Invoke();
}
}

public abstract class ObservableProxyCollectionComplex : ObservableCollection>
{
private Action? _parentPropertyChangedAction;
private Action? _parentPropertyChangingAction;

public ObservableProxyCollectionSimple(Action? parentPropertyChangedAction, Action? parentPropertyChangingAction = default)
{
_parentPropertyChangedAction = parentPropertyChangedAction;
_parentPropertyChangingAction = parentPropertyChangingAction;
OnCollectionChanged += OnCollectionChanged;
}

private void OnCollectionChanged(...)
{
// removed items - stop tracking
// new items - start tracking
}
}
```

### Usage example

```csharp
public class Entity
{
public int Id { get; set; }
public Reference? Reference { get; set; }
public ICollection { get; set; } = [];
}

public class Reference
{
public string Name { get; set; }
public bool IsEnabled { get; }
}

public partial class EntityViewModel(Entity entity, Action? parentPropertyChangedAction, Action? parentPropertyChangingAction = default)
: ViewModelProxyBase(entity, parentPropertyChangedAction, parentPropertyChangingAction)
{
}

public partial class ReferenceViewModel(Reference reference, Action? parentPropertyChangedAction, Action? parentPropertyChangingAction = default)
: ViewModelProxyBase(reference, parentPropertyChangedAction, parentPropertyChangingAction)
{
}
```

### What's generated:

```csharp
public partial class EntityViewModel(Entity entity, Action? parentPropertyChangedAction, Action? parentPropertyChangingAction = default)
: ViewModelProxyBase(entity, parentPropertyChangedAction, parentPropertyChangingAction)
{
public int Id
{
get => Model.Id;
set
{
if(Equals(Model.Id, value))
return;

OnPropertyChanging();
parentPropertyChangingAction?.Inovke();
Model.Id = value;
OnPropertyChanged();
parentPropertyChangedAction?.Inovke();
}
}

private ReferenceViewModel? _Reference;
public ReferenceViewModel? Reference
{
get
{
if(_Reference == null && Model.Reference != null)
{
_Reference = new ReferenceViewModel(Model.Reference, this);
}

return _Reference;
}
set
{
if(Equals(Model.Reference, value))
return;

OnPropertyChanging();
parentPropertyChangingAction?.Inovke();

if(_Reference != null)
{
_Reference.Parent = null;
}

value.Parent = this;
Model.Reference = value.Model;
OnPropertyChanged();
parentPropertyChangedAction?.Inovke();
}
}

public ObservableCollectionProxyComplex References
{
...
}
}

public partial class ReferenceViewModel(Reference reference, INotifyParent? parent = default)
: ViewModelProxyBase(reference, parent)
{
public string Name
{
get => Model.Name;
set
{
if(Equals(Model.Name, value))
return;

OnPropertyChanging();
Model.Id = value;
OnPropertyChanged();
}
}

public bool IsEnabled => Model.IsEnabled;
}
```

### Breaking change?

No

### Alternatives

Unknown

### Additional context

- Thought has to be given to prevent cyclical change notification.
- Related #1058

### Help us help you

Yes, but only if others can assist

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

No implementation files or tests are named. Start by reviewing the existing ObservableProperty generation and related issue #1058, then clarify the scope, generated API, change-notification behavior, cycle prevention, and what constitutes a complete ViewModel proxy generator.

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp
領域
desktop, frontend
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。