ModelState.IsValid ist falsch, wenn ich einen nullbaren Parameter habe

Question

Ich reproduzierte das Problem, das ich in einem brandneuen MVC Web API-Projekt habe.

Dies ist der Standardcode mit einer leichten Änderung.

public string Get(int? id, int? something = null) 
{ 
    var isValid = ModelState.IsValid; 
    return "value"; 
} 

Wenn Sie http://localhost/api/values/5?something=123 gehen dann funktioniert dies gut, und isValid ist true. Wenn Sie zu http://localhost/api/values/5?something= gehen, dann ist isValid false.

Das Problem, das ich habe ist, dass, wenn Sie einen Null oder weggelassen Wert für ein Element bereitzustellen, die NULL-Werte zulässt, die ModelState.IsValid Fahnen ein Fehler Validierung "A value is required but was not present in the request."

Das Model Wörterbuch sieht auch so sagen:

mit zwei Einträgen für something, ein NULL-Werte zulässt, die ich nicht sicher bin, ob es wichtig ist oder nicht.

Eine Idee, wie ich das beheben kann, so dass das Modell gültig ist, wenn NULL-Parameter weggelassen oder als Null bereitgestellt werden? Ich verwende Modellvalidierung innerhalb meiner Web-API und es bricht es, wenn jede Methode mit einem Nullable-Parameter Modellfehler erzeugt.

Answer 1

Es scheint, dass das Standardbindungsmodell NULL-Typen nicht vollständig versteht. Wie in der Frage gezeigt, gibt es drei Parameterfehler statt der erwarteten zwei.

Sie können mit einem benutzerdefinierten Nullable-Modell Bindemittel um dieses zu erhalten:

Modell Binder

public class NullableIntModelBinder : IModelBinder 
{ 
    public bool BindModel(System.Web.Http.Controllers.HttpActionContext actionContext, ModelBindingContext bindingContext) 
    { 
     if (bindingContext.ModelType != typeof(int?)) 
     { 
      return false; 
     } 

     ValueProviderResult val = bindingContext.ValueProvider.GetValue(bindingContext.ModelName); 
     if (val == null) 
     { 
      return false; 
     } 

     string rawvalue = val.RawValue as string; 

     // Not supplied : /test/5 
     if (rawvalue == null) 
     { 
      bindingContext.Model = null; 
      return true; 
     } 

     // Provided but with no value : /test/5?something= 
     if (rawvalue == string.Empty) 
     { 
      bindingContext.Model = null; 
      return true; 
     } 

     // Provided with a value : /test/5?something=1 
     int result; 
     if (int.TryParse(rawvalue, out result)) 
     { 
      bindingContext.Model = result; 
      return true; 
     } 

     bindingContext.ModelState.AddModelError(bindingContext.ModelName, "Cannot convert value to int"); 
     return false; 
    } 
} 

Nutzungs

public ModelStateDictionary Get(
    int? id, 
    [ModelBinder(typeof(NullableIntModelBinder))]int? something = null) 
{ 
    var isValid = ModelState.IsValid; 

    return ModelState; 
} 

von der asp.net Seite Angepasst: http://www.asp.net/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api für das weitere Lesen und eine alternative Methode, um es in der Klasse zu setzen (Kontrolle Ebene) und nicht pro Parameter.

Diese behandelt die drei gültigen Szenarien:

/test/5 
/test/5?something= 
/test/5?something=2 

diese erste give "etwas" als null. Alles andere (zB ?something=x) gibt einen Fehler aus.

Wenn Sie die Signatur zu

ändern

int? somthing 

(dh entfernen = null), dann müssen Sie explizit die Parameter liefern, dh /test/5 wird keine gültige Route sein, wenn Sie auch Ihre Routen optimieren.

Answer 2

Entfernen Sie den Standard-Nullwert aus dem zweiten Parameter. Der Modellbinder setzt es auf null, wenn es etwas anderes als int ist.

Answer 3

Sie müssen ein benutzerdefiniertes Modellbinder für NULL-Typen registrieren, da der Standardbinder den Validator auch für nullwertfähige Parameter aufruft, wobei letzterer diese leeren Werte als ungültig betrachtet.

Das Modell Binder:

public class NullableModelBinder<T> : IModelBinder where T : struct 
{ 
    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext) 
    { 
     var val = bindingContext.ValueProvider.GetValue(bindingContext.ModelName); 

     if (val == null) 
      return false; 

     var rawVal = val.RawValue as string; 

     if (rawVal == null) 
      return false; 

     var converter = TypeDescriptor.GetConverter(typeof(T)); 

     if (converter.IsValid(rawVal)) 
     { 
      bindingContext.Model = converter.ConvertFromString(rawVal); 
      return true; 
     } 

     bindingContext.ValidationNode.SuppressValidation = true; 
     return false; 
    } 
} 

Anmeldung:

public static class WebApiConfig 
{ 
    public static void Register(HttpConfiguration config) 
    { 
     // ... 

     var provider = new SimpleModelBinderProvider(typeof(int?), new NullableModelBinder<int>()); 
     config.Services.Insert(typeof(ModelBinderProvider), 0, provider); 

     // ... 
    } 
}