在发布 x-www-form-urlencoded 数据时，我很难让自定义模型绑定(bind)正常工作。我已经尝试了所有我能想到的方法，但似乎没有任何方法产生预期的结果。请注意，在发布 JSON 数据时，我的 JsonConverters 等都可以正常工作。当我作为 x-www-form-urlencoded 发布时，系统似乎无法弄清楚如何绑定(bind)我的模型。

我的测试用例是我想绑定(bind)一个 TimeZoneInfo 对象作为我模型的一部分。

这是我的模型 Binder :

public class TimeZoneModelBinder : SystemizerModelBinder
{
    protected override object BindModel(string attemptedValue, Action<string> addModelError)
    {
        try
        {
            return TimeZoneInfo.FindSystemTimeZoneById(attemptedValue);
        }
        catch(TimeZoneNotFoundException)
        {
            addModelError("The value was not a valid time zone ID. See the GetSupportedTimeZones Api call for a list of valid time zone IDs.");
            return null;
        }
    }
}

这是我正在使用的基类:

public abstract class SystemizerModelBinder : IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        var name = GetModelName(bindingContext.ModelName);
        var valueProviderResult = bindingContext.ValueProvider.GetValue(name);
        if(valueProviderResult == null || string.IsNullOrWhiteSpace(valueProviderResult.AttemptedValue))
            return false;

        var success = true;
        var value = BindModel(valueProviderResult.AttemptedValue, s =>
        {
            success = false;
            bindingContext.ModelState.AddModelError(name, s);
        });
        bindingContext.Model = value;
        bindingContext.ModelState.SetModelValue(name, new System.Web.Http.ValueProviders.ValueProviderResult(value, valueProviderResult.AttemptedValue, valueProviderResult.Culture));
        return success;
    }

    private string GetModelName(string name)
    {
        var n = name.LastIndexOf(".", StringComparison.Ordinal);
        return n < 0 || n >= name.Length - 1 ? name : name.Substring(n + 1);
    }

    protected abstract object BindModel(string attemptedValue, Action<string> addModelError);
}

我使用这样的基类来简化创建其他自定义模型绑定(bind)器的过程。

这是我的模型 Binder 提供程序。请注意，这是从我的 IoC 容器中正确调用的，因此我不会费心展示我的代码的这方面。

public class SystemizerModelBinderProvider : ModelBinderProvider
{
    public override IModelBinder GetBinder(HttpConfiguration configuration, Type modelType)
    {
        if(modelType == typeof(TimeZoneInfo))
            return new TimeZoneModelBinder();

        return null;
    }
}

最后，这是 Action 方法和模型类:

[DataContract)]
public class TestModel
{
    [DataMember]
    public TimeZoneInfo TimeZone { get; set; }
}

[HttpPost]
public HttpResponseMessage Test(TestModel model)
{
    return Request.CreateResponse(HttpStatusCode.OK, model);
}

对于action方法，我试过:

public HttpResponseMessage Test([FromBody] TestModel model)

这会调用 FormUrlEncodedMediaFormatter，它似乎完全忽略了我的自定义模型 Binder 。

public HttpResponseMessage Test([ModelBinder] TestModel model)

正如预期的那样，这调用了我的自定义模型绑定(bind)器，但随后它只为 RouteData 和 QueryString 提供了 ValueProviders，并且出于某种原因没有为正文内容提供任何内容.见下文:

我还尝试用 ModelBinder(typeof(SystemizerModelBinderProvider)) 装饰类本身

为什么模型绑定(bind)只在我使用 [ModelBinder] 属性时发生，为什么它只尝试读取路由和查询字符串值并忽略正文内容？为什么 FromBody 忽略我的自定义模型 Binder 提供程序？

如何创建一个场景，我可以接收 POSTED x-www-form-urlencoded 数据并使用自定义逻辑成功绑定(bind)模型属性？

最佳答案

我建议您阅读 following blog post其中 Mike Stall 详细解释了模型绑定(bind)如何在 Web API 中工作:

There are 2 techniques for binding parameters: Model Binding and Formatters. In practice, WebAPI uses model binding to read from the query string and Formatters to read from the body.

Here are the basic rules to determine whether a parameter is read with model binding or a formatter:

1. If the parameter has no attribute on it, then the decision is made purely on the parameter’s .NET type. "Simple types" uses model binding. Complex types uses the formatters. A "simple type" includes: primitives, TimeSpan, DateTime, Guid, Decimal, String, or something with a TypeConverter that converts from strings.
2. You can use a [FromBody] attribute to specify that a parameter should be read from the body.
3. You can use a [ModelBinder] attribute on the parameter or the parameter’s type to specify that a parameter should be model bound. This attribute also lets you configure the model binder. [FromUri] is a derived instance of [ModelBinder] that specifically configures a model binder to only look in the URI.
4. The body can only be read once. So if you have 2 complex types in the signature, at least one of them must have a [ModelBinder] attribute on it.

因此，如果您的数据源是请求主体，那么您可以创建自定义 MediaTypeFormatter 而不是模型绑定(bind)器。

关于c# - ASP.Net Web API 自定义模型与 x-www-form-urlencoded 发布数据绑定(bind) - 似乎没有任何效果，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/14848308/