net如何获取json数据

.NET 开发指南：高效获取与处理 JSON 数据**

在当今的 Web 开发和数据交互领域，JSON（JavaScript Object Notation）以其轻量级、易读易写的特性，已成为数据交换的主流格式之一。.NET 框架为处理 JSON 数据提供了强大而便捷的支持，本文将详细介绍在 .NET 中如何从各种来源获取 JSON 数据，并将其解析为可用的 .NET 对象。

为什么选择 JSON？

在探讨如何获取 JSON 之前，简单回顾一下 JSON 的优势：

• 轻量级：相比 XML，JSON 的更简洁，解析速度更快,占用带宽更少。
• 易读易写：JSON 的结构清晰，易于人类阅读和编写,也易于机器解析和生成。
• 语言无关：虽然起源于 JavaScript，但 JSON 是一种独立于语言的数据格式,几乎所有主流编程语言都支持。
• 原生支持：.NET 对 JSON 提供了原生且高效的支持。

.NET 中获取 JSON 数据的主要方法

在 .NET 中获取 JSON 数据通常涉及以下几个步骤：

1. 获取 JSON 字符串或数据流：这可能来自 Web API 响应、文件、数据库或其他数据源。
2. 选择 JSON 序列化/反序列化库：.NET 提供了多个内置和第三方库用于此目的。
3. 将 JSON 数据反序列化为 .NET 对象：这是最核心的一步，将 JSON 文本转换为强类型的 .NET 对象（如类、结构体、集合等）,方便后续操作。

使用 System.Text.Json (推荐，.NET Core 3.0+ 及 .NET 5/6/7/8 默认)

System.Text.Json 是 .NET 官方推出的现代化 JSON 库，性能优异,功能齐全。

准备工作

确保你的项目引用了 System.Text.Json 命名空间：

using System.Text.Json;
using System.Text.Json.Serialization;

定义与 JSON 对应的 .NET 模型类

为了反序列化，你需要创建一个或多个 .NET 类，其结构与 JSON 数据的结构相匹配，对于如下 JSON：

{
  "name": "张三",
  "age": 30,
  "isStudent": false,
  "courses": ["数学", "物理", "化学"]
}

你可以定义如下模型类：

public class Person
{
    [JsonPropertyName("name")]
    public string Name { get; set; }
    [JsonPropertyName("age")]
    public int Age { get; set; }
    [JsonPropertyName("isStudent")]
    public bool IsStudent { get; set; }
    [JsonPropertyName("courses")]
    public List<string> Courses { get; set; }
}

[JsonPropertyName] 特性用于指定 JSON 属性名与 .NET 属性名之间的映射（如果不指定，默认使用 .NET 属性名，遵循 PascalCase，而 JSON 通常是 camelCase）。

从字符串获取并反序列化 JSON

string jsonString = @"{
  ""name"": ""李四"",
  ""age"": 25,
  ""isStudent"": true,
  ""courses"": [""历史"", ""地理""]
}";
try
{
    Person person = JsonSerializer.Deserialize<Person>(jsonString);
    Console.WriteLine($"姓名: {person.Name}, 年龄: {person.Age}, 是否学生: {person.IsStudent}");
    Console.WriteLine("课程: " + string.Join(", ", person.Courses));
}
catch (JsonException ex)
{
    Console.WriteLine($"JSON 反序列化失败: {ex.Message}");
}

从 URL (Web API) 获取并反序列化 JSON

通常我们会使用 HttpClient 来获取 Web API 返回的 JSON 数据。

using System.Net.Http;
using System.Threading.Tasks;
public async Task GetJsonFromApiAsync()
{
    using (HttpClient client = new HttpClient())
    {
        try
        {
            string apiUrl = "https://api.example.com/data"; // 替换为实际的 API URL
            HttpResponseMessage response = await client.GetAsync(apiUrl);
            response.EnsureSuccessStatusCode(); // 确保请求成功
            string jsonString = await response.Content.ReadAsStringAsync();
            Person person = JsonSerializer.Deserialize<Person>(jsonString);
            Console.WriteLine($"从 API 获取的数据: 姓名: {person.Name}");
        }
        catch (HttpRequestException ex)
        {
            Console.WriteLine($"HTTP 请求失败: {ex.Message}");
        }
        catch (JsonException ex)
        {
            Console.WriteLine($"JSON 反序列化失败: {ex.Message}");
        }
    }
}

