解決ASP.NET MVC返回的JsonResult 中 日期類型數據格式問題，和返回的屬性名稱轉爲“駝峯命名法”和循環引用問題

DateTime類型數據格式問題

問題

在使用ASP.NET MVC 在寫項目的時候發現，返回給前端的JSON數據，日期類型是 Date(121454578784541) 的格式，需要前端來轉換一下才能用來使用。

C#對象屬性名稱轉換成JSON自動轉成“駝峯命名法”

問題

在C#中推薦的屬性命名方式是“帕斯卡命名法”【首字母大寫】但是在前端推薦命名方式爲“駝峯命名法”【首字母小寫】，這樣如果直接序列化C#對象，返回的屬性就是大寫的了

MVC 默認的返回JsonResult在序列化有循環引用對象時候會出現異常

問題

序列化類型爲“XXXXXX.XXXX.XXX”的對象時檢測到循環引用。

解決辦法

創建新的 JsonResult 對象

使用新的JSON序列化組件 Newtonsoft.Json

Install-Package Newtonsoft.Json

創建新的 JsonResult 對象
然後在新的 JsonResult 類型中將處理JSON序列化的對象改爲 Newtonsoft.Json
並設置JSON轉換的日期格式爲 yyyy-MM-dd HH:mm:ss 例如：【2020-03-28 17:36:23】
並設置 轉換的屬性爲“駝峯命名法”

/// <summary>
/// JSON結果返回對象
/// </summary>
public class JsonNetResult : JsonResult
{
    /// <summary>
    /// 實例化JSON結果返回對象
    /// </summary>
    /// <param name="data">需要序列化的對象</param>
    /// <returns>JSON結果對象</returns>
    public JsonNetResult(object data)
        : this(data, JsonRequestBehavior.DenyGet)
    {
    }

    /// <summary>
    /// 實例化JSON結果返回對象
    /// </summary>
    /// <param name="data">需要序列化的對象</param>
    /// <param name="jsonRequestBehavior">設置是否允許GET請求獲取JSON結果對象</param>
    /// <returns>JSON結果對象</returns>
    public JsonNetResult(object data, JsonRequestBehavior jsonRequestBehavior)
    {
        this.Data = data;
        this.JsonRequestBehavior = jsonRequestBehavior;
        this.Settings = new JsonSerializerSettings
        {
            ReferenceLoopHandling = ReferenceLoopHandling.Ignore, //忽略循環引用
            DateFormatString = "yyyy-MM-dd HH:mm:ss", //輸出的日期格式
            ContractResolver = new CamelCasePropertyNamesContractResolver() //設置屬性的名稱爲“駝峯命名法”
        };
    }

    /// <summary>
    /// JSON序列化設置對象
    /// </summary>
    public JsonSerializerSettings Settings { get; set; }

    /// <summary>
    /// 向響應流返回結果方法
    /// </summary>
    public override void ExecuteResult(ControllerContext context)
    {
        //判斷當前請求是否爲GET且判斷是否允許GET獲取JSON，不允許就報錯
        if ("GET".Equals(context.HttpContext.Request.HttpMethod, StringComparison.OrdinalIgnoreCase) &&
            this.JsonRequestBehavior == JsonRequestBehavior.DenyGet)
            throw new Exception("不允許GET請求返回JSON數據！");

        //判斷是否改變響應數據編碼
        if (this.ContentEncoding != null)
            context.HttpContext.Response.ContentEncoding = this.ContentEncoding;
        //如果當前需要序列化的數據爲NULL就直接返回
        if (this.Data == null)
            return;
        //設置響應數據內容格式爲 json
        context.HttpContext.Response.ContentType =
            string.IsNullOrEmpty(this.ContentType) ? "application/json" : this.ContentType;
        //向響應流寫入序列化的數據
        JsonSerializer.Create(Settings).Serialize(context.HttpContext.Response.Output, this.Data);
    }
}

使用新的 JsonResult 對象 方法一（推薦）

使用過濾器，將JsonResult對象替換成 JsonNetResult 對象

創建一個ActionFilter，用來將返回的JsonResult對象轉換成新的JsonNetResult對象

