如何接受ISO格式的WebAPI TimeSpan参数

本文关键字：WebAPI TimeSpan 参数 格式 何接受 ISO | 更新日期: 2023-09-27 18:20:07

我最近用Web API构建了一个服务，有一个API需要接受ISO 8601格式的TimeSpan参数（例如PT5M）。

这是我的api控制器：

[RoutePrefix("api")]
public class StatisticsController : ApiController
{
    [Route("statistics")]
    public async Task<IEnumerable<StatPoint>> GetStatistics([FromUri] TimeSpan duration)
    {
        // ...
    }
}

我需要使用类似/api/statistics?duration=PT5M的url访问这个API。

我试着添加一个JsonConverter，就像一些人在网上说的那样：

public class IsoTimeSpanConverter : JsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var ts = (TimeSpan) value;
        var tsString = XmlConvert.ToString(ts);
        serializer.Serialize(writer, tsString);
    }
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue,
        JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
        {
            return null;
        }
        var value = serializer.Deserialize<String>(reader);
        return XmlConvert.ToTimeSpan(value);
    }
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof (TimeSpan) || objectType == typeof (TimeSpan?);
    }
}

在GlobalConfiguration.Configure中（在Application_start()中调用）：

config.Formatters.JsonFormatter.SerializerSettings.Converters.Add(new IsoTimeSpanConverter());

然而，它没有起作用，我总是收到这样的错误消息：

{
    message: "The request is invalid.",
    messageDetail: "The parameters dictionary contains a null entry for parameter 'duration' of non-nullable type 'System.TimeSpan' for method 'System.Threading.Tasks.Task`1[System.Collections.Generic.IEnumerable`1[WebRole.Api.Models.StatPoint]] GetStatistics(System.TimeSpan)' in 'WebRole.Api.StatisticsController'. An optional parameter must be a reference type, a nullable type, or be declared as an optional parameter."
}

感谢您的帮助。

如何接受ISO格式的WebAPI TimeSpan参数

我想我找到了解决方案。我走错了路，因为JsonConverter处理正文序列化，而URL参数的解析由ModelBinder处理。这是两种不同的机制。

我阅读了这篇文章，并创建了以下ModelBinder:

public class IsoTimeSpanModelBinder: IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        if(bindingContext.ModelType != typeof(TimeSpan))
        {
            return false;
        }
        var val = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
        if(val == null)
        {
            return false;
        }
        var key = val.RawValue as string;
        if(key == null)
        {
            bindingContext.ModelState.AddModelError(bindingContext.ModelName, "Wrong value type for TimeSpan");
            return false;
        }
        try
        {
            bindingContext.Model = XmlConvert.ToTimeSpan(key);
            return true;
        }
        catch (Exception e)
        {
            bindingContext.ModelState.AddModelError(
                bindingContext.ModelName, "Cannot convert value to TimeSpan: " + e.Message);
            return false;
        }
    }
}

然后配置以使用它解析所有TimeSpan:

public class Global : System.Web.HttpApplication
{
    protected void Application_Start(object sender, EventArgs e)
    {
        GlobalConfiguration.Configure(Register);
    }
    public static void Register(HttpConfiguration config)
    {
        // Parse TimeSpan in ISO format (e.g. PT5M)
        config.Services.Insert(
            typeof(ModelBinderProvider), 0,
            new SimpleModelBinderProvider(typeof(TimeSpan), new IsoTimeSpanModelBinder()));
    }
}

还可以以自定义格式解析任何用户定义的类型。非常灵活！

在Application_start（）中尝试一下

var formatters = GlobalConfiguration.Configuration.Formatters;
var jsonFormatter = formatters.JsonFormatter;
jsonFormatter.SerializerSettings.Converters.Add(new IsoTimeSpanConverter());

更新：

在函数中将参数作为TimeSpan有什么原因吗？

您可以获取字符串持续时间，然后使用启动您的功能

        try
        {
            TimeSpan tt = XmlConvert.ToTimeSpan(duration);
        }
        catch(Exception ex)
        {
        }

因为您的自定义代码正在执行相同的操作，将字符串（ISO时间）转换为时间跨度。

相关文章：