ASP.NET MVC 3 控制器 .Json 方法序列化不考虑 DataMember 名称属性

Question

在我的班级中，我得到了：

[DataMember(Name = "jsonMemberName", EmitDefaultValue = false, 
    IsRequired = false)]
public List<string> Member { get; set; }

通过重新运行 System.Web.Mvc.JsonResult 的控制器的 Json(obj) 传递对象后：我得到了序列化的 json: {Member:...} 但不是 {jsonMemberName:... }，所以它不会查看 DataMember(Name = "jsonMemberName")。

如果我使用 System.Runtime.Serialization.Json 的序列化，一切都会按预期正常工作。

有什么问题吗？

Answer 1

您从控制器操作（使用 return Json(...)）在内部依赖于 JavaScriptSerializer 类。此类不考虑模型上的任何 DataMember 属性。

您可以编写一个自定义 ActionResult，它使用 System.Runtime.Serialization.Json 命名空间中的序列化器。

例如：

public class MyJsonResult : JsonResult
{
    public override void ExecuteResult(ControllerContext context)
    {
        var response = context.HttpContext.Response;
        if (!string.IsNullOrEmpty(ContentType))
        {
            response.ContentType = ContentType;
        }
        else
        {
            response.ContentType = "application/json";
        }
        if (ContentEncoding != null)
        {
            response.ContentEncoding = this.ContentEncoding;
        }
        if (Data != null)
        {
            var serializer = new DataContractJsonSerializer(Data.GetType());
            serializer.WriteObject(response.OutputStream, Data);
        }
    }
}

然后在您的控制器操作中：

public ActionResult Foo()
{
    var model = ...
    return new MyJsonResult { Data = model };
}

Answer 2

System.Web.Mvc.JsonResult 使用旧的 JavaScriptSerializer 类，它不了解有关 DataAnnotations 程序集的任何信息。您需要使用 DataContractJsonSerializer 。

如果您愿意，可以在 JsonResult 上使用它：（

public class DataContractJsonResult : JsonResult
{
    public DataContractJsonResult(object data)
    {
        Data = data;
    }

    public DataContractJsonResult()
    {
    }

    public override void ExecuteResult(ControllerContext context)
    {
        if (context == null)
        {
            throw new ArgumentNullException("context");
        }
        if (JsonRequestBehavior == JsonRequestBehavior.DenyGet &&
            String.Equals(context.HttpContext.Request.HttpMethod, "GET", StringComparison.OrdinalIgnoreCase))
        {
            throw new InvalidOperationException("This request has been blocked because sensitive information could be disclosed to third party web sites when this is used in a GET request. To allow GET requests, set JsonRequestBehavior to AllowGet.");
        }

        HttpResponseBase response = context.HttpContext.Response;

        if (!string.IsNullOrEmpty(ContentType))
        {
            response.ContentType = ContentType;
        }
        else
        {
            response.ContentType = "application/json";
        }
        if (ContentEncoding != null)
        {
            response.ContentEncoding = ContentEncoding;
        }
        if (Data != null)
        {
            var serializer = new DataContractJsonSerializer(Data.GetType());
            var ms = new MemoryStream();
            serializer.WriteObject(ms, Data);
            string json = Encoding.UTF8.GetString(ms.ToArray());
            response.Write(json);
        }
    }
}

我参考了 ASP.NET MVC 源代码来创建它。不确定我是否必须以某种方式相信它。好吧，除了这个之外，就是这样。 :))

您还可以将其添加到控制器继承的基类中：

protected JsonResult DataContractJson(object data)
{
    return new DataContractJsonResult(data);
}