C#操作JSON(序列化与反序列化)的方法详解

Raizel ·

更新时间:2024-09-20

· 933 次阅读

序列化

反序列化

与字典互转

.net core提供了Json处理模块，在命名空间System.Text.Json中，下面通过顶级语句，对C#的Json功能进行讲解。

序列化

将C#对象编辑为Json格式字符串的过程，即为Json序列化，在C#中，通过JsonSerializer.Serialize来实现

using System.Text.Json;
public class WeatherInfo
{
    public DateTimeOffset Date { get; set; }
    public int Temperature { get; set; }
    public string? Summary { get; set; }
}
var wInfo = new WeatherInfo
{
    Date = DateTime.Now,
    Temperature = 25,
    Summary = "Hot"
};
string js = JsonSerializer.Serialize(wInfo);
File.WriteAllText("test.json", js);     //将其输出为文件
Console.WriteLine(js);

上例中，wInfo是WeatherInfo的对象，通过Json序列化，成功将其转化为字符串，输出结果如下

{"Date":"2023-05-11T15:52:49.4942993+08:00","Temperature":25,"Summary":"Hot"}

反序列化

将json字符串读取为C#对象的过程，即为反序列化，以刚刚创建的test.json为例，通过泛型函数Deserialize<T>，可将其转化为C#对象

string js = File.ReadAllText("test.json");
var w = JsonSerializer.Deserialize<WeatherInfo>(js);
Console.WriteLine($"{w.Date}\r\n{w.Temperature}\r\n{w.Summary}");

测试结果为

2023/5/11 15:54:46 +08:00
25
Hot

与字典互转

考虑到并非所有json数据都能找到C#中对应的类，为了更加灵活地操作json数据，在实际使用中，可以建立json和字典的转换方法。如果仍然使用System.Text.Json中的方法，则需要继承抽象类JsonConverter<T>，并重写其中用于转换的内容，相对来说比较麻烦，所以推荐使用经典的NewtonSoft.Json，需要在NuGet中搜索添加。

在Newtonsoft.Json中，函数JsonConvert.DeserializeObject完全具备System.Text.Json中JsonSerializer.Deserialize的所有功能，同时开可以将泛型变量设为字典

using Newtonsoft.Json;
var dct = JsonConvert.DeserializeObject<Dictionary<string, string>>(js);
foreach (var item in dct)
    Console.WriteLine($"{item.Key}:{item.Value}");

结果为

Date:2023-05-11T15:54:46.2907782+08:00
Temperature:25
Summary:Hot

相应地，将字典编写为json格式字符串，可通过JsonConvert.SerializeObject来实现

var dct = new Dictionary<string, string>()
{
    {"Date", DateTime.Now.ToString("f") },
    {"Temp", "25" },
    {"Summary", "Hot" }
};
string js = JsonConvert.SerializeObject(dct);
Console.WriteLine(js);

效果为