全面掌握C#的JObject类：C#开发之JSON数据解析与操作实战指南

using Newtonsoft.Json.Linq;

string json = @"{ 'name': 'John', 'age': 30 }";
JObject jsonObject = JObject.Parse(json);

Console.WriteLine(jsonObject["name"]);  // 输出: John
Console.WriteLine(jsonObject["age"]);   // 输出: 30

从文件加载JSON数据

如果JSON数据存储在文件中，可以读取文件内容并解析：

using Newtonsoft.Json.Linq;
using System.IO;

string json = File.ReadAllText("data.json");
JObject jsonObject = JObject.Parse(json);

// 处理 jsonObject

创建JObject

除了解析JSON字符串，还可以手动创建JObject：

using Newtonsoft.Json.Linq;

JObject jsonObject = new JObject
{
    { "name", "Alice" },
    { "age", 25 },
    { "skills", new JArray("C#", "JavaScript", "SQL") }
};

Console.WriteLine(jsonObject.ToString());

4. 访问和操作JSON数据

访问属性

可以使用索引器通过属性名称访问值：

string name = (string)jsonObject["name"];
int age = (int)jsonObject["age"];

Console.WriteLine($"Name: {name}, Age: {age}");

获取嵌套属性

对于嵌套的JSON对象，可以通过连锁索引器访问：

string nestedJson = @"{
    'person': {
        'name': 'Alice',
        'age': 25
    }
}";
JObject jsonObject = JObject.Parse(nestedJson);

string personName = (string)jsonObject["person"]["name"];
int personAge = (int)jsonObject["person"]["age"];

Console.WriteLine($"Person Name: {personName}, Age: {personAge}");

或者使用SelectToken方法，支持使用路径表达式：

string personName = (string)jsonObject.SelectToken("person.name");
int personAge = (int)jsonObject.SelectToken("person.age");

使用方法获取值

JObject提供了多种方法来获取值，如Value<T>、GetValue等：

string name = jsonObject.Value<string>("name");
int age = jsonObject.Value<int>("age");

// 或者
string name = (string)jsonObject.GetValue("name");
int age = (int)jsonObject.GetValue("age");

处理数组

JSON中的数组对应JArray对象：

string jsonWithArray = @"{
    'name': 'John',
    'skills': ['C#', 'JavaScript', 'SQL']
}";
JObject jsonObject = JObject.Parse(jsonWithArray);
JArray skills = (JArray)jsonObject["skills"];

foreach (var skill in skills)
{
    Console.WriteLine(skill);
}

或者使用LINQ：

var skills = jsonObject["skills"].Select(skill => (string)skill);
foreach (var skill in skills)
{
    Console.WriteLine(skill);
}

5. 修改JSON数据

添加新属性

可以向JObject中添加新属性：

jsonObject["newProperty"] = "New Value";
// 或者
jsonObject.Add("newProperty", "New Value");

更新现有属性

直接赋值即可更新属性：

jsonObject["age"] = 31;

删除属性

使用Remove方法删除属性：

jsonObject.Remove("age");

6. 遍历JObject

你可以遍历JObject的属性，访问键值对：

foreach (var property in jsonObject.Properties())
{
    string propName = property.Name;
    JToken propValue = property.Value;

    Console.WriteLine($"{propName}: {propValue}");
}

或者通过键值对：

foreach (var pair in jsonObject)
{
    string key = pair.Key;
    JToken value = pair.Value;

    Console.WriteLine($"{key}: {value}");
}

7. LINQ to JSON

JObject支持使用LINQ查询JSON数据，提供了强大的数据筛选和操作能力。

示例：筛选特定条件的数据

假设有如下JSON数组：

string json = @"{
    'employees': [
        { 'name': 'John', 'age': 30, 'department': 'HR' },
        { 'name': 'Jane', 'age': 25, 'department': 'IT' },
        { 'name': 'Bob', 'age': 35, 'department': 'IT' }
    ]
}";
JObject jsonObject = JObject.Parse(json);

