在C#中读取和解析JSON文件是开发中常见的需求,比如读取配置文件、处理Web API返回的数据等。下面介绍几种常用的C#读取JSON文件的方法,适合不同场景使用。
1. 使用System.Text.Json(.NET Core 3.0+推荐)
System.Text.Json 是微软官方推荐的高性能JSON库,内置于.NET Core 3.0及以上版本,无需额外安装包。
基本步骤:
读取JSON文件内容为字符串 使用 JsonSerializer.Deserialize示例代码:
using System;
using System.IO;
using System.Text.Json;
// 定义一个类来映射JSON结构
public class Person
{
public string Name { get; set; }
public int Age { get; set; }
}
// 读取JSON文件
string jsonString = File.ReadAllText("person.json");
Person person = JsonSerializer.Deserialize<Person>(jsonString);
Console.WriteLine($"姓名: {person.Name}, 年龄: {person.Age}");
注意:确保JSON文件编码为UTF-8,且类属性名与JSON字段匹配(或使用[JsonPropertyName]特性指定映射)。
2. 使用Newtonsoft.Json(Json.NET)
Newtonsoft.Json 是最流行的第三方JSON库,功能强大,兼容性好,适用于所有.NET版本。
需要通过NuGet安装:Install-Package Newtonsoft.Json
示例代码:
using Newtonsoft.Json;
string jsonString = File.ReadAllText("person.json");
Person person = JsonConvert.DeserializeObject<Person>(jsonString);
Console.WriteLine($"姓名: {person.Name}, 年龄: {person.Age}");
支持复杂类型、嵌套对象、集合反序列化,也支持通过[JsonProperty]设置字段别名。
3. 读取动态JSON(不定义类)
如果不想定义实体类,可以使用动态类型解析JSON。
使用 Newtonsoft.Json.Linq:
using Newtonsoft.Json.Linq;
string jsonString = File.ReadAllText("person.json");
JObject jObject = JObject.Parse(jsonString);
string name = jObject["Name"].ToString();
int age = jObject["Age"].Value<int>();
Console.WriteLine($"姓名: {name}, 年龄: {age}");
适用于结构不固定或临时解析的场景,灵活性高,但失去编译时检查。
4. 处理数组型JSON文件
如果JSON文件是一个对象数组,例如:
[
{ "Name": "张三", "Age": 25 },
{ "Name": "李四", "Age": 30 }
]
可以用以下方式读取:
List<Person> people = JsonSerializer.Deserialize<List<Person>>(jsonString); // 或使用Json.NET List<Person> people = JsonConvert.DeserializeObject<List<Person>>(jsonString);
遍历即可获取每个对象。
基本上就这些常用方法。选择哪种方式取决于你的项目环境:新项目建议用System.Text.Json,老项目或需要高级功能可继续用Newtonsoft.Json。关键是结构匹配、字段名称一致,读取文件前确保路径正确。
