MVVM: Binding to Model while keeping Model in sync with a server version

by

In the past I ‘ve written an application that supports “live” editing of data objects from multiple locations: many instances of the app can edit the same object at the same time, and when someone pushes changes to the server everyone else gets notified and (in the simplest scenario) sees those changes immediately. Here’s a summary of how it was designed.

Setup

  1. Views always bind to ViewModels. I know it’s a lot of boilerplate, but binding directly to Models is not acceptable in any but the simplest scenarios; it’s also not in the spirit of MVVM.

  2. ViewModels have sole responsibility for pushing changes. This obviously includes pushing changes to the server, but it could also include pushing changes to other components of the application.

    To do this, ViewModels might want to clone the Models they wrap so that they can provide transaction semantics to the rest of the app as they provide to the server (i.e. you can choose when to push changes to the rest of the app, which you cannot do if everyone directly binds to the same Model instance). Isolating changes like this requires still more work, but it also opens up powerful possibilities (e.g. undoing changes is trivial: just don’t push them).

  3. ViewModels have a dependency on some kind of Data Service. The Data Service is an application component that sits between the data store and the consumers and handles all communication between them. Whenever a ViewModel clones its Model it also subscribes to appropriate “data store changed” events that the Data Service exposes.

    This allows ViewModels to be notified of changes to “their” model that other ViewModels have pushed to the data store and react appropriately. With proper abstraction, the data store can also be anything at all (e.g. a WCF service in that specific application).

Workflow

  1. A ViewModel is created and assigned ownership of a Model. It immediately clones the Model and exposes this clone to the View. Having a dependency on the Data Service, it tells the DS that it wants to subscribe to notifications for updates this specific Model. The ViewModel does not know what it is that identifies its Model (the “primary key”), but it doesn’t need to because that’s a responsibility of the DS.

  2. When the user finishes editing they interact with the View which invokes a Command on the VM. The VM then calls into the DS, pushing the changes made to its cloned Model.

  3. The DS persists the changes and additionally raises an event that notifies all other interested VMs that changes to Model X have been made; the new version of the Model is supplied as part of the event arguments.

  4. Other VMs that have been assigned ownership of the same Model now know that external changes have arrived. They can now decide how to update the View having all pieces of the puzzle at hand (the “previous” version of the Model, which was cloned; the “dirty” version, which is the clone; and the “current” version, which was pushed as part of the event arguments).

Notes

  • The Model’s INotifyPropertyChanged is used only by the View; if the ViewModel wants to know whether the Model is “dirty”, it can always compare the clone to the original version (if it has been kept around, which I recommend if possible).
  • The ViewModel pushes changes to the Server atomically, which is good because it ensures that the data store is always in a consistent state. This is a design choice, and if you want to do things differently another design would be more appropriate.
  • The Server can opt to not raise the “Model changed” event for the ViewModel that was responsible for this change if the ViewModel passes this as a parameter to the “push changes” call. Even if it does not, the ViewModel can choose to do nothing if it sees that the “current” version of the Model is identical to its own clone.
  • With enough abstraction, changes can be pushed to other processes running on other machines as easily as they can be pushed to other Views in your shell.

Hope this helps; I can offer more clarification if required.

More Related Contents:

  1. This type of CollectionView does not support changes to its SourceCollection from a thread different from the Dispatcher thread [duplicate]
  2. EF codefirst : Should I initialize navigation properties?
  3. Data binding to SelectedItem in a WPF Treeview
  4. Binding a WPF ComboBox to a custom list
  5. ICommand MVVM implementation
  6. ViewModels in MVC / MVVM / Separation of layers- best practices?
  7. WPF: Binding a ContextMenu to an MVVM Command
  8. Validation Error Style in WPF, similar to Silverlight
  9. How deterministic is floating point inaccuracy?
  10. What’s the best way to pass event to ViewModel?
  11. Persist Data by Programming Against Interface
  12. What is difference between MVC, MVP & MVVM design pattern in terms of coding c#
  13. Entity vs Model vs View Model
  14. Disallow/Block selection of disabled combobox item in wpf
  15. Binding SelectedItems of ListView to ViewModel
  16. Mvvm model ViewModel
  17. DDD Approach to Access External Information
  18. MVVM Sync Collections
  19. One ViewModel for UserControl and Window or separate ViewModels
  20. How to inject Javascript in the WP7 WebBrowser control?
  21. The component does not have a resource identified by the uri
  22. How do I raise an event in a usercontrol and catch it in mainpage?
  23. ScrollIntoView for WPF DataGrid (MVVM)
  24. How to zoom in and zoom out Images in WP7?
  25. Binding Commands to Events?
  26. How to have multiple pairs “View-ViewModel”?
  27. Accessing a property in one ViewModel from another
  28. Add context menu in datagrid, how to get the select Item value
  29. What is the difference between Property and Dependency Property
  30. Is it wrong to use the Dispatcher within my ViewModel?

Leave a Comment