// 查找所有在IT部门的员工
var itEmployees = jsonObject["employees"]
    .Where(emp => (string)emp["department"] == "IT");

foreach (var emp in itEmployees)
{
    Console.WriteLine(emp["name"]);  // 输出: Jane, Bob
}

使用`SelectTokens`

SelectTokens方法允许使用JSON路径查询，支持通配符等高级功能：

// 获取所有员工的名字
var names = jsonObject.SelectTokens("$.employees[*].name");

foreach (var name in names)
{
    Console.WriteLine(name);
}

8. 序列化和反序列化

将JObject序列化为JSON字符串

string serializedJson = jsonObject.ToString();
Console.WriteLine(serializedJson);

可以指定格式化选项：

string indentedJson = jsonObject.ToString(Newtonsoft.Json.Formatting.Indented);
Console.WriteLine(indentedJson);

从C#对象反序列化为JObject

var person = new
{
    name = "Alice",
    age = 25,
    skills = new[] { "C#", "JavaScript" }
};

JObject jsonObject = JObject.FromObject(person);
Console.WriteLine(jsonObject.ToString());

反序列化到C#类

虽然JObject提供了灵活性，但在某些情况下，将JSON数据强类型化为C#类更为合适。以下是一个示例：

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

// 反序列化
Person person = jsonObject.ToObject<Person>();
Console.WriteLine($"{person.Name}, {person.Age}");

9. 错误处理与验证

在解析JSON时，可能会遇到无效的JSON格式或类型不匹配的问题。以下是一些常见的错误处理方法：

解析无效JSON

使用TryParse方法（需要手动实现）或捕获异常：

try
{
    JObject jsonObject = JObject.Parse(invalidJson);
}
catch (JsonReaderException ex)
{
    Console.WriteLine($"JSON解析错误: {ex.Message}");
}

类型转换错误

当访问属性时，如果类型不匹配，会抛出异常或导致默认值：

// 安全获取字符串值
string name = jsonObject["name"]?.ToString();

// 安全获取整数值，带默认值
int age = jsonObject["age"]?.Value<int>() ?? 0;

用`TryGetValue`

JObject提供了TryGetValue方法，可以安全地尝试获取属性值：

if (jsonObject.TryGetValue("name", out JToken nameToken))
{
    string name = (string)nameToken;
    Console.WriteLine(name);
}
else
{
    Console.WriteLine("属性 'name' 不存在");
}

10. 性能考虑

虽然JObject提供了高度的灵活性，但在处理大型JSON数据或在性能敏感的应用中，可能会遇到性能瓶颈。以下是一些优化建议：

预先定义C#类：如果JSON结构固定，使用强类型的C#类进行序列化/反序列化通常更高效。
```
Person person = JsonConvert.DeserializeObject<Person>(jsonString);
```

避免不必要的解析：仅解析需要的部分，而不是整个JSON结构。例如，使用JsonTextReader进行逐行读取。

using (var stringReader = new StringReader(json))
using (var jsonReader = new JsonTextReader(stringReader))
{
    while (jsonReader.Read())
    {
        // 处理需要的部分
    }
}

缓存解析结果：如果需要多次访问相同的JSON数据，考虑缓存已解析的JObject实例。

11. 最佳实践

使用强类型对象：当JSON结构已知且固定时，使用强类型的C#类有助于代码的可维护性和性能。
处理可选属性：在访问JSON属性时，使用安全访问方式以处理缺失或可选的属性。
```
string middleName = jsonObject["middleName"]?.ToString();
```
利用LINQ：充分利用LINQ的强大功能，简化复杂的数据查询和操作。
异常处理：在解析和操作JSON数据时，始终添加适当的异常处理逻辑，以防止应用崩溃。
格式化输出：在序列化JSON时，根据需要选择是否进行格式化，以平衡可读性和性能。
```
string compactJson = jsonObject.ToString(Newtonsoft.Json.Formatting.None);
```
使用JToken替代JObject：在某些场景下，使用JToken可以提供更大的灵活性，尤其是在处理未知或动态的JSON结构时。

