Skip to main content

MVVM light and Model Validation

I have been using the MVVM light toolkit for a project recently. It is a great toolkit but is missing a couple things and Laurent Bugnion does a good job trying to cover those holes. One of the things the toolkit does not support is Validation. The good news is there is a great CodePlex project out there call Fluent Validation that makes this pretty easy to add and really powerful. My objective was to add validation to my model so I could call “IsValid” on the model itself (similar to the MVC attribute approach). Fluent Validation has you create a new class file that holds you validation rules for a given model. This is the approach I took to enable each model to have an “IsValid” property and a “Errors” property that returns the validation errors.

First I setup my ValidationFactory:

public class ValidatorFactory : FluentValidation.ValidatorFactoryBase
{
    public override FluentValidation.IValidator CreateInstance(Type validatorType)
    {
        return SimpleIoc.Default.GetInstance(validatorType) as FluentValidation.IValidator;
    }
 
}

Next I used the SimpleIoC object that comes with MVVM light to register my validator class in the ViewModelLocator :

// Register Validator
SimpleIoc.Default.Register<IValidator<Car>, CarValidator>();

You can set up your CarValidator pretty easy and follow the examples on the Fluent Validation site so I will not go through all that. The next part was figuring out how to have all my models have the functionality I needed without adding custom code to all my models. I wanted a basemodel class to handle this for all models that are built on top of it. Here is what I came up with.

Create a BaseModel class that all Models will inherit from.

   1: public abstract class ModelBase
   2: {
   3:     private IValidator _validator;
   4:     private IValidator Validator
   5:     {
   6:         get
   7:         {
   8:             if (_validator == null)
   9:             {
  10:                 var valFactory = new ValidatorFactory();
  11:                 _validator = valFactory.GetValidator(this.GetType().UnderlyingSystemType);
  12:             }
  13:             return _validator;
  14:         }
  15:     }
  16:  
  17:     public bool IsValid
  18:     {
  19:         get
  20:         {
  21:             return Validator.Validate(this).IsValid;
  22:         }
  23:     }
  24:  
  25:     public IList<ValidationFailure> ValidationErrors
  26:     {
  27:         get
  28:         {
  29:             return Validator.Validate(this).Errors;
  30:         }
  31:     }
  32: }

The key here is the “Validator” property. This does all the work for all models. Each model will now have an “IsValid” property and a “ValidationErrors” property. These two properties use the private “validator” property to get the type of validator it needs and pass in the object to validate. On line 11 you will see that the ValidationFactory.GetValidator method is called. The base ValidatorFactoryBase does most this work for us. The key here is that on line 11 we use the UnderlyingSystemType of the object. In this case the “Car” class. The factory then uses the SimpeIoC to find the right validator for that class. Now on line 21 and 29 I just call the methods I want on the Validator property. The “Validate” method requires the object to validate to be passed in. This is also easily obstructed by just passing “this” (the current model that is built on top of the ModelBase) into the call.

Just like that I can now do the following in my ViewModel (which holds a property of Car for my new Car model object).

   1: private void SaveCar()
   2: {
   3:     if (this.Car.IsValid)
   4:     {
   5:         _CarProvider.SaveCar(this.Car);
   6:  
   7:         _NavService.NavigateTo(ViewModelLocator.MyProfilePage);
   8:     }
   9:     else
  10:         base.DisplayValidationErrors(this.Car.ValidationErrors);
  11:  
  12: }

On line 3 I simple call “IsValid” on the model I have bound to the view. You could also now wire that up to a commands “CanExecute” method as well. Hats off to the Fluent Validation team, it is a slick module easy to plug into and very powerful.

 

NOTE: If you are curious about the “NavigationService” checkout this blog. It does a great job enabled the standard Windows Phone NavigationService in an MVVM architecture.

Comments

Thats cool:) But what about DisplayValidationErrors() method? I want highlight invalid properties "like ASP MVC". I looking for a solution without adding properties like "IsCustomerNameValid" and setup individual bindings for each property. What is xaml look like in your case?

