MVC 3 empty query string parameter value is bound as an empty string rather than null

Question

I have the following:

This action:

public virtual ActionResult Search(string search, string sort)
{
...
}

Called from this url with empty query string parameters:

http://myurl.com/mycontroller/search?search=&sort=

Now my understanding was that as of MVC 2 the DefaultModelBinder would leave these values as nulls. However, what I am finding is that they are actually set to empty strings. Is this in fact the expected behavior? Is this documented anywhere?

Thanks

Did you override the default model binder is some way? did you add a custom model binder? — gdoron
– gdoron, Commented Jun 13, 2012 at 21:50

gdoron · Accepted Answer · 2012-06-14 06:33:52Z

6

Yes, The defualt behavior is setting empty strings to null, but it can be overriden with changing ConvertEmptyStringToNull = false;

true if empty strings that are posted back in forms should be converted to null;
otherwise, false. The default value is true.

msdn

like in this code:

public class SimpleArrayModelBinder : DefaultModelBinder 
{
    public override object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext) 
    {
        if (bindingContext.ModelType == typeof(string)) 
        {
            var value = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
            bindingContext.ModelMetadata.ConvertEmptyStringToNull = false;
            if (value == null || value.AttemptedValue.IsNullOrEmpty())
                return "";
            else
                return value.AttemptedValue;
        }
    }
}

One more way to change the deafult behavior is with the ConvertEmptyStringToNull attribute above the properties in your model.

Example:

public class Person
{
    [DisplayFormat(ConvertEmptyStringToNull = false)]
    public string Lastname { get; set; }
    ...
}

Blog

edited Jun 14, 2012 at 6:33

answered Jun 13, 2012 at 20:55

gdoron

151k59 gold badges302 silver badges376 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

tribus Over a year ago

OK I think this is where I'm getting lost. The documentation here msdn.microsoft.com/en-us/library/… says that these empty strings are converted to null. What am I missing?

tribus Over a year ago

I've read this sevarl times but maybe I'm just misinterpreting it. It says "true if empty strings that are posted back in forms should be converted to null;" I read that as passing true (which is the default) will convert empty strings to null, not the other way around.

tribus Over a year ago

I'm seeing that this doesn't apply when your action expects a simple type.

gdoron Over a year ago

@tribus. What do you mwan by "this doesn't apply"?

tribus Over a year ago

The default behavior of setting empty strings to null seems to only apply when the model is a complex type. For simple types the ModelMetadata.ConvertEmptyStringToNull property is never checked.

|

tribus · Accepted Answer · 2012-06-14 12:42:53Z

After looking through the source code for the DefaultModelBinder what I have found is that the ModelMetadata.ConvertEmptyStringToNull property is only ever checked when the model being bound is a complex model. For primative types exposed in an action, the values are retrieved as is. For the example in my original question, this would be an empty string.

From the DefaultModelBinder source

        // Simple model = int, string, etc.; determined by calling TypeConverter.CanConvertFrom(typeof(string))
        // or by seeing if a value in the request exactly matches the name of the model we're binding.
        // Complex type = everything else.
        if (!performedFallback) {
            bool performRequestValidation = ShouldPerformRequestValidation(controllerContext, bindingContext);
            ValueProviderResult vpResult = bindingContext.UnvalidatedValueProvider.GetValue(bindingContext.ModelName, skipValidation: !performRequestValidation);
            if (vpResult != null) {
                return BindSimpleModel(controllerContext, bindingContext, vpResult);
            }
        }
        if (!bindingContext.ModelMetadata.IsComplexType) {
            return null;
        }

        return BindComplexModel(controllerContext, bindingContext);
    }

So as far as I can tell ModelMetadata.ConvertEmptyStringToNull only applies when bindng a complex type.

VJAI · Accepted Answer · 2012-06-14 04:37:49Z

0

ModelMetadata.ConvertEmptyStringToNull this property will affect when binding the values to strings that sits as properties inside a Model.

Ex.

public class Employee
{
   public string First{get;set;}
   public string Last{get;set;}
}

With ModelMetadata.ConvertEmptyStringToNull = true (that is default)

You will see both First and Last as null when the request doesn't contains values for these items.

With ModelMetadata.ConvertEmptyStringToNull = false

The properties will be "" when the request contains those parameters with empty values. If the request doesn't contain the parameter itself then still the value will be null.

answered Jun 14, 2012 at 4:37

VJAI

32.9k23 gold badges108 silver badges166 bronze badges

Collectives™ on Stack Overflow

MVC 3 empty query string parameter value is bound as an empty string rather than null

3 Answers 3

6 Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

6 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related