MVC 4 中正确的 JSON 序列化答案

【问题标题】：Proper JSON serialization in MVC 4MVC 4 中正确的 JSON 序列化
【发布时间】：2013-06-19 03:32:35
【问题描述】：

我希望对 JSON 进行“正确”序列化（camelCase），并能够在必要时更改日期格式。

对于 Web API，这非常简单 - 在 Global.asax 中我执行以下代码

var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();

此代码在管道级别以我喜欢的方式处理序列化。

我想在 MVC 4 中完成同样的事情 - 让从控制器操作方法返回的任何 JSON 被正确序列化。经过一番搜索，我发现以下代码可以在 Global.asax 应用程序启动中抛出：

HttpConfiguration config = GlobalConfiguration.Configuration;
Int32 index = config.Formatters.IndexOf(config.Formatters.JsonFormatter);
config.Formatters[index] = new JsonMediaTypeFormatter
{
     SerializerSettings = new JsonSerializerSettings { ContractResolver = new CamelCasePropertyNamesContractResolver() }
};

它似乎执行得很好，但是当我从控制器返回 JSON 时，它都是 PascalCased。我的操作方法的一个简单示例：

private JsonResult GetJsonTest()
{
    var returnData = dataLayer.GetSomeObject();
    return Json(returnData, JsonRequestBehavior.AllowGet);
}

我做错了吗？知道如何在管道级别完成此任务吗？

【问题讨论】：

我没有意识到 json 规范需要驼色套管......
据我了解，camel cased json 被更广泛地接受，不这样做会破坏框架。此外，我们的开发标准也明确说明了这一点，这就是我正在做的事情。
不应从 API 返回数据对象。更好地创建模型/服务合同/任何东西并返回它们。问题不仅在于潜在的数据泄漏，而且还在于增加 API 客户端对内部数据对象的依赖的高风险。有人重命名了一个数据属性，然后你的 UI 就坏了。

标签： c# asp.net asp.net-mvc json asp.net-mvc-4

【解决方案1】：

我建议使用 ServiceStack 或 Json.NET 之类的东西来处理 MVC 应用程序中的 Json 输出。但是，您可以轻松地编写一个类并使用基类覆盖 Json 方法。请参阅下面的示例。

注意：有了这个，您的 Global.ascx.cs 文件中不需要任何内容。

自定义 JsonDotNetResult 类：

public class JsonDotNetResult : JsonResult
{
    private static readonly JsonSerializerSettings Settings = new JsonSerializerSettings
    {
        ContractResolver = new CamelCasePropertyNamesContractResolver(),
        Converters = new List<JsonConverter> { new StringEnumConverter() }
    };

    public override void ExecuteResult(ControllerContext context)
    {
        if (this.JsonRequestBehavior == JsonRequestBehavior.DenyGet &&
            string.Equals(context.HttpContext.Request.HttpMethod, "GET", StringComparison.OrdinalIgnoreCase))
        {
            throw new InvalidOperationException("GET request not allowed");
        }

        var response = context.HttpContext.Response;

        response.ContentType = !string.IsNullOrEmpty(this.ContentType) ? this.ContentType : "application/json";

        if (this.ContentEncoding != null)
        {
            response.ContentEncoding = this.ContentEncoding;
        }

        if (this.Data == null)
        {
            return;
        }

        response.Write(JsonConvert.SerializeObject(this.Data, Settings));
    }
}

基本控制器类：

public abstract class Controller : System.Web.Mvc.Controller
{
    protected override JsonResult Json(object data, string contentType, System.Text.Encoding contentEncoding, JsonRequestBehavior behavior)
    {
        return new JsonDotNetResult
            {
                Data = data,
                ContentType = contentType,
                ContentEncoding = contentEncoding,
                JsonRequestBehavior = behavior
            };
    }
}

现在，在您的控制器操作中，您可以简单地返回类似的内容。

return Json(myObject, JsonRequestBehavior.AllowGet);

BAM。你现在已经用 Json 返回了 camelcase 对象:)

注意：有一些方法可以通过对您使用 Json 创建的每个对象的序列化程序设置来执行此操作。但是每次你想返回 Json 时，谁会想把它打出来呢？

【讨论】：

【解决方案2】：

虽然 Web API 使用 JSON.NET，但 MVC4 默认使用 JavaScriptSerializer，我认为它不支持更改为 Camel Case 序列化。检查这个：Setting the default JSON serializer in ASP.NET MVC

我的建议是您按照此处Using JSON.NET as the default JSON serializer in ASP.NET MVC 3 - is it possible? 的描述创建一个自定义 JsonNetResult 并将最后一行更改为：

var serializedObject = JsonConvert.SerializeObject(
      Data,
      Formatting.Indented,
      new JsonSerializerSettings { MappingResolver = new CamelCaseMappingResolver() });

【讨论】：

【解决方案3】：

Note that below information is for Asp .Net core

.Net 团队最近宣布，MVC 现在默认使用驼峰式名称序列化 JSON。

通过以下几行，您将能够启用此功能：

services
.AddMvc()
.AddJsonOptions(options =>
options.SerializerSettings.ContractResolver = new DefaultContractResolver());

我在 here 上写了一个小博客。

【讨论】：

是的，但它适用于 aspnet 核心

【解决方案4】：

您可以创建一个静态方法来返回一个ContentResult，该方法利用NewtonSoft.Json 库进行类似这样的序列化：

public static ContentResult CamelJson<TData>(TData response)
{
    DefaultContractResolver resolver = new CamelCasePropertyNamesContractResolver();
    JsonSerializerSettings settings = new JsonSerializerSettings
    {
        ContractResolver = resolver,
        DateFormatHandling = DateFormatHandling.IsoDateFormat
    };
    return new ContentResult
    {
        Content = JsonConvert.SerializeObject(response, settings),
        ContentType = "application/json"
    };
}

示例用法：

[HttpGet]
public ContentResult GetCamelCaseJsonData()
{
  return ContentUtils.CamelJson(result);
}

输出将是驼峰式的。

【讨论】：