c# Newtonsoft.Json 常用方法总结-猿码集

1. 简介

在C#的开发中，我们经常会遇到需要处理JSON数据的情况。Newtonsoft.Json是一个流行的C# JSON库，它提供了一些强大的方法和工具来处理JSON数据。本文将总结一些关于Newtonsoft.Json的常用方法。

2. 序列化和反序列化

2.1 序列化

序列化是将对象转换为JSON格式的过程。Newtonsoft.Json提供了JsonConvert.SerializeObject方法来实现对象的序列化。以下是一个示例：

Person person = new Person
{
    Name = "John Doe",
    Age = 30,
    Address = "123 Main St"
};
string json = JsonConvert.SerializeObject(person);

在上面的示例中，我们首先创建了一个Person对象，然后使用JsonConvert.SerializeObject方法将其序列化为JSON字符串。可以通过调用ToString方法将序列化的结果打印出来。

2.2 反序列化

反序列化是将JSON格式的数据转换为对象的过程。Newtonsoft.Json提供了JsonConvert.DeserializeObject方法来实现反序列化。以下是一个示例：

string jsonString = "{\"Name\":\"John Doe\",\"Age\":30,\"Address\":\"123 Main St.\"}";
Person person = JsonConvert.DeserializeObject<Person>(jsonString);

在上面的示例中，我们首先创建了一个JSON字符串，然后使用JsonConvert.DeserializeObject方法将其反序列化为Person对象。可以通过person对象的属性来访问JSON数据的值。

3. 处理JSON数组

3.1 遍历JSON数组

当处理包含多个对象的JSON数组时，我们可以使用循环来遍历它们。Newtonsoft.Json提供了JArray类来处理JSON数组。以下是一个示例：

string json = "[{\"Name\":\"John Doe\",\"Age\":30},{\"Name\":\"Jane Smith\",\"Age\":25}]";
JArray jsonArray = JArray.Parse(json);
foreach (JObject jsonObject in jsonArray)
{
    string name = (string)jsonObject["Name"];
    int age = (int)jsonObject["Age"];
    // 这里可以对数组中的对象进行处理
}

在上面的示例中，我们首先将JSON字符串解析为JArray对象，然后使用foreach循环遍历每个JObject对象。通过访问JObject对象的属性，我们可以获取每个对象中的值。

3.2 向JSON数组中添加对象

我们可以使用JArray的Add方法来向JSON数组中添加新的对象。以下是一个示例：

JArray jsonArray = new JArray();
JObject jsonObject1 = new JObject();
jsonObject1["Name"] = "John Doe";
jsonObject1["Age"] = 30;
jsonArray.Add(jsonObject1);
JObject jsonObject2 = new JObject();
jsonObject2["Name"] = "Jane Smith";
jsonObject2["Age"] = 25;
jsonArray.Add(jsonObject2);
string json = jsonArray.ToString();

在上面的示例中，我们首先创建了一个空的JArray对象，然后创建了两个JObject对象，并将它们添加到JArray中。最后，我们可以通过调用ToString方法将JArray对象转换为JSON字符串。

4. 处理复杂的JSON结构

4.1 获取嵌套属性的值

当处理复杂的JSON结构时，我们可能需要获取嵌套属性的值。Newtonsoft.Json提供了SelectToken方法来实现这一功能。以下是一个示例：

string json = "{\"Name\":\"John Doe\",\"Address\":{\"Street\":\"123 Main St\",\"City\":\"New York\"}}";
JObject jsonObject = JObject.Parse(json);
string street = (string)jsonObject.SelectToken("Address.Street");
string city = (string)jsonObject.SelectToken("Address.City");

在上面的示例中，我们首先将JSON字符串解析为JObject对象，然后使用SelectToken方法获取嵌套属性的值。

4.2 处理空值

在处理JSON数据时，我们可能会遇到空值的情况。Newtonsoft.Json提供了一些方法来处理空值。例如，我们可以使用NullValueHandling枚举来设置在序列化时忽略空值。以下是一个示例：

Person person = new Person
{
    Name = null,
    Age = 30,
    Address = null
};
string json = JsonConvert.SerializeObject(person, new JsonSerializerSettings
{
    NullValueHandling = NullValueHandling.Ignore
});

在上面的示例中，我们创建了一个Person对象并设置其属性为null。通过在JsonSerializerSettings中设置NullValueHandling为Ignore，我们可以在序列化时忽略空值。

5. 总结

本文总结了一些关于Newtonsoft.Json的常用方法，包括序列化和反序列化、处理JSON数组和复杂的JSON结构等。通过使用这些方法，我们可以方便地处理JSON数据，并在C#的开发中更加灵活地使用JSON。

参考资料

- Newtonsoft.Json官方文档：https://www.newtonsoft.com/json

- C# Newtonsoft.Json库：https://www.newtonsoft.com/json

c# Newtonsoft.Json 常用方法总结