Using Data Annotation validation is great. It’s simple. It’s declarative. It’s fine and dandy if all you need to validate is simple, single property rules.
[Required]
public string FirstName {get;set;}
The problem is, we are never that fortunate to only have simple rules like that. Even rules only slightly more complex made me scratch my head at first. For example, take the following rule:
If the address is inside the United States, then State is required.
Simple enough, but how to do it with Data Annotation. Initially I decided not to validate this rule via annotation and did something like the following in my controller action.
var additionalErrors = MyViewData.ValidateAddress(dataFromMyForm);
foreach (var errorInfo in additionalErrors)
{
ModelState.AddModelError(errorInfo.PropertyName, errorInfo.ErrorMessage);
}
That works and all, but it feels really sloppy. Not only does it feel sloppy, but now my model validation lives in two places; the model binder and the controller action. Yuck! And what’s even worse, is I have to consider the model validation in my tests for that controller action.
It would be better to do the validation via a custom validation attribute, but how to do that on the class? First let’s create a custom validation attribute.
public class UsaAddressRequiresStateAttribute : ValidationAttribute
{
public override string FormatErrorMessage(string name)
{
return "State is required.";
}
public override bool IsValid(object value)
{
var address = value as IAddress;
if (address == null) return true;
if (address.Country == "United States")
return !string.IsNullOrEmpty(address.State);
return true;
}
}
Pretty simple right? And don’t worry. We’re not actually using "United States" in our production application. Now, decorate the class with that attribute.
[UsaAddressRequiresState]
public class MyViewData : IAddress {
}
In my particular case, my view data class implements IAddress, which lets me name my view data address fields whatever they want and still expose them to the validator. The limitation with this method is you can only validate one address on each form. There is surely a better way to do this, but I didn’t need to discover it right now.
That’s it. The model binder will now check that validation when binds the model and we’ll see the errors in the model state. if you want the to appear in JavaScript if you do client side validations, I suggest you check you the Phil Haack post about custom validation.
