C#中读取和修改JSON文件

简介：
本文将详细介绍如何在C#编程语言中使用各种方法来读取、解析以及修改JSON格式的数据文件。通过实例代码展示操作技巧与应用实践。 在C#编程中处理JSON（JavaScript Object Notation）文件是一项常见的任务，因为JSON是一种轻量级的数据交换格式，在API数据传输和配置文件存储方面得到了广泛应用。本段落将深入探讨如何使用C#读取和修改JSON文件，并介绍相关的库和方法。 尽管.NET Framework没有内置支持对JSON的处理，但自.NET Core起引入了System.Text.Json作为官方推荐的JSON处理库。然而，许多开发者由于其丰富的功能和易用性而更倾向于选择第三方库如Newtonsoft.Json（也称为Json.NET）来操作JSON数据。 **读取JSON文件** 1. **使用System.Text.Json** - `using System.Text.Json;` - 通过`File.ReadAllText(path_to_file.json);` 将文件内容读为字符串。 - 使用`JsonDocument.Parse(jsonString)` 解析该字符串，创建一个支持流式处理的内存占用小的JsonDocument对象。 - 利用`doc.RootElement` 访问根元素，并遍历或查询JSON结构。 2. **使用Newtonsoft.Json** - `using Newtonsoft.Json;` - 通过`File.ReadAllText(path_to_file.json);` 将文件内容读为字符串。 - 使用`JObject.Parse(jsonString)` 解析该字符串，创建一个动态的JObject对象以方便地访问属性值。 - 或者使用`JArray.Parse(jsonString)` 如果JSON数据是数组形式。 **修改JSON文件** 1. **使用System.Text.Json** - 修改JsonDocument后需要重新序列化才能保存： ```csharp JsonSerializerOptions options = new JsonSerializerOptions { WriteIndented = true }; string updatedJson = JsonSerializer.Serialize(doc.RootElement, options); File.WriteAllText(path_to_file.json, updatedJson); ``` 2. **使用Newtonsoft.Json** - 直接修改JObject或JArray，然后保存： ```csharp obj[propertyName] = newValue; obj.Save(path_to_file.json); // 直接将对象保存回文件。 ``` **高级操作** - **序列化和反序列化对象**：通过C#对象转换为JSON字符串或将JSON字符串还原成C#对象来实现数据的存储与恢复。 - Newtonsoft.Json: ```csharp string serializedObj = JsonConvert.SerializeObject(yourObject); YourClass yourDeserializedObj = JsonConvert.DeserializeObject(jsonString); ``` - System.Text.Json: ```csharp string serializedObj = JsonSerializer.Serialize(yourObject); YourClass yourDeserializedObj = JsonSerializer.Deserialize(jsonString); ``` - **LINQ查询**：使用Newtonsoft.Json的LINQ扩展，可以方便地进行JSON数据查询。 - 示例： ```csharp var result = obj.Descendants().Where(x => x.Type == JTokenType.String).Select(x => x.Value()); ``` - **自定义转换器**：为了满足特殊需求，可以通过创建自定义的JsonConverter类来处理特定类型的序列化和反序列化。 总结而言，在使用C#进行JSON文件操作时，可以根据项目需求选择System.Text.Json或Newtonsoft.Json。前者更适合于简单的场景应用，而后者则提供了更多的灵活性与控制权。理解这些基本的操作方法及概念有助于在实际开发中高效地管理和处理JSON数据。