从文件读取并反序列化 JSON

using System.IO;
public void GetJsonFromFile()
{
    string filePath = "person.json"; // JSON 文件路径
    try
    {
        string jsonString = File.ReadAllText(filePath);
        Person person = JsonSerializer.Deserialize<Person>(jsonString);
        Console.WriteLine($"从文件获取的数据: 姓名: {person.Name}");
    }
    catch (FileNotFoundException ex)
    {
        Console.WriteLine($"文件未找到: {ex.Message}");
    }
    catch (JsonException ex)
    {
        Console.WriteLine($"JSON 反序列化失败: {ex.Message}");
    }
}

使用 Newtonsoft.Json (经典选择，广泛使用)

Newtonsoft.Json（也称为 Json.NET）是 .NET 社区长期使用的 JSON 库，功能非常丰富,拥有大量文档和社区支持。

准备工作

需要通过 NuGet 包管理器安装 Newtonsoft.Json 包：

Install-Package Newtonsoft.Json

然后引入命名空间：

using Newtonsoft.Json;

定义模型类 (与 System.Text.Json 类似)

public class PersonNewtonsoft
{
    [JsonProperty("name")]
    public string Name { get; set; }
    [JsonProperty("age")]
    public int Age { get; set; }
    [JsonProperty("isStudent")]
    public bool IsStudent { get; set; }
    [JsonProperty("courses")]
    public List<string> Courses { get; set; }
}

这里使用 [JsonProperty] 特性。

从字符串获取并反序列化 JSON

string jsonStringNewtonsoft = @"{
  ""name"": ""王五"",
  ""age"": 28,
  ""isStudent"": false,
  ""courses"": [""美术"", ""音乐""]
}";
PersonNewtonsoft personNewtonsoft = JsonConvert.DeserializeObject<PersonNewtonsoft>(jsonStringNewtonsoft);
Console.WriteLine($"Newtonsoft: 姓名: {personNewtonsoft.Name}, 年龄: {personNewtonsoft.Age}");

从 URL 获取并反序列化 JSON (使用 HttpClient)

与 System.Text.Json 类似，只是反序列化方法换为 JsonConvert.DeserializeObject。

public async Task GetJsonFromApiNewtonsoftAsync()
{
    using (HttpClient client = new HttpClient())
    {
        try
        {
            string apiUrl = "https://api.example.com/data";
            HttpResponseMessage response = await client.GetAsync(apiUrl);
            response.EnsureSuccessStatusCode();
            string jsonString = await response.Content.ReadAsStringAsync();
            PersonNewtonsoft person = JsonConvert.DeserializeObject<PersonNewtonsoft>(jsonString);
            Console.WriteLine($"Newtonsoft 从 API 获取: 姓名: {person.Name}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"发生错误: {ex.Message}");
        }
    }
}

选择哪个库？

• System.Text.Json：

  • 优点：.NET 官方出品，性能优异，内存占用低，与 .NET Core/.NET 5+ 深度集成，无需额外安装（新项目默认）。
  • 缺点：相比 Newtonsoft.Json，功能可能稍少（但一直在增强），API 风格可能对习惯 Newtonsoft.Json 的开发者来说需要一点适应。
  • 推荐：新项目优先选择，尤其是追求性能和对 .NET 新版本特性有要求的场景。

• Newtonsoft.Json：

  • 优点：功能极其丰富，社区庞大，文档齐全，稳定可靠,很多老项目都在使用。
  • 缺点：需要额外安装 NuGet 包，性能略逊于 System.Text.Json（但差距通常不大）。
  • 推荐：维护老项目、或需要 System.Text.Json 尚未支持的某些高级特性时使用。

总结与最佳实践

在 .NET 中获取 JSON 数据是一项基本且重要的技能，无论是使用现代的 System.Text.Json 还是经典的 Newtonsoft.Json,都能高效地完成任务。

最佳实践：

1. 定义强类型模型：尽量为 JSON 数据定义对应的 .NET 类,这能提供编译时检查和更好的代码可维护性。
2. 错误处理：网络请求和 JSON 解析都可能失败，务必使用 try-catch 块进行适当的错误处理。
3. 异步操作：对于 I/O 密集型操作