解决Asp.net Mvc返回JsonResult中DateTime类型数据格式问题的方法

下面我来详细讲解“解决Asp.net Mvc返回JsonResult中DateTime类型数据格式问题的方法”的完整攻略。

下面我来详细讲解“解决Asp.net Mvc返回JsonResult中DateTime类型数据格式问题的方法”的完整攻略。

问题概述

在使用Asp.net Mvc框架返回JsonResult时，我们经常会遇到DateTime类型的数据无法正确序列化的问题。原因在于Json序列化默认使用了UTC时间，而DateTime类型的数据默认是本机时间。为了解决这个问题，我们需要对DateTime类型数据进行处理。

解决方法

方法一：修改Json序列化配置

可以通过修改Json序列化配置来改变序列化的方式。例如，在Global.asax.cs文件的Application_Start方法中添加以下代码：

var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.DateTimeZoneHandling = Newtonsoft.Json.DateTimeZoneHandling.Local;

其中，DateTimeZoneHandling属性指定了时间的处理方式。将其设置为Local可以让序列化使用本机时间。

方法二：使用自定义的日期格式

可以使用自定义的日期格式来规避本机时间和UTC时间之间的差异。例如，在控制器中添加以下代码来设置日期格式：

var jsonResult = new JsonResult()
{
    Data = myData,
    JsonRequestBehavior = JsonRequestBehavior.AllowGet,
    ContentEncoding = Encoding.UTF8,
    ContentType = "application/json"
};

jsonResult.Data = JsonConvert.SerializeObject(myData, new JsonSerializerSettings
{
    DateFormatHandling = DateFormatHandling.IsoDateFormat,
    DateTimeZoneHandling = DateTimeZoneHandling.Local
});

其中，DateFormatHandling属性指定了日期格式的处理方式。将其设置为IsoDateFormat可以让序列化使用标准的ISO日期格式。

示例说明

下面以两个示例来演示如何解决DateTime类型数据格式问题。

示例一：使用修改Json序列化配置方法

public class MyController : Controller
{
    public ActionResult GetMyData()
    {
        MyData myData = new MyData()
        {
            Id = 1,
            Name = "My name",
            CreateTime = DateTime.Now
        };

        return Json(myData, JsonRequestBehavior.AllowGet);
    }
}

public class MyData
{
    public int Id { get; set; }
    public string Name { get; set; }
    public DateTime CreateTime { get; set; }
}

在Global.asax.cs文件的Application_Start方法中添加以下代码：

var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.DateTimeZoneHandling = Newtonsoft.Json.DateTimeZoneHandling.Local;

使用Postman调用GetMyData方法，可以看到CreateTime的值已经转换为本地时间。

示例二：使用自定义的日期格式方法

public class MyController : Controller
{
    public ActionResult GetMyData()
    {
        MyData myData = new MyData()
        {
            Id = 1,
            Name = "My name",
            CreateTime = DateTime.Now
        };

        var jsonResult = new JsonResult()
        {
            Data = myData,
            JsonRequestBehavior = JsonRequestBehavior.AllowGet,
            ContentEncoding = Encoding.UTF8,
            ContentType = "application/json"
        };

        jsonResult.Data = JsonConvert.SerializeObject(myData, new JsonSerializerSettings
        {
            DateFormatHandling = DateFormatHandling.IsoDateFormat,
            DateTimeZoneHandling = DateTimeZoneHandling.Local
        });

        return jsonResult;
    }
}

public class MyData
{
    public int Id { get; set; }
    public string Name { get; set; }
    public DateTime CreateTime { get; set; }
}

使用Postman调用GetMyData方法，可以看到CreateTime的值已经使用了标准的ISO日期格式。