Json.net 常用使用小结(推荐)

### Json.NET 常用使用小结 #### 一、简介 Json.NET 是一个非常流行的 .NET 库，用于处理 JSON 数据。它由 James Newton-King 创建并维护，因此也被称作 Newtonsoft。Json.NET 提供了强大的功能来帮助开发者轻松地序列化 .NET 对象到 JSON 格式，并能将 JSON 反序列化回 .NET 对象。 #### 二、基本概念 在深入探讨 Json.NET 的具体使用之前，我们先了解几个基础概念： 1. **序列化**：将对象转换为 JSON 格式的过程。 2. **反序列化**：将 JSON 格式的数据转换为对象的过程。 3. **JsonConvert**：Json.NET 提供的核心类，用于执行序列化和反序列化操作。 4. **Formatting.Indented**：用于美化输出的 JSON 格式，使其更易读。 #### 三、序列化与反序列化示例 ##### 3.1 序列化示例 下面的代码展示了如何使用 Json.NET 进行序列化： ```csharp public string TestJsonSerialize() { Product product = new Product(); product.Name = "Apple"; product.Expiry = DateTime.Now.AddDays(3).ToString("yyyy-MM-dd hh:mm:ss"); product.Price = 3.99M; // 使用 Formatting.Indented 进行美化输出 string json = Newtonsoft.Json.JsonConvert.SerializeObject(product, Newtonsoft.Json.Formatting.Indented); return string.Format("<p>{0}</p>", json); } ``` 在这个示例中，`Product` 类包含 `Name`、`Expiry` 和 `Price` 属性。通过调用 `JsonConvert.SerializeObject` 方法，我们可以将这个对象序列化成 JSON 格式，并通过 `Formatting.Indented` 参数来美化输出结果，使得 JSON 更加易读。 ##### 3.2 反序列化示例 对于反序列化操作，Json.NET 同样提供了简洁的 API： ```csharp public string TestJsonDeserialize() { string jsonString = "{\"Name\":\"Apple\",\"Expiry\":\"2023-08-15 12:00:00\",\"Price\":3.99}"; // 将 JSON 字符串反序列化为 Product 对象 Product product = Newtonsoft.Json.JsonConvert.DeserializeObject<Product>(jsonString); return string.Format("<p>Name: {0}, Expiry: {1}, Price: {2}</p>", product.Name, product.Expiry, product.Price); } ``` 在此示例中，我们首先定义了一个 JSON 字符串，然后使用 `JsonConvert.DeserializeObject` 方法将其反序列化为 `Product` 类型的对象。我们打印出对象的属性值。 #### 四、自定义转换器 Json.NET 还支持创建自定义转换器来处理特定类型的序列化和反序列化。例如，在给定的部分内容中，定义了一个 `PersonConverter` 类，继承自 `CustomCreationConverter<IPerson>`，并在其中重写了 `Create` 方法： ```csharp public class PersonConverter : Newtonsoft.Json.Converters.CustomCreationConverter<IPerson> { public override IPerson Create(Type objectType) { return new Employee(); // 当需要创建 IPerson 实例时，返回 Employee 类型的对象 } } ``` 这使得在序列化和反序列化过程中能够自动处理 `IPerson` 接口的实例。 #### 五、序列化列表 除了单个对象之外，Json.NET 还可以很容易地序列化和反序列化对象列表。例如： ```csharp public string TestListJsonSerialize() { Product product = new Product(); product.Name = "Apple"; product.Expiry = DateTime.Now.AddDays(3).ToString("yyyy-MM-dd hh:mm:ss"); product.Price = 3.99M; product.Sizes = new string[] { "Small", "Medium", "Large" }; List<Product> productList = new List<Product>(); productList.Add(product); productList.Add(product); // 序列化对象列表 string json = Newtonsoft.Json.JsonConvert.SerializeObject(productList, Newtonsoft.Json.Formatting.Indented); return string.Format("<p>{0}</p>", json); } ``` 此示例展示了如何序列化一个包含多个 `Product` 对象的列表，并同样使用了 `Formatting.Indented` 参数来进行格式化。 #### 六、总结 通过以上介绍，我们可以看到 Json.NET 提供了非常灵活且强大的功能来处理 JSON 数据。无论是简单的对象还是复杂的列表，甚至是自定义转换器，Json.NET 都能轻松应对。对于 .NET 开发者来说，掌握 Json.NET 的使用是非常重要的技能之一。