/// <summary>
/// 將Action返回的JsonResult轉換成JsonNetAction
/// </summary>
public class JsonNetActionFilter : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext filterContext)
    {
    }

    public void OnActionExecuted(ActionExecutedContext filterContext)
    {
        //判斷是JsonResult對象
        if (filterContext.Result is JsonResult && !(filterContext.Result is JsonNetResult))
        {
            //得到原JsonResult對象
            var jsonResult = (JsonResult) filterContext.Result;
            //創建新的JsonNetResult對象
            var jsonNetResult = new JsonNetResult(jsonResult.Data)
            {
                ContentEncoding = jsonResult.ContentEncoding,
                ContentType = jsonResult.ContentType,
                JsonRequestBehavior = jsonResult.JsonRequestBehavior,
                MaxJsonLength = jsonResult.MaxJsonLength,
                RecursionLimit = jsonResult.RecursionLimit
            };
            //將新的JsonNetResult對象賦值給返回結果
            filterContext.Result = jsonNetResult;
        }
    }
}

在Global.asax註冊過濾器

public class MvcApplication : HttpApplication
{
    protected void Application_Start()
    {
        AreaRegistration.RegisterAllAreas();
        RouteConfig.RegisterRoutes(RouteTable.Routes);

        //註冊過濾器
        GlobalFilters.Filters.Add(new JsonNetActionFilter());
    }
}

使用

public class HomeController : Controller
{
    public ActionResult GetStudent()
    {
        var student = new StudentDto
        {
            Id = 1,
            Name = "張三",
            Age = 18,
            ClassName = "B36",
            CreateDate = DateTime.Now,
        };
        return Json(student);
    }
}

返回給前端的JSON數據

{"id":1,"name":"張三","age":18,"className":"B36","createDate":"2020-03-28 17:47:29"}

使用新的 JsonResult 對象 方法二

創建一個BaseController 來重寫他的Json()方法

創建一個 BaseController 類 繼承自 Controller 類
並重寫他的 Json() 方法，其他Controller 類都繼承自 BaseController
這樣 可以直接沿用之前的 返回Json對象方法

/// <summary>
/// 父 控制器
/// </summary>
public class BaseController : Controller
{
    /// <summary>
    /// 返回 JsonNetResult 對象
    /// </summary>
    /// <param name="data">需要返回序列化的對象</param>
    /// <param name="contentType">內容格式</param>
    /// <param name="contentEncoding">內容編碼</param>
    /// <param name="behavior">指定是否允許來自客戶端的 HTTP GET 請求。</param>
    /// <returns>JsonResult對象</returns>
    protected override JsonResult Json(object data, string contentType, Encoding contentEncoding, JsonRequestBehavior behavior)
    {
        return new JsonNetResult(data)
        {
            ContentType = contentType,
            ContentEncoding = contentEncoding,
            JsonRequestBehavior = behavior
        };
    }
}

使用

public class HomeController : BaseController
{
    public ActionResult GetStudent()
    {
        var student = new StudentDto
        {
            Id = 1,
            Name = "張三",
            Age = 18,
            ClassName = "B36",
            CreateDate = DateTime.Now,
        };
        //將當前對象序列化成JSON返回給前端
        return Json(student);
    }
}

返回給前端的JSON數據

{"id":1,"name":"張三","age":18,"className":"B36","createDate":"2020-03-28 17:47:29"}

使用新的 JsonResult 對象 方法三

創建一個JSON幫助類

/// <summary>
/// JSON幫助類
/// </summary>
public static class JsonHelper
{
    /// <summary>
    /// 將一個對象序列化成JSON格式字符串返回給請求方
    /// </summary>
    /// <param name="obj">需要序列化的對象</param>
    /// <param name="jsonRequestBehavior">設置是否允許GET請求獲取JSON結果對象</param>
    /// <returns>JSON結果對象</returns>
    public static JsonNetResult Json(object obj,
        JsonRequestBehavior jsonRequestBehavior = JsonRequestBehavior.DenyGet)
    {
        return new JsonNetResult(obj, jsonRequestBehavior);
    }

    /// <summary>
    /// 將當前對象序列化成JSON格式字符串返回給請求方
    /// </summary>
    /// <param name="obj">需要序列化的對象</param>
    /// <param name="jsonRequestBehavior">設置是否允許GET請求獲取JSON結果對象</param>
    /// <returns>JSON結果對象</returns>
    public static JsonNetResult ToJsonResult(this object obj,
        JsonRequestBehavior jsonRequestBehavior = JsonRequestBehavior.DenyGet)
    {
        return new JsonNetResult(obj, jsonRequestBehavior);
    }
}

使用

public ActionResult GetStudent()
{
    var student = new StudentDto
    {
        Name = "張三",
        Age = 18,
        ClassName = "B36",
        CreateDate = DateTime.Now,
    };
    //直接調用擴展方法 ToJsonResult 來獲取新的 JsonResult
    return student.ToJsonResult();
}

返回給前端的JSON數據

{"id":1,"name":"張三","age":18,"className":"B36","createDate":"2020-03-28 17:47:29"}