四时宝库

一、引言

在现代软件开发中，JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，被广泛应用于前后端交互、配置文件管理以及分布式系统间的数据传输。System.Text.Json 是 .NET Core 3.0 及更高版本中引入的高性能 JSON 处理库，提供了序列化和反序列化的功能，并且与 .NET 平台深度集成。

二、基本使用

1. 序列化

序列化：对象转换为 JSON 字符串的过程。

using System;
using System.Text.Json;

publicclassPerson
{
 publicstring Name { get; set; }
 publicint Age { get; set; }
}

classProgram
{
 static void Main()
 {
 var person = new Person { Name = "张三", Age = 30 };
 string jsonString = JsonSerializer.Serialize(person);
 Console.WriteLine(jsonString); // 输出：{"Name":"张三","Age":30}
 }
}

对于复杂对象，如包含嵌套对象，也能轻松处理：

2. 反序列化

反序列化是将 JSON 字符串转换回 .NET 对象的过程。

using System;
using System.Text.Json;

publicclassPerson
{
 publicstring Name { get; set; }
 publicint Age { get; set; }
}

classProgram
{
 static void Main()
 {
 string jsonString = "{\"Name\":\"张三\",\"Age\":30}";
 Person person = JsonSerializer.Deserialize(jsonString);
 Console.WriteLine($"Name: {person.Name}, Age: {person.Age}");
 }
}

JsonSerializer.Deserialize 方法将 JSON 字符串转换为 Person 对象。

三、进阶技巧

1. 自定义序列化行为

提供了多种特性（Attributes），用于控制序列化和反序列化的行为。

（1）JsonPropertyName 特性

JsonPropertyName 特性可以指定属性在 JSON 中的名称。

using System.Text.Json.Serialization;

public class Product
{
 [JsonPropertyName("商品名称")]
 public string ProductName { get; set; }

 [JsonPropertyName("价格")]
 public decimal Price { get; set; }
}

序列化后，输出如下：

{"商品名称":"笔记本电脑","价格":5999.99}

（2）JsonIgnore 特性

JsonIgnore 特性用于在序列化和反序列化时忽略某个属性。

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

 [JsonIgnore]
 public int Age { get; set; }
}

序列化时，Age 属性将不会出现在 JSON 中。

（3）JsonRequired 特性

JsonRequired 特性用于指定某个属性在 JSON 中必须存在，否则会抛出异常。

public class Person
{
 [JsonRequired]
 public string Name { get; set; }

 public int Age { get; set; }
}

如果 JSON 中缺少 Name 属性，反序列化时会报错。

2. 自定义转换器

在某些情况下，可能需要对特定类型的序列化和反序列化进行自定义。可以通过实现 JsonConverter 来创建自定义转换器。

public classMyCustomConverter : JsonConverter<int>
{
 public override int Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
 {
 // 自定义反序列化逻辑
 returnint.Parse(reader.GetString());
 }

 public override void Write(Utf8JsonWriter writer, int value, JsonSerializerOptions options)
 {
 // 自定义序列化逻辑
 writer.WriteStringValue(value.ToString());
 }
}

然后，将自定义转换器添加到 JsonSerializerOptions 中：

var options = new JsonSerializerOptions
{
 Converters = { new MyCustomConverter() }
};

3. 配置序列化选项

System.Text.Json 提供了 JsonSerializerOptions 类，用于自定义序列化和反序列化的行为。

var options = new JsonSerializerOptions
{
 PropertyNamingPolicy = JsonNamingPolicy.CamelCase, // 使用驼峰式命名
 WriteIndented = true, // 格式化输出
 DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingDefault // 忽略默认值
 // DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingDefault | JsonIgnoreCondition.WhenWriting
 //通过 `JsonSerializerOptions` 的 `DefaultIgnoreCondition` 属性，可以忽略默认值或空值。 
};

四、总结

System.Text.Json 是一个强大且高效的 JSON 处理库，适用于 .NET 开发中的各种场景。通过掌握基本的序列化和反序列化操作，以及进阶的自定义特性、转换器和配置选项，可以灵活地处理 JSON 数据，满足复杂的业务需求。