MVVM - 从模型到视图模型,保持模型不变
MVVM - From Model to ViewModel leaving Model untouched
假设我有一个代表我的模型的第三方后端 [C# .NET Standard] 库;该库纯粹用作数据处理后端工具。
显然没有 GUI,只提供了一些 public 只读寄存器,以允许其他 parent/owning 代码观察这些寄存器的状态。举个简单的例子:
public class MyModel
{
public int MyVariable { get; private set; }
public List<int> MyCollection { get; private set; }
...
}
现在我想提供一个 WPF 应用程序作为 view-panel/dashboard 以便用户可以在监视器上看到实时情况;我选择了 MVVM 方法。
第一个问题是:假定 Model 应该保持不变而不使其适应 ViewModel 是否是一种正确的设计方法(忘记 Model 是第三方库,我实际上并没有这样做)具有)?我怎样才能高效且正确地编写 ViewModel,以便它可以 extract/retrieve 那些来自 Model 的寄存器?
我经历了一个基于时间的更新选项(每秒从模型中重新读取这些寄存器),老实说这似乎有点低效;我不知道如何从 ViewModel 端拦截模型变量更改或模型集合更改。
然后,让我们暂时放下我没有库代码的限制,考虑我可以修改模型(再说一次,它是正确的设计吗?)。我会让 MyModel
实现 INotifyPropertyChanged
并将 List<int> MyCollection
更改为 ObservableCollection<int> MyCollection
以便我可以拦截数据更改并绑定到屏幕上的更新。但是当 CollectionChanged
事件被触发时,我陷入了 Dispatcher
问题。 由于模型无法访问 Dispatcher (.NET Standard),我该如何执行集合更新?如何抑制模型触发的 CollectionChanged 并从 Dispatcher 中的 ViewModel 触发它?
我已经完成了 Dispatcher
转发解决方案,但我再次认为这是错误的,编码不正确:
public delegate void DispatcherService(Action action);
public class MyModel
{
public int MyVariable { get; private set; }
public List<int> MyList { get; private set; }
public event DispatcherService MyDispatcherService;
public void AddElementToMyList(int element)
{
MyDispatcherService?.Invoke(() => MyList.Add(element));
}
}
public class MyViewModel
{
private MyModel _myModel;
public int MyModelMyVariable { get { return _myModel.MyVariable; } }
public List<int> MyModelMyCollection { get { return _myModel.MyCollection; } }
public MyViewModel(MyModel myModel)
{
_myModel = myModel;
_myModel.MyDispatcherService += ((action) => { Application.Current.Dispatcher.Invoke(action); });
}
}
您的模型完全可以成为一些库对象的包装器。在一个完美的世界中,这些库对象会 full-featured 以致于它们将支持诸如 INotifyPropertyChanged
之类的观察模式。然后它们可以用于各种上下文,例如直接作为您的 MVVM 的模型。在您的情况下,由于库对象不支持可观察性,因此创建提供该可观察性的包装器 类 可能对您有意义。否则,您最终会在 view-model 中对此进行补偿(这也是完全可以接受的,尽管我希望我的范围在定义架构边界时非常干净)。
至于调度程序,我的直觉是模型不应表现出任何线程亲和性——如果某个线程更新了模型,则通知会在同一线程上发出。由于视图本质上是 thread-bound,因此封送通知的责任要么在 view-model 中,要么直接在视图中。当然,您始终可以编组更新模型的调用,以便通知仅发生在 UI 线程上。
通常您的模型 类 不需要实现 INotifyPropertyChaged
和 INotifyCollectionChanged
。这是旨在由视图模型 类 实现的接口,用于为视图提供非常通用的通知。该模型应公开专门的事件以通知视图模型有关数据更改。
由于库是第 3 方,您只能按照 API 允许的方式使用它。当库公开动态数据时,它很可能会公开您的视图模型可以订阅的相关事件。
否则,您的视图模型将不得不轮询库以获取数据更改(在这种情况下,您可能会寻找更严肃的替代库)。
在 MVVM 中,模型永远不会处理任何 Dispatcher
。 Dispatcher
是一个 UI 相关的概念。它处理 UI 对象 (DispatcherObject
) 的 UI 线程关联。它还负责管理UI线程的作业队列。
模型组件既没有 UI 相关对象,也不依赖于 UI 或 UI 线程。
在您描述的场景中,正确的方法是从您的视图模型订阅模型事件。然后填充一个 ObservableCollection
,视图模型将其公开给视图以进行数据绑定。
根据 MVVM,模型从不访问视图模型。因此,只有视图模型必须对 CollectionChanged
事件进行编组或对与 UI 线程关联的对象进行任何其他访问(例如,如果访问发生在与 UI 线程不同的线程)。
您更正后的示例可能如下所示:
public class MyModel
{
public int Property { get; private set; }
public List<int> DataCollection { get; private set; }
public event EventHandler DataIsReady;
public void AddElementToDataCollectionOnBackgroundThread(int element)
{
Task.Run(()
{
this.DataCollection.Add(element);
DataIsReady?.Invoke(this, EventArgs.Empty);
}
}
}
public class MyViewModel : INotifyPropertyChanegd
{
private MyModel Model { get; };
private int viewModelProperty;
public int ViewModelProperty
{
get => return this.viewModelProperty;
set
{
this.viewModelProperty = value;
OnPropertyChanged();
}
}
public ObservaleCollection<int> ViewItemsSource { get }
public MyViewModel(MyModel model)
{
this.Model = model;
this.Model.DataIsReady += OnModelDataIsReady;
}
private void OnModelDataIsReady(object sender, EventArgs e)
{
// Since the event was raised on a background thread,
// the view model is responsible to marshal the collection change to the UI thread
Application.Current.Dispatcher.InvokeAsync(
() =>
{
this.ViewItemsSource.Clear();
this.Model.DataCollection.ForEach(this.ViewItemsSource.Add));
});
// PropertyChanged is automatically marshalled
// to the UI thread by the framework --> no dispatcher needed
this.ViewModelProperty = this.Model.Property;
}
}
假设我有一个代表我的模型的第三方后端 [C# .NET Standard] 库;该库纯粹用作数据处理后端工具。 显然没有 GUI,只提供了一些 public 只读寄存器,以允许其他 parent/owning 代码观察这些寄存器的状态。举个简单的例子:
public class MyModel
{
public int MyVariable { get; private set; }
public List<int> MyCollection { get; private set; }
...
}
现在我想提供一个 WPF 应用程序作为 view-panel/dashboard 以便用户可以在监视器上看到实时情况;我选择了 MVVM 方法。
第一个问题是:假定 Model 应该保持不变而不使其适应 ViewModel 是否是一种正确的设计方法(忘记 Model 是第三方库,我实际上并没有这样做)具有)?我怎样才能高效且正确地编写 ViewModel,以便它可以 extract/retrieve 那些来自 Model 的寄存器? 我经历了一个基于时间的更新选项(每秒从模型中重新读取这些寄存器),老实说这似乎有点低效;我不知道如何从 ViewModel 端拦截模型变量更改或模型集合更改。
然后,让我们暂时放下我没有库代码的限制,考虑我可以修改模型(再说一次,它是正确的设计吗?)。我会让 MyModel
实现 INotifyPropertyChanged
并将 List<int> MyCollection
更改为 ObservableCollection<int> MyCollection
以便我可以拦截数据更改并绑定到屏幕上的更新。但是当 CollectionChanged
事件被触发时,我陷入了 Dispatcher
问题。 由于模型无法访问 Dispatcher (.NET Standard),我该如何执行集合更新?如何抑制模型触发的 CollectionChanged 并从 Dispatcher 中的 ViewModel 触发它?
我已经完成了 Dispatcher
转发解决方案,但我再次认为这是错误的,编码不正确:
public delegate void DispatcherService(Action action);
public class MyModel
{
public int MyVariable { get; private set; }
public List<int> MyList { get; private set; }
public event DispatcherService MyDispatcherService;
public void AddElementToMyList(int element)
{
MyDispatcherService?.Invoke(() => MyList.Add(element));
}
}
public class MyViewModel
{
private MyModel _myModel;
public int MyModelMyVariable { get { return _myModel.MyVariable; } }
public List<int> MyModelMyCollection { get { return _myModel.MyCollection; } }
public MyViewModel(MyModel myModel)
{
_myModel = myModel;
_myModel.MyDispatcherService += ((action) => { Application.Current.Dispatcher.Invoke(action); });
}
}
您的模型完全可以成为一些库对象的包装器。在一个完美的世界中,这些库对象会 full-featured 以致于它们将支持诸如 INotifyPropertyChanged
之类的观察模式。然后它们可以用于各种上下文,例如直接作为您的 MVVM 的模型。在您的情况下,由于库对象不支持可观察性,因此创建提供该可观察性的包装器 类 可能对您有意义。否则,您最终会在 view-model 中对此进行补偿(这也是完全可以接受的,尽管我希望我的范围在定义架构边界时非常干净)。
至于调度程序,我的直觉是模型不应表现出任何线程亲和性——如果某个线程更新了模型,则通知会在同一线程上发出。由于视图本质上是 thread-bound,因此封送通知的责任要么在 view-model 中,要么直接在视图中。当然,您始终可以编组更新模型的调用,以便通知仅发生在 UI 线程上。
通常您的模型 类 不需要实现 INotifyPropertyChaged
和 INotifyCollectionChanged
。这是旨在由视图模型 类 实现的接口,用于为视图提供非常通用的通知。该模型应公开专门的事件以通知视图模型有关数据更改。
由于库是第 3 方,您只能按照 API 允许的方式使用它。当库公开动态数据时,它很可能会公开您的视图模型可以订阅的相关事件。
否则,您的视图模型将不得不轮询库以获取数据更改(在这种情况下,您可能会寻找更严肃的替代库)。
在 MVVM 中,模型永远不会处理任何 Dispatcher
。 Dispatcher
是一个 UI 相关的概念。它处理 UI 对象 (DispatcherObject
) 的 UI 线程关联。它还负责管理UI线程的作业队列。
模型组件既没有 UI 相关对象,也不依赖于 UI 或 UI 线程。
在您描述的场景中,正确的方法是从您的视图模型订阅模型事件。然后填充一个 ObservableCollection
,视图模型将其公开给视图以进行数据绑定。
根据 MVVM,模型从不访问视图模型。因此,只有视图模型必须对 CollectionChanged
事件进行编组或对与 UI 线程关联的对象进行任何其他访问(例如,如果访问发生在与 UI 线程不同的线程)。
您更正后的示例可能如下所示:
public class MyModel
{
public int Property { get; private set; }
public List<int> DataCollection { get; private set; }
public event EventHandler DataIsReady;
public void AddElementToDataCollectionOnBackgroundThread(int element)
{
Task.Run(()
{
this.DataCollection.Add(element);
DataIsReady?.Invoke(this, EventArgs.Empty);
}
}
}
public class MyViewModel : INotifyPropertyChanegd
{
private MyModel Model { get; };
private int viewModelProperty;
public int ViewModelProperty
{
get => return this.viewModelProperty;
set
{
this.viewModelProperty = value;
OnPropertyChanged();
}
}
public ObservaleCollection<int> ViewItemsSource { get }
public MyViewModel(MyModel model)
{
this.Model = model;
this.Model.DataIsReady += OnModelDataIsReady;
}
private void OnModelDataIsReady(object sender, EventArgs e)
{
// Since the event was raised on a background thread,
// the view model is responsible to marshal the collection change to the UI thread
Application.Current.Dispatcher.InvokeAsync(
() =>
{
this.ViewItemsSource.Clear();
this.Model.DataCollection.ForEach(this.ViewItemsSource.Add));
});
// PropertyChanged is automatically marshalled
// to the UI thread by the framework --> no dispatcher needed
this.ViewModelProperty = this.Model.Property;
}
}