System.Text.json是.net Core 3.0+内置的高性能json库,用于C#对象与JSON字符串的相互转换。使用JsonSerializer.Serialize和Deserialize方法实现序列化与反序列化,支持通过JsonSerializerOptions配置命名策略、缩进、大小写敏感等选项,并可通过[JsonPropertyName]和[JsonIgnore]特性处理字段映射与忽略,适用于大多数现代C#开发场景。

JSON序列化是将C#对象转换为JSON字符串的过程,反序列化则是将JSON字符串还原为C#对象。在现代C#开发中,System.Text.Json 是官方推荐的高性能json处理库,从.NET Core 3.0开始内置,无需额外安装包(除非使用较新功能)。
基本用法:序列化与反序列化
使用 JsonSerializer.Serialize 和 JsonSerializer.Deserialize 方法即可完成转换。
- 序列化:把C#对象变成JSON字符串
- 反序列化:把JSON字符串还原成C#对象
示例:
using System; using System.Text.Json; public class Person { public string Name { get; set; } public int Age { get; set; } } // 序列化 var person = new Person { Name = "张三", Age = 25 }; string json = JsonSerializer.Serialize(person); Console.WriteLine(json); // 输出: {"Name":"张三","Age":25} // 反序列化 string inputJson = "{"Name":"李四","Age":30}"; Person deserializedPerson = JsonSerializer.Deserialize<Person>(inputJson); Console.WriteLine(deserializedPerson.Name); // 输出: 李四
常用选项配置
可以通过 JsonSerializerOptions 控制序列化行为,比如属性命名策略、缩进格式、日期处理等。
常见设置:
- PropertyNamingPolicy:控制属性名格式,如转为camelCase
- WriteIndented:输出带缩进的JSON,便于阅读
- PropertyNameCaseInsensitive:反序列化时忽略大小写
示例:
var options = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, WriteIndented = true }; string json = JsonSerializer.Serialize(person, options); var readOptions = new JsonSerializerOptions { PropertyNameCaseInsensitive = true }; Person result = JsonSerializer.Deserialize<Person>(inputJson, readOptions);
处理复杂类型和特性
对于字段名不匹配或需要忽略的属性,可以使用特性(Attribute)进行标记。
- [JsonPropertyName]:指定JSON中的字段名
- [JsonIgnore]:序列化时忽略该属性
示例:
public class Product { [JsonPropertyName("product_id")] public string Id { get; set; } [JsonIgnore] public decimal cost { get; set; } public string Name { get; set; } }
这样序列化时,Id会变成”product_id”,Cost则不会出现在JSON中。
基本上就这些。System.Text.Json 使用简单、性能好,适合大多数场景。注意类必须有公共属性和构造函数才能正确序列化。