使用 Web API 和 JSON.NET 序列化对象时防止 $id/$ref

Question

我似乎无法阻止 Web API/JSON.NET 在序列化对象时使用 Newtonsoft.Json.PreserveReferencesHandling.Objects。换句话说，尽管使用了以下设置，但 $id/$ref 始终在序列化对象中使用：

public class MvcApplication : System.Web.HttpApplication {

    protected void Application_Start () {
        WebApiConfig.Register(GlobalConfiguration.Configuration);
    }

}

public static class WebApiConfig {

    public static void Register (HttpConfiguration config) {
        JsonMediaTypeFormatter jsonFormatter = config.Formatters.OfType<JsonMediaTypeFormatter>().Single();
        jsonFormatter.UseDataContractJsonSerializer = false;
        jsonFormatter.SerializerSettings.Formatting = Newtonsoft.Json.Formatting.Indented;
        jsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
        jsonFormatter.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.None;
    }

}

有什么想法吗？

Answer 1

把它放在 Global.asax 中来配置引用处理。 PreserveReferencesHandling 不应为“全部”

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.PreserveReferencesHandling = Newtonsoft.Json.PreserveReferencesHandling.None;

Answer 2

如果在您的对象（例如 DataContract）上使用序列化属性，来自JSON.Net documentation on Serialization Attributes：

除了使用内置的 Json.NET 属性外，Json.NET 还查找 [SerializableAttribute][2]（如果 DefaultContractResolver 上的 IgnoreSerializableAttribute 设置为 false）[DataContractAttribute][3]、[DataMemberAttribute][ 4] 和 [NonSerializedAttribute][5] ... 在确定 JSON 如何被序列化和反序列化时。

它还说：

注意

Json.NET 属性优先于标准 .NET 序列化属性，例如如果属性上同时存在 JsonPropertyAttribute 和 DataMemberAttribute 并且都自定义了名称，则将使用 JsonPropertyAttribute 中的名称。

似乎问题的解决方案是将[JsonObject(IsReference = false)] 添加到您的对象中，如下所示：

[DataContract(IsReference = true)]
[JsonObject(IsReference = false)]
public class MyObject
{
    [DataMember]
    public int MyProperty { get; set; }
}

Answer 3

这是我用来在客户端处理 $id/$ref 对象的一些 javascript：

// function to return a JSON object form a JSON.NET serialized object with $id/$ref key-values
// obj: the obj of interest.
// parentObj: the top level object containing all child objects as serialized by JSON.NET.
function getJsonNetObject(obj, parentObj) {
    // check if obj has $id key.
    var objId = obj["$id"];
    if (typeof (objId) !== "undefined" && objId != null) {
        // $id key exists, so you have the actual object... return it
        return obj;
    }
    // $id did not exist, so check if $ref key exists.
    objId = obj["$ref"];
    if (typeof (objId) !== "undefined" && objId != null) {
        // $ref exists, we need to get the actual object by searching the parent object for $id
        return getJsonNetObjectById(parentObj, objId);
    }
    // $id and $ref did not exist... return null
    return null;
}

// function to return a JSON object by $id
// parentObj: the top level object containing all child objects as serialized by JSON.NET.
// id: the $id value of interest
function getJsonNetObjectById(parentObj, id) {
    // check if $id key exists.
    var objId = parentObj["$id"];
    if (typeof (objId) !== "undefined" && objId != null && objId == id) {
        // $id key exists, and the id matches the id of interest, so you have the object... return it
        return parentObj;
    }
    for (var i in parentObj) {
        if (typeof (parentObj[i]) == "object" && parentObj[i] != null) {
            //going one step down in the object tree
            var result = getJsonNetObjectById(parentObj[i], id);
            if (result != null) {
                // return found object
                return result;
            }
        }
    }
    return null;
}

Answer 4

我的应用程序导致错误我调试了我的 asp.net 应用程序，直到它给了我导致此问题的模型集合。 只需放置 [JsonIgnore] 标记，它就可以正常工作。

[JsonIgnore]
public virtual ICollection<customer_details> customer_details { get; set; }

您可以通过将 [JsonIgnore] 分配给 Model 中的所有 ICollection 来手动测试，以发现问题的根源。

Answer 5

[JsonIgnore] 为我工作。在模型中，包括：

    [JsonIgnore] 
    public virtual ICollection<cell_order> cell_order { get; set; }

很遗憾，这必须针对每个需要的情况进行。