sorry for my english
KarmaEDV said…
Hi and thank you very much, didn't know Fluent Validation.

To make this post complete you could include the implementation of DisplayValidationErrors from your ModelBase and also how you use it in you controls in the view.

BR KarmaEDV
Unknown said…
That's great! thank you!
But i run into problem when i want to do some extra
validation like check whether attribute is unique.
Before that i was passing collection of objects to validator through
constructor. Any ideas how to solve that?
Anonymous said…
How do you plan on unit testing this? One of the main benefits in decoupling the logic from the presentation by using MVVM is unit test-ability. By coupling your models to a service locator, kind of breaks that entirely.

Would it not be better to inject the validation factory into the view model and couple the validation concerns to that instead of the model?

I like the fluent validation aspect, good library.

Popular posts from this blog

Experience Profile Anonymous, Unknown and Known contacts

When you first get started with Sitecore's experience profile the reporting for contacts can cause a little confusion. There are 3 terms that are thrown around, 1) Anonymous 2) Unknown 3) Known. When you read the docs they can bleed into each other a little.

First, have a read through the Sitecore tracking documentation to get a feel for what Sitecore is trying to do.

There are a couple key things here to first understand:

Unless you call "IdentifyAs()" for request the contact is always anonymous. Tracking of anonymous contacts is off by default. Even if you call "IdentifyAs()" if you don't set facet values for the contact (like first name and email) the contact will still show up in your experience profile as "unknown" (because it has no facet data to display).  Enabled Anonymous contacts


Notice in the picture I have two contacts marked in a red box. Those are my "known" contacts that I called "IdentifyAs" on. I know they say &…

Excel XIRR and C#

I have spend that last couple days trying to figure out how to run and Excel XIRR function in a C# application. This process has been more painful that I thought it would have been when started. To save others (or myself the pain in the future if I have to do it again) I thought I would right a post about this (as post about XIRR in C# have been hard to come by). Lets start with the easy part first. In order to make this call you need to use the Microsoft.Office.Interop.Excel dll. When you use this dll take note of what version of the dll you are using. If you are using a version less then 12 (at the time of this writing 12 was the highest version) you will not have an XIRR function call. This does not mean you cannot still do XIRR though. As of version 12 (a.k.a Office 2007) the XIRR function is a built in function to Excel. Prior version need an add-in to use this function. Even if you have version 12 of the interop though it does not mean you will be able to use the function. The a…

WPF Localization - RESX Option

About a year ago I was building a WPF project in .Net 3.0 and Visual Studio 2005. I wanted to revisit this subject and see what has changed in .Net 3.5 and Visual Studio 2008. I will make a few of these posts to try and cover all the different options (RESX option, LocBaml option, Resource Dictionary Option). In this blog I will focus on using a resx file to localize an application. To show how the resx option is done I created a WPF form with three labels on it. The first label has is text set inline in XAML, the second has it text set via code behind from the resx file and the third has its text set via XAML accessing the resx file. The first thing that needs to happen to setup a project for localization is a small change to the project file. To make this change you will need to open the project file in notepad (or some other generic editor). In the first PropertyGroup section you need to add the follow XML node <UICulture>en-US</UICulture>. So the project file node woul…

Uniting Testing Expression Predicate with Moq

I recently was setting up a repository in a project with an interface on all repositories that took a predicate. As part of this I needed to mock out this call so I could unit test my code. The vast majority of samples out there for mocking an expression predicate just is It.IsAny<> which is not very helpful as it does not test anything other then verify it got a predicate. What if you actually want to test that you got a certain predicate though? It is actually pretty easy to do but not very straight forward.Here is what you do for the It.IsAny<> approach in case someone is looking for that. this.bindingRepository.Setup(c => c.Get(It.IsAny<Expression<Func<UserBinding, bool>>>())) .Returns(new List<UserBinding>() { defaultBinding }.AsQueryable()); This example just says to always return a collection of UserBindings that contain “defaultBinding” (which is an object I setup previously). Here is what it looks like when you want to pass in an expressi…