C#解析JSON数据全攻略指南

2025-07-22 19:50

本文主要是介绍C#解析JSON数据全攻略指南,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《C#解析JSON数据全攻略指南》这篇文章主要为大家详细介绍了使用C#解析JSON数据全攻略指南,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下...

还在为C#处理网络API返回的复杂JSON数据头疼吗?据统计,90%的开发者都曾在JSON解析上栽过跟头!

本文将手把手教你用C#轻松玩转JSON数据:

- HttpClient获取网络JSON数据

- System.Text.Json动态解析技巧

- 强类型模型转换js实战

- 特殊字符/日期格式处理方案

- 完整可运行代码示例

一、为什么JSON是C#开发必修课?

现代Web API中95%的数据交换采用JSON格式。无论是调用天气API、支付接口,还是处理云服务返回数据,JSON解析都是核心技能!

二、四步搞定网络JSON数据

1. 获取数据 - HttpClient最佳实践

using var httpClient = new HttpClient();
var response = await httpClient.GetAsync("https://api.example.com/data");
var jsonString = await response.Content.ReadAsStringAsync();

关键点:使用using自动释放资源,异步方法提升性能

2. 动态解析 - 快速读取字段

using System.Text.Json;
var jsonDoc = JsonDocument.Parse(jsonString);
string name = jsonDoc.RootElement
                .GetProperty("user")
                .GetProperty("name")
                .GetString();

适用场景:快速提取少量字段,无需创建完整模型

3. 强类型解析 - 推荐方案!

public class User {
    public string Name { get; set; }
    public int Age { get; set; }
    public DateTime RegisterDate { get; set; }
}

var user = JsonSerializer.Deserialize<User>(jsonString, new JsonSerializerOptions {
    PropertyNameCaseInsensitive = true // 忽略大小写
});

优势:编译时检查 + 智能提示 + 高可维护性

4. 特殊场景处理

日期格式转换:

options.Converters.Add(new DateTimeConverter("yyyy-MM-dd"));

处理JSON注释:

options.ReadCommentHandling = JsonCommentHandling.Skip;

三、避坑指南

- NULL引用异常:给属性设置默认值 public string Name { get; set; } = string.Empty;

- 字段缺失:使用[JsonIgnore]忽略不存在的属性

- 性能陷阱:大文件解析用JsonDocument替代JObject

四、完整代码示例

using System.Text.Json;

public async Task<WeatherData> GetWeatherAsync() {
    using var httpClient = new HttpClient();
    
    // 获取杭州天气数据
    var response = await httpClient.GetAsync(
        "https://api.weather.com/v3?location=hangzhou");
    
    response.EnsureSuccessStatusCode();
    var json = await response.Content.ReadAsStringAsync();
    
    // 强类型解析
    return JsonSerializer.Deserialize<WeatherData>(json, new JsonSerializerOptions {
        PropertyNameCaseInsensitive = true,
        NumberHandling = JsonNumberHandling.AllowReadingFromString
    });
}

// 定义数据模型
public class WeatherData {
    public string Location { get; set; } = string.Empty;
    public double Temperature { get; set; }
    public string Unit { get; set; } = "Celsius";
    [JsonPropertyName("wind_speed")]
    public double WindSpeed { get; set; }
}

五、知识延展

C#中处理JSON数据的方式

1.将对象序列化为JSON字符串

在C#中,可以使用System.Text.JsonNewtonsoft.Json这两个流行的库来将对象序列化为JSON字符串。以下是使用这两个库进行序列化的示例代码:

using System;
using System.Text.Json;
using Newtonsoft.Json;

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

public class Program
{
    public static void Main()
    {
        Person person = new Person { Name = "John Doe", Age = 30 };

        // 使用System.Text.Json库进行序列化
        string json1 = JsonSerializer.Serialize(person);
        Console.WriteLine(json1);

        // 使用Newtonsoft.Json库进行序列化
        string json2 = JsonConvert.SerializeObject(person);
        Console.WriteLine(json2);
    }
}

2.将JSON字符串反序列化为对象

与将对象序列化为JSON字符串相反,C#中也可以使用System.Texhttp://www.chinasem.cnt.JsonNewtonsoft.Json来将JSON字符串反序列化为对象。以下是使用这两个库进行反序列化的示例代码:

using System;
using System.Text.Json;
using Newtonsoft.Json;

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

public class Program
{
    public static void Main()
    {
        string json = "{\"Name\":\"John Doe\",\"Age\":30}";

        // 使用System.Text.Json库进行反序列化
        Person person1 = JsonSerializer.Deserialize<Person>(json);
        Console.WriteLine(person1.Name);
        Console.WriteLine(person1.Age);

        // 使用Newtonsoft.Json库进行反序列化
        Person person2 = JsonConvert.DeserializeObject<Person>(json);
        Console.WriteLine(person2.Name);
        Console.WriteLine(person2.Age);
    }
}

3.对JSON进行查询和筛选

