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

还在为c#处理网络api返回的复杂json数据头疼吗？据统计，90%的开发者都曾在json解析上栽过跟头！

本文将手把手教你用c#轻松玩转json数据：

- httpclient获取网络json数据

- system.text.json动态解析技巧

- 强类型模型转换实战

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

- 完整可运行代码示例

一、为什么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.json和newtonsoft.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.text.json和newtonsoft.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结构时，可以使用jobject和jarray类来方便地访问和操作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中包含日期和时间类型的数据时，可以使用datetimeoffset和jsonconvert类来进行正确的处理和转换。以下是一个处理日期和时间类型的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);
        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数据时，可以使用jsonreader和jsonwriter类来实现流式处理，从而减少内存占用和提高性能。以下是一个处理大量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数据时，遵循以下最佳实践和性能优化建议可以提高代码的可读性和性能：