12. 完整示例

以下是一个综合示例，涵盖了JObject的多种用法：

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.IO;
using System.Linq;

class Program
{
    static void Main()
    {
        // 示例JSON
        string json = @"{
            'name': 'John Doe',
            'age': 30,
            'address': {
                'street': '123 Main St',
                'city': 'Anytown',
                'zip': '12345'
            },
            'emails': [
                'john.doe@example.com',
                'jdoe@workplace.com'
            ],
            'skills': ['C#', 'JavaScript', 'SQL']
        }";

        // 解析JSON字符串
        JObject jsonObject = JObject.Parse(json);

        // 访问属性
        string name = (string)jsonObject["name"];
        int age = (int)jsonObject["age"];
        Console.WriteLine($"Name: {name}, Age: {age}");

        // 访问嵌套属性
        string city = (string)jsonObject["address"]["city"];
        Console.WriteLine($"City: {city}");

        // 访问数组
        JArray emails = (JArray)jsonObject["emails"];
        Console.WriteLine("Emails:");
        foreach (var email in emails)
        {
            Console.WriteLine($" - {email}");
        }

        // 添加新属性
        jsonObject["isActive"] = true;

        // 修改属性
        jsonObject["age"] = 31;

        // 删除属性
        jsonObject.Remove("address");

        // 遍历所有属性
        Console.WriteLine("All properties:");
        foreach (var prop in jsonObject.Properties())
        {
            Console.WriteLine($"{prop.Name}: {prop.Value}");
        }

        // 使用LINQ查询技能中包含'SQL'的项目
        var sqlSkills = jsonObject["skills"]
            .Where(skill => skill.ToString().Contains("SQL"))
            .Select(skill => skill.ToString());

        Console.WriteLine("Skills containing 'SQL':");
        foreach (var skill in sqlSkills)
        {
            Console.WriteLine($" - {skill}");
        }

        // 序列化回JSON字符串
        string updatedJson = jsonObject.ToString(Formatting.Indented);
        Console.WriteLine("Updated JSON:");
        Console.WriteLine(updatedJson);

        // 从C#对象创建JObject
        var newPerson = new
        {
            name = "Alice Smith",
            age = 28,
            hobbies = new[] { "Reading", "Hiking" }
        };
        JObject newPersonObject = JObject.FromObject(newPerson);
        Console.WriteLine("New Person JSON:");
        Console.WriteLine(newPersonObject.ToString());
    }
}

输出：

Name: John Doe, Age: 30
City: Anytown
Emails:
 - john.doe@example.com
 - jdoe@workplace.com
All properties:
name: "John Doe"
age: 31
emails: [
  "john.doe@example.com",
  "jdoe@workplace.com"
]
skills: [
  "C#",
  "JavaScript",
  "SQL"
]
isActive: true
Skills containing 'SQL':
 - SQL
Updated JSON:
{
  "name": "John Doe",
  "age": 31,
  "emails": [
    "john.doe@example.com",
    "jdoe@workplace.com"
  ],
  "skills": [
    "C#",
    "JavaScript",
    "SQL"
  ],
  "isActive": true
}
New Person JSON:
{
  "name": "Alice Smith",
  "age": 28,
  "hobbies": [
    "Reading",
    "Hiking"
  ]
}

13. 总结

JObject类是Json.NET库中处理JSON数据的核心组件之一，提供了丰富的功能来解析、查询和操作JSON对象。通过灵活的API和对LINQ的支持，JObject使得在C#中处理复杂的JSON结构变得简单而高效。然而，在使用JObject时，也应权衡其灵活性与性能，特别是在处理大型或性能敏感的应用场景中。

无论是简单的JSON解析还是复杂的数据操作，掌握JObject的使用方法都将极大地提升你在C#中处理JSON数据的能力。希望本文提供的详细指南能帮助你更好地理解和应用JObject类。