使Web API IModelBinder适用于该类型的所有实例

时间:2014-10-01 03:16:17

标签: c# model-binding asp.net-web-api2 imodelbinder

我使用自定义IModelBinder尝试将字符串转换为NodaTime LocalDates。我的LocalDateBinder看起来像这样:

public class LocalDateBinder : IModelBinder
{
    private readonly LocalDatePattern _localDatePattern = LocalDatePattern.IsoPattern;

    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        if (bindingContext.ModelType != typeof(LocalDate))
            return false;

        var val = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
        if (val == null)
            return false;

        var rawValue = val.RawValue as string;

        var result = _localDatePattern.Parse(rawValue);
        if (result.Success)
            bindingContext.Model = result.Value;

        return result.Success;
    }
}

在我的WebApiConfig中,我使用SimpleModelBinderProvider注册了这个模型绑定器,一个

var provider = new SimpleModelBinderProvider(typeof(LocalDate), new LocalDateBinder());
config.Services.Insert(typeof(ModelBinderProvider), 0, provider);

当我有一个采用LocalDate类型的参数的动作时,这很有用,但是如果我有一个更复杂的动作在另一个模型中使用LocalDate,它永远不会被触发。例如:

[HttpGet]
[Route("validateDates")]
public async Task<IHttpActionResult> ValidateDates(string userName, [FromUri] LocalDate beginDate, [FromUri] LocalDate endDate)
{
     //works fine
}

[HttpPost]
[Route("")]
public async Task<IHttpActionResult> Create(CreateRequest createRequest)
{
     //doesn't bind LocalDate properties inside createRequest (other properties are bound correctly)
     //i.e., createRequest.StartDate isn't bound
}

我认为这与我如何使用Web API注册模型绑定器有关,但我不知道我需要纠正什么 - 我需要一个自定义绑定器提供程序吗?

1 个答案:

答案 0 :(得分:2)

您的CreateRequest是一种复杂类型,没有定义模型绑定器的类型转换器。在这种情况下,Web Api将尝试使用媒体类型格式化程序。当您使用JSON时,它将尝试使用默认的JSON格式化程序,即标准配置中的Newtonsoft Json.Net。 Json.Net不知道如何处理开箱即用的Noda Time类型。

为了让Json.Net能够处理Noda Time类型,您应该安装NodaTime.Serialization.JsonNet并在启动代码中添加类似的内容......

public void Config(IAppBuilder app)
{
    var config = new HttpConfiguration();
    config.Formatters.JsonFormatter.SerializerSettings.ConfigureForNodaTime(DateTimeZoneProviders.Tzdb);
    app.UseWebApi(config);
}

在此之后,您的第二个示例将按预期工作,如果输入的格式不正确Noda Time,则ModelState.IsValid将为false

有关Web API中参数绑定的更多信息,请参阅http://www.asp.net/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api