在C#中,我们可以使用LINQ(Language-Integrated Query)来对JSON进行查询和筛选。通过使用SelectToken方法和JsonPath表达式,我们可以方便地访问和操作嵌套的JSON属性。以下是一个使用LINQ查询和筛选JSON的示例:

using System;
using Newtonsoft.Json.Linq;

public class Program
{
    public static void Main()
    {
        string json = "{\"Name\":\"John Doe\",\"Age\":30,\"Address\":{\"City\":\"New York\",\"Country\":\"USA\"}}";
        JObject obj = JObject.Parse(json);

        // 使用JsonPath表达式查询和筛选JSON
        JToken nameToken = obj.SelectToken("$.Name");
        Console.WriteLine(nameToken.Value<string>());

        JToken addressToken = obj.SelectToken("$.Address");
        Console.WriteLine(addressToken["City"].Value<string>());
        Console.WriteLine(addressToken["Country"].Value<string>());
    }
}

4.使用LINQ操作JSON数据

除了查询和筛选,我们还可以使用LINQ来对JSON数据进行各种操作,例如投影、连接和排序等。以下是一个使用LINQ操作JSON数据的示例:

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

public class Program
{
    public static void Main()
    {
        string json = "[{\"Name\":\"John Doe\",\"Age\":30},{\"Name\":\"Jane Smith\",\"Age\":35}]";
        JArray array = JArray.Parse(json);

        // 使用LINQ查询和操作JSON数据
        var names = from item in array
                    select item["Name"].Value<string>();

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

5.处理复杂的嵌套JSON结构

在处理复杂的嵌套JSON结构时,可以使用JObjectJArray类来方便地访问和操作JSON数据。这两个类提供了一系列方法和属性,用于处理嵌套的JSON对象和数组。以下是一个处理复杂嵌套JSON结构的示例:

using System;
using Newtonsoft.Json.Linq;

public class Program
{
    public static void Main()
    {
        string json = "{\"Name\":\"John Doe\",\"Age\":30,\"Address\":{\"City\":\"New York\",\"Country\":\"USA\"},\"Languages\":[\"C#\",\"JavaScript\"]}";
        JObject obj = JObject.Parse(json);

        Console.WriteLine(obj["Name"].Value<string>());
        Console.WriteLine(obj["Age"].Value<int>());
        Console.WriteLine(obj["Address"]["City"].Value<string>());
        Console.WriteLine(obj["Address"]["Country"].Value<string>());

        foreach (string language in obj["Languages"])
        {
            Console.WriteLine(language);
        }
    }
}

6.处理日期和时间类型的JSON数据

当JSON中包含日期和时间类型的数据时,可以使用DateTimeOffsetJsonConvert类来进行正确的处理和转换。以下是一个处理日期和时间类型的JSON数据的示例:

using System;
using Newtonsoft.Json;

public class Person
{
    public string Name { get; set; }
    public DateTimeOffset BirthDate { get; set; }
}

public class Program
{
    public static void Main()
    {
        string json = "{\"Name\":\"John Doe\",\"BirthDate\":\"1980-01-01T00:00:00+00:00\"}";

        // 使用Newtonsoft.Json处理日期和时间类型
        Person person = JsonConvert.DeserializeObject<Person>(json)http://www.chinasem.cn;
        Console.WriteLine(person.Name);
        Console.WriteLine(person.BirthDate);
    }
}

7.处理JSON中的特殊字符和转义序列

当处理包含特殊字符和转义序列的JSON数据时,可以使用JsonConvert类的EscapeString方法来进行正确的转义。以下是一个处理特殊字符和转义序列的JSON数据的示例:编程

using System;
using Newtonsoft.Json;

public class Program
{
    public static void Main()
    {
        string text = @"This is a \"quoted\" text.";
        string json = JsonConvert.SerializeObject(text);

        Console.WriteLine(json); // 输出:"This is a \\\\\"quoted\\\\\" text."
    }
}

8.处理大量的JSON数据

当处理包含大量JSON数据时,可以使用JsonReaderJsonWriter类来实现流式处理,从而减少内存占用和提高性能。以下是一个处理大量JSON数据的示例:

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

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

public class Program
{
    public static void Main()
    {
        string[] names = {"John", "Jane", "Tom", "Alice"};

        using (var stream = new StreamWriter("data.json"))
        using (var writer = new JsonTextWriter(stream))
        {
            writer.WriteStartArray();

            foreach (string name in names)
            {
                var person = new Person {Name = name, Age = 30};
                JsonSerializer.Serialize(writer, person);
            }

            writer.WriteEndArray();
        }
    }
}

9.处理JSON中的异常和错误情况

在处理JSON数据时,可能会遇到各种异常和错误情况。为了确保代码的健壮性和可靠性,应该使用try-catch语句来捕获和处理异常。以下是一个处理JSON异常和错误情况的示例:

using System;
using Newtonsoft.Json;

public class Program
{
    public static void Main()
    {
        try
        {
            string invalidJson = "This is not a valid JSON.";
            dynamic obj = JsonConvert.DeserializeObject(invalidJson);
        }
        catch (JsonReaderException ex)
        {
            Console.WriteLine("JSON解析错误:" + ex.Message);
        }
        catch (JsonSerializationException ex)
        {
            Console.WriteLine("JSON序列化错误:" + ex.Message);
        }
    }
}

最佳实践和性能优化建议

在处理JSON数据时,遵循以下最佳实践和性能优化建议可以提高代码的可读性和性能:

  • 尽可能使用System.Text.Json库,它是.NET Core的默认JSON库,性能比Newtonsoft.Json更好。
  • 对于复杂的嵌套JSON结构,使用JObject和JArray类进行访问和操作。
  • 对于大量的JSON数据,使用JsonReader和JsonWriter类进行流式处理。
  • 使用LINQ查询和操作JSON数据,使China编程代码更简洁和可读。
  • 避免在循环内进行重复的JSON序列化和反序列化操作,尽量缓存结果。

到此这篇关于C#解析JSON数据全攻略指南的文章就介绍到这了,更多相关C#解析JSON内容请搜索编程China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)!

这篇关于C#解析JSON数据全攻略指南的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1155449

相关文章

JavaScript中的高级调试方法全攻略指南

《JavaScript中的高级调试方法全攻略指南》什么是高级JavaScript调试技巧,它比console.log有何优势,如何使用断点调试定位问题,通过本文,我们将深入解答这些问题,带您从理论到实... 目录观点与案例结合观点1观点2观点3观点4观点5高级调试技巧详解实战案例断点调试:定位变量错误性能分

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java

C#使用Spire.Doc for .NET实现HTML转Word的高效方案

《C#使用Spire.Docfor.NET实现HTML转Word的高效方案》在Web开发中,HTML内容的生成与处理是高频需求,然而,当用户需要将HTML页面或动态生成的HTML字符串转换为Wor... 目录引言一、html转Word的典型场景与挑战二、用 Spire.Doc 实现 HTML 转 Word1

C#实现一键批量合并PDF文档

《C#实现一键批量合并PDF文档》这篇文章主要为大家详细介绍了如何使用C#实现一键批量合并PDF文档功能,文中的示例代码简洁易懂,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言效果展示功能实现1、添加文件2、文件分组(书签)3、定义页码范围4、自定义显示5、定义页面尺寸6、PDF批量合并7、其他方法

Python实现精确小数计算的完全指南

《Python实现精确小数计算的完全指南》在金融计算、科学实验和工程领域,浮点数精度问题一直是开发者面临的重大挑战,本文将深入解析Python精确小数计算技术体系,感兴趣的小伙伴可以了解一下... 目录引言:小数精度问题的核心挑战一、浮点数精度问题分析1.1 浮点数精度陷阱1.2 浮点数误差来源二、基础解决

Java实现在Word文档中添加文本水印和图片水印的操作指南

《Java实现在Word文档中添加文本水印和图片水印的操作指南》在当今数字时代,文档的自动化处理与安全防护变得尤为重要,无论是为了保护版权、推广品牌,还是为了在文档中加入特定的标识,为Word文档添加... 目录引言Spire.Doc for Java:高效Word文档处理的利器代码实战:使用Java为Wo

深度解析Python中递归下降解析器的原理与实现

《深度解析Python中递归下降解析器的原理与实现》在编译器设计、配置文件处理和数据转换领域,递归下降解析器是最常用且最直观的解析技术,本文将详细介绍递归下降解析器的原理与实现,感兴趣的小伙伴可以跟随... 目录引言:解析器的核心价值一、递归下降解析器基础1.1 核心概念解析1.2 基本架构二、简单算术表达

MyBatis-plus处理存储json数据过程

《MyBatis-plus处理存储json数据过程》文章介绍MyBatis-Plus3.4.21处理对象与集合的差异:对象可用内置Handler配合autoResultMap,集合需自定义处理器继承F... 目录1、如果是对象2、如果需要转换的是List集合总结对象和集合分两种情况处理,目前我用的MP的版本

从入门到精通详解Python虚拟环境完全指南

《从入门到精通详解Python虚拟环境完全指南》Python虚拟环境是一个独立的Python运行环境,它允许你为不同的项目创建隔离的Python环境,下面小编就来和大家详细介绍一下吧... 目录什么是python虚拟环境一、使用venv创建和管理虚拟环境1.1 创建虚拟环境1.2 激活虚拟环境1.3 验证虚

深度解析Java @Serial 注解及常见错误案例

《深度解析Java@Serial注解及常见错误案例》Java14引入@Serial注解,用于编译时校验序列化成员,替代传统方式解决运行时错误,适用于Serializable类的方法/字段,需注意签... 目录Java @Serial 注解深度解析1. 注解本质2. 核心作用(1) 主要用途(2) 适用位置3