使用 System.Text.Json 修改 JSON 文件

我知道使用 Newtonsoft 可以轻松做到这一点。然而，当我使用 .NET Core 3.0 时，我尝试使用新方法与 JSON 文件交互，即System.Text.Json——我拒绝相信我正在尝试做的事情有那么困难！

我的应用程序需要列出尚未添加到我的数据库中的用户。为了获取所有用户的完整列表，应用程序从 Web API 检索 JSON 字符串。现在，我需要循环浏览每个用户，并检查他们是否已添加到我的应用程序中，然后再将新的 JSON 列表返回到我的视图，以便它可以向最终用户显示新的潜在用户。

由于我最终会在流程结束时返回另一个 JSON，因此我不想将其反序列化为模型。请注意 API 中的数据结构could改变，但它会always有一个密钥，我可以通过它与我的数据库记录进行比较。

我的代码目前如下所示：

using (WebClient wc = new WebClient())
{
    var rawJsonDownload = wc.DownloadString("WEB API CALL");
    var users =  JsonSerializer.Deserialize<List<UserObject>>(rawJsonDownload);

    foreach (var user in users.ToList())
    {
        //Check if User is new
        if (CHECKS)
        {
            users.Remove(user);
        }
    }

    return Json(users); 
}

这似乎是一个lot为了实现对 Newtonsoft 来说相当微不足道的事情，需要跳过重重困难。

任何人都可以建议我更好的方法来做到这一点 - 并且，理想情况下，不需要UserObject?

您的问题是您想要检索、过滤和传递一些 JSON，而不需要为该 JSON 定义完整的数据模型。通过 Json.NET，您可以使用LINQ 到 JSON https://www.newtonsoft.com/json/help/html/LINQtoJSON.htm以此目的。你的问题是，目前可以轻松解决这个问题吗System.Text.Json?

从 .NET 6 开始，这不能通过以下方式轻松完成System.Text.Json因为它不支持JSONPath https://goessner.net/articles/JsonPath/这在此类应用中通常非常方便。目前有一个未解决的问题将 JsonPath 支持添加到 JsonDocument/JsonElement #41537 https://github.com/dotnet/corefx/issues/41537跟踪这个。

话虽如此，假设您有以下 JSON：

[
  {
    "id": 1,
    "name": "name 1",
    "address": {
      "Line1": "line 1",
      "Line2": "line 2"
    },
    // More properties omitted
  }
  //, Other array entries omitted
]

还有一些Predicate<long> shouldSkip指示条目是否具有特定的过滤器方法id不应返回，对应于CHECKS在你的问题中。你有什么选择？

在 .NET 6 及更高版本中，您可以将 JSON 解析为JsonNode https://learn.microsoft.com/en-us/dotnet/api/system.text.json.nodes.jsonnode?view=net-6.0，编辑其内容，并返回修改后的 JSON。 A JsonNode代表一个editable https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-use-dom-utf8jsonreader-utf8jsonwriter?pivots=dotnet-6-0#create-a-jsonnode-dom-with-object-initializers-and-make-changesJSON 文档对象模型，因此与 Newtonsoft 的最接近JToken https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Linq_JToken.htm等级制度。

以下代码显示了这样的示例：

var root = JsonNode.Parse(rawJsonDownload).AsArray(); // AsArray() throws if the root node is not an array.
for (int i = root.Count - 1; i >= 0; i--)
{
    if (shouldSkip(root[i].AsObject()["id"].GetValue<long>()))
        root.RemoveAt(i);
}

return Json(root);

样机小提琴#1here https://dotnetfiddle.net/HGRDeT

在 .NET Core 3.x 及更高版本中，您可以解析为JsonDocument https://learn.microsoft.com/en-us/dotnet/api/system.text.json.jsondocument并返回一些过滤后的集合JsonElement https://learn.microsoft.com/en-us/dotnet/api/system.text.json.jsonelement nodes。如果过滤逻辑非常简单并且您不需要以任何其他方式修改 JSON，那么这种方法效果很好。但请注意以下限制JsonDocument:

• JsonDocument and JsonElement是只读的。它们只能用于examineJSON 值，不修改或创建 JSON 值。

• JsonDocument是一次性的，实际上必须需要处理最大限度地减少高使用场景中垃圾收集器 (GC) 的影响，根据docs https://learn.microsoft.com/en-us/dotnet/api/system.text.json.jsondocument?view=netcore-3.0#remarks。为了返回一个JsonElement你必须clone https://learn.microsoft.com/en-us/dotnet/api/system.text.json.jsonelement.clone?view=netcore-3.0#System_Text_Json_JsonElement_Clone it.

问题中的过滤场景很简单，可以使用以下代码：

using var usersDocument = JsonDocument.Parse(rawJsonDownload);
var users = usersDocument.RootElement.EnumerateArray()
    .Where(e => !shouldSkip(e.GetProperty("id").GetInt64()))
    .Select(e => e.Clone())
    .ToList();

return Json(users);

模型小提琴#2here https://dotnetfiddle.net/rO10rE.

在任何版本中，您都可以创建一个partial仅反序列化过滤所需的属性的数据模型，其余 JSON 绑定到[JsonExtensionDataAttribute] https://learn.microsoft.com/en-us/dotnet/api/system.text.json.serialization.jsonextensiondataattribute财产。这应该允许您实现必要的过滤，而无需对整个数据模型进行硬编码。

为此，请定义以下模型：

public class UserObject
{
    [JsonPropertyName("id")]
    public long Id { get; set; }
    
    [System.Text.Json.Serialization.JsonExtensionDataAttribute]
    public IDictionary<string, object> ExtensionData { get; set; }
}

并进行反序列化和过滤，如下：

var users = JsonSerializer.Deserialize<List<UserObject>>(rawJsonDownload);
users.RemoveAll(u => shouldSkip(u.Id));

return Json(users);

此方法确保可以适当地反序列化与过滤相关的属性，而无需对 JSON 的其余部分做出任何假设。虽然这不像使用 LINQ to JSON 那么容易，但总代码复杂性受过滤检查的复杂性限制，而不是 JSON 的复杂性。事实上，我的观点是，在实践中，这种方法比JsonDocument方法，因为如果以后需要的话，它可以更容易地注入对 JSON 的修改。

模型小提琴#3here https://dotnetfiddle.net/eDvr7K.

无论你选择哪一个，你可能会考虑放弃WebClient for HttpClient https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netcore-3.0并使用async反序列化。例如。：

var httpClient = new HttpClient(); // Cache statically and reuse in production
var root = await httpClient.GetFromJsonAsync<JsonArray>("WEB API CALL");

Or

using var usersDocument = await JsonDocument.ParseAsync(await httpClient.GetStreamAsync("WEB API CALL"));

Or

var users = await JsonSerializer.DeserializeAsync<List<UserObject>>(await httpClient.GetStreamAsync("WEB API CALL"));

你需要convert https://stackoverflow.com/a/41453278/3744182你的API方法是async以及。