在 c# Web Api 中反序列化 JSON 对象时如何绑定给定属性？

Question

我有一个看起来像的 c# 类

public class Node {

    public int Id { get; set; }

    /** Properties omitted for sake of brevity **/

    public Node ParentNode { get; set; }

}

在浏览器中，我提交了一个 JSON 对象，如下所示

{"Id":1, "ParentNode":1}

分配给 ParentNode 属性的值 1 表示数据库标识符。因此，为了正确绑定到我的模型，我需要编写一个自定义 JSON 转换器

public class NodeJsonConverter : JsonConverter
{

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
        {
            return null;
        }

        /** Load JSON from stream **/
        JObject jObject = JObject.Load(reader);

        Node node = new Node();

        /** Populate object properties **/
        serializer.Populate(jObject.CreateReader(), node);

        return node;
    }
}

因为我得到一个“当前 JsonReader 项目不是对象：整数。路径 ParentNode'”，如何调整 ReadJson 方法以绑定 ParentNode 属性或其他需要自定义转换的东西？

更新

我看到了JsonPropertyAttribute 的 API 文档说明

指示 JsonSerializer 始终序列化具有指定名称的成员

但是，我如何以编程方式指示 JsonSerializer（在我的例子中，在 ReadJson 方法中）使用给定的 JsonPropertyAttribute ？

http://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_JsonPropertyAttribute.htm

Answer 1

您可以使用私有设置器创建公共 ParentNodeId 和 ParentNode。然后传递 ParentNodeId，该 setter 将在其中执行代码以填充 ParentNode。现在您可以将您的模型序列化为 JSON 并将其传递回客户端……或者您想用它做什么。类似的，

public class Node {

public int Id { get; set; }

/** Properties omitted for sake of brevity **/
private int _parentNodeId;
public int ParentNodeId { get {return _parentNodeId;}
set
{
    _parentNodeId = value;
    ParentNode = GetParentNodePropertyValues(_parentNodeId);
} 
}
public Node ParentNode { get; private set; }

}

Answer 2

我认为这里的问题是由于Node 包含Node 的ParentNode 属性形式，解析变得递归。

在调用serializer.Populate(jObject.CreateReader(), node); 时，序列化程序将命中ParentNode 类型为Node 的属性，然后它将尝试使用您的NodeJsonConverter 解析该属性。那时读者已经继续前进，您不再拥有StartObject，但您拥有Integer。我认为您可以检查reader.TokenType 属性以查看您是在第一次通话还是在后续通话中并进行相应处理：

public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
    if (reader.TokenType == JsonToken.Null)
    {
        return null;
    }

    Node node = new Node();

    if (reader.TokenType == JsonToken.StartObject)
    {
        //initial call
        //here we have the object so we can use Populate
        JObject jObject = JObject.Load(reader);
        serializer.Populate(jObject.CreateReader(), node);
    }
    else
    {
        //the subsequent call
        //here we just have the int which is the ParentNode from the request
        //we can assign that to the Id here as this node will be set as the 
        //ParentNode on the original node from the first call
        node.Id = (int)(long)reader.Value;
    }

    return node;
}