OData Web API的DateTime格式转换实现方案问询

当然可以在WebAPIConfig里全局处理这个DateTime格式转换，而且这是更优雅的方案——不用在每个控制器里重复写逻辑，一次性配置就能覆盖所有请求。下面分两种方案给你详细说明：

方案一：全局配置（推荐） #

你可以通过自定义格式化器或者调整OData的时间处理逻辑来实现全局转换，这里给你一个具体的可落地实现：

1. 创建自定义的JSON格式化器，重写时间类型的序列化/反序列化逻辑：

public class CustomDateTimeFormatter : JsonMediaTypeFormatter
{
    public CustomDateTimeFormatter()
    {
        var jsonSettings = new JsonSerializerSettings
        {
            DateParseHandling = DateParseHandling.DateTimeOffset,
            // 输出时使用目标格式
            DateFormatString = "yyyy-MM-ddTHH:mm"
        };
        // 添加自定义转换器处理带时区的输入
        jsonSettings.Converters.Add(new UtcDateTimeConverter());
        this.SerializerSettings = jsonSettings;
    }
}

public class UtcDateTimeConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(DateTimeOffset) || objectType == typeof(DateTimeOffset?);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.Value == null) return null;
        
        // 解析带时区的时间字符串为DateTimeOffset
        if (DateTimeOffset.TryParse(reader.Value.ToString(), out var offsetTime))
        {
            // 转换为UTC时间后返回，后续会用我们设置的格式输出
            return offsetTime.UtcDateTime;
        }
        return null;
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        if (value is DateTime dateTime)
        {
            writer.WriteValue(dateTime.ToString("yyyy-MM-ddTHH:mm"));
        }
        else if (value is DateTimeOffset offsetTime)
        {
            writer.WriteValue(offsetTime.UtcDateTime.ToString("yyyy-MM-ddTHH:mm"));
        }
        else
        {
            writer.WriteNull();
        }
    }
}

2. 在WebAPIConfig.Register方法中注册这个自定义格式化器：

public static void Register(HttpConfiguration config)
{
    // 清除默认格式化器，避免冲突
    config.Formatters.Clear();
    // 添加自定义格式化器
    config.Formatters.Add(new CustomDateTimeFormatter());

    // 你的OData路由配置逻辑
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    // ... 这里添加你的实体集、导航属性等配置
    config.MapODataServiceRoute(
        routeName: "ODataRoute",
        routePrefix: null,
        model: builder.GetEdmModel());
}

完成配置后，所有请求中带时区的DateTime字符串都会被自动转换为UTC时间，并格式化为你需要的yyyy-MM-ddTHH:mm格式，全局生效。

方案二：控制器局部处理 #

如果只有个别接口需要特殊处理，也可以在控制器方法里手动转换：

public IHttpActionResult Get([FromODataUri] DateTimeOffset inputDate)
{
    // 将带时区的时间转换为UTC时间，再格式化目标格式
    var convertedDate = inputDate.UtcDateTime.ToString("yyyy-MM-ddTHH:mm");
    // 后续业务逻辑处理...
    return Ok(convertedDate);
}

不过这种方式需要在每个用到的控制器方法中重复编写转换逻辑，适合特殊场景，不推荐全局使用。

另外提醒下：如果你的OData模型中定义的时间类型是DateTime，建议改成DateTimeOffset，这样能更好地保留时区信息，避免转换过程中出现时间偏差。

内容的提问来源于stack exchange，提问作者Pey