JSON.NET 序列化 JObject，同时忽略 null 属性

我有一个JObject它被用作template用于调用 RESTful Web 服务。这JObject通过解析器创建，并且由于它用作模板告诉用户端点架构是什么样子，所以我必须找到一种方法来保留所有属性，这就是为什么我将它们的值默认为null。例如，该对象最初的样子是这样的：

{  
   "Foo":{  
      "P1":null,
      "P2":null,
      "P3":null,
      "P4":{  
         "P1":null,
         "P2":null,
         "P3":null,
      },
      "FooArray":[  
         {  
            "F1":null,
            "F2":null,
            "F3":null,
         }
      ]
   },
   "Bar":null
}

然后，用户可以根据需要填写各个字段，例如Foo.P2 and Foo.P4.P1:

{  
   "Foo":{  
      "P1":null,
      "P2":"hello world",
      "P3":null,
      "P4":{  
         "P1":1,
         "P2":null,
         "P3":null,
      },
      "FooArray":[  
         {  
            "F1":null,
            "F2":null,
            "F3":null,
         }
      ]
   },
   "Bar":null
}

这意味着他们只关心这两个领域。现在我想序列化这个模板（JObject）返回到 JSON 字符串，但只希望显示填充的那些字段。所以我尝试了这个：

string json = JsonConvert.SerializeObject(template,
    new JsonSerializerSettings
    {
        NullValueHandling = NullValueHandling.Ignore
    });

不幸的是，这不起作用。我碰到这个问题 https://stackoverflow.com/questions/29258587/newtonsoft-json-net-serialize-jobject-doesnt-ignore-nulls-even-with-the-right并意识到一个null对象中的值是实际值JToken类型，而不是真正的null，这是有道理的。然而，在这种非常特殊的情况下，我需要能够摆脱这些“未使用”的字段。我尝试手动迭代节点并删除它们，但这也不起作用。请注意，我使用的唯一托管类型是JObject;我没有一个模型来将对象转换为对象或定义属性，因为这个“模板”在运行时得到解析。我只是想知道是否有人遇到过这样的问题并有任何见解。任何帮助是极大的赞赏！

您可以使用如下所示的递归辅助方法来删除null来自你的价值观JToken序列化之前的层次结构。

using System;
using Newtonsoft.Json.Linq;

public static class JsonHelper
{
    public static JToken RemoveEmptyChildren(JToken token)
    {
        if (token.Type == JTokenType.Object)
        {
            JObject copy = new JObject();
            foreach (JProperty prop in token.Children<JProperty>())
            {
                JToken child = prop.Value;
                if (child.HasValues)
                {
                    child = RemoveEmptyChildren(child);
                }
                if (!IsEmpty(child))
                {
                    copy.Add(prop.Name, child);
                }
            }
            return copy;
        }
        else if (token.Type == JTokenType.Array)
        {
            JArray copy = new JArray();
            foreach (JToken item in token.Children())
            {
                JToken child = item;
                if (child.HasValues)
                {
                    child = RemoveEmptyChildren(child);
                }
                if (!IsEmpty(child))
                {
                    copy.Add(child);
                }
            }
            return copy;
        }
        return token;
    }

    public static bool IsEmpty(JToken token)
    {
        return (token.Type == JTokenType.Null);
    }
}

Demo:

string json = @"
{
    ""Foo"": {
        ""P1"": null,
        ""P2"": ""hello world"",
        ""P3"": null,
        ""P4"": {
            ""P1"": 1,
            ""P2"": null,
            ""P3"": null
        },
        ""FooArray"": [
            {
                ""F1"": null,
                ""F2"": null,
                ""F3"": null
            }
        ]
    },
    ""Bar"": null
}";

JToken token = JsonHelper.RemoveEmptyChildren(JToken.Parse(json));
Console.WriteLine(token.ToString(Formatting.Indented));

Output:

{
  "Foo": {
    "P2": "hello world",
    "P4": {
      "P1": 1
    },
    "FooArray": [
      {}
    ]
  }
}

Fiddle: https://dotnetfiddle.net/wzEOie https://dotnetfiddle.net/wzEOie

请注意，删除所有空值后，您将在FooArray，这可能是您不想要的。 （如果该对象被删除，那么您将得到一个空的FooArray，您可能也不希望这样做。）如果您想让辅助方法在删除方面更加积极，您可以将 IsEmpty 函数更改为：

    public static bool IsEmpty(JToken token)
    {
        return (token.Type == JTokenType.Null) ||
               (token.Type == JTokenType.Array && !token.HasValues) ||
               (token.Type == JTokenType.Object && !token.HasValues);
    }

完成此更改后，您的输出将如下所示：

{
  "Foo": {
    "P2": "hello world",
    "P4": {
      "P1": 1
    }
  }
}

Fiddle: https://dotnetfiddle.net/ZdYogJ https://dotnetfiddle.net/ZdYogJ