C# 使用 Newtonsoft.Json 进行 JSON 数据存储与转换

在 C# 编程中，JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，易于人阅读和编写，同时也易于机器解析和生成。Newtonsoft.Json 是一个流行的 JSON 框架，它提供了将对象序列化为 JSON 字符串和从 JSON 字符串反序列化为对象的功能。本文将介绍如何在 C# 中使用 Newtonsoft.Json 库来进行 JSON 数据的存储和转换。

一、安装 Newtonsoft.Json

首先，你需要将 Newtonsoft.Json 库添加到你的 C# 项目中。你可以通过 NuGet 包管理器来安装它。在 Visual Studio 中，右键点击你的项目 -> 选择「管理 NuGet 程序包」 -> 搜索「Newtonsoft.Json」 -> 点击「安装」。

二、创建对象并序列化为 JSON 字符串

假设我们有一个简单的 Student 类，它包含 Name 和 Age 两个属性：

public classStudent
{
publicstring Name { get; set; }
publicint Age { get; set; }
}


现在，我们可以创建一个 Student 对象，并使用 Newtonsoft.Json 将其序列化为 JSON 字符串：

using Newtonsoft.Json;
// 创建 Student 对象
Student student = new Student { Name = "张三", Age = 20 };
// 序列化对象为 JSON 字符串
string jsonString = JsonConvert.SerializeObject(student);
// 输出 JSON 字符串
Console.WriteLine(jsonString); // 输出: {"Name":"张三","Age":20}



JsonConvert.SerializeObject 方法接受一个对象作为参数，并返回一个表示该对象的 JSON 格式的字符串。

三、从 JSON 字符串反序列化为对象

如果你有一个 JSON 字符串，并且你想将其转换回一个 Student 对象，你可以使用 JsonConvert.DeserializeObject 方法：

// 假设我们有一个 JSON 字符串
string jsonString = "{\"Name\":\"李四\",\"Age\":22}";
// 从 JSON 字符串反序列化为 Student 对象
Student deserializedStudent = JsonConvert.DeserializeObject<Student>(jsonString);
// 输出反序列化后的对象属性
Console.WriteLine($"Name: {deserializedStudent.Name}, Age: {deserializedStudent.Age}"); // 输出: Name: 李四, Age: 22


JsonConvert.DeserializeObject<T> 方法接受一个 JSON 字符串和一个泛型参数 T ，它指定要反序列化的目标类型。该方法返回一个反序列化后的对象。

四、处理复杂对象和集合

Newtonsoft.Json 也能处理更复杂的对象和集合。例如，如果你有一个包含多个 Student 对象的列表，你可以像这样序列化和反序列化它：

// 创建一个包含多个 Student 对象的列表
List<Student> students = new List<Student>
{
new Student { Name = "王五", Age = 21 },
new Student { Name = "赵六", Age = 23 }
};
// 序列化列表为 JSON 字符串
string jsonStudents = JsonConvert.SerializeObject(students);
Console.WriteLine(jsonStudents); // 输出: [{"Name":"王五","Age":21},{"Name":"赵六","Age":23}]
// 从 JSON 字符串反序列化为 Student 列表
List<Student> deserializedStudents = JsonConvert.DeserializeObject<List<Student>>(jsonStudents);
// 输出反序列化后的列表内容
foreach (var student in deserializedStudents)
{
Console.WriteLine($"Name: {student.Name}, Age: {student.Age}");
}



五、自定义序列化和反序列化行为

有时，你可能需要自定义序列化和反序列化的行为。例如，你可能希望忽略某些属性，或者在反序列化时应用特定的逻辑。Newtonsoft.Json 提供了丰富的特性（如 [JsonIgnore] ）和事件（如 JsonConverter ）来支持这些高级功能。

六、注意事项和最佳实践

七、总结

通过使用 Newtonsoft.Json 库，C# 开发者可以轻松地将对象序列化为 JSON 字符串，以及从 JSON 字符串反序列化为对象。这种能力