当前位置：首页 > news >正文

.NET 6新特性 | System.Text.Json功能改进

news 2025/8/2 22:13:28

在.NET 6.0中，JSON处理库得到了显著的改进，主要体现在System.Text.Json上。以下是对.NET 6.0中改进的JSON处理库的详细分析：

一、System.Text.Json的引入与优势

在.NET 6中，Microsoft引入了新的JSON库System.Text.Json作为官方推荐的序列化框架，取代了以前常用的Newtonsoft.Json（Json.NET）。System.Text.Json提供了以下优势：

性能提升：System.Text.Json使用了更少的内存开销，并且在处理大量数据时有显著的速度优势。这得益于其高效的序列化和反序列化机制，以及针对JSON处理进行的深度优化。
API更简洁：System.Text.Json的API设计更为直观和简单，许多操作可以直接通过LINQ表达式完成。这使得开发者在处理JSON数据时更加便捷和高效。
兼容性强：虽然Json.NET支持的功能丰富，但大部分情况下System.Text.Json足够满足需求。同时，它能更好地与.NET的其他部分集成，提供了一致的编程体验。

二、System.Text.Json的新特性

在.NET 6中，System.Text.Json引入了多项新特性，以增强其功能和灵活性：

2.1 忽略循环引用：

在.NET 6中，System.Text.Json允许在序列化时忽略循环引用，避免了因循环依赖而导致的异常。这通过JsonSerializerOptions中的ReferenceHandler.IgnoreCycles选项来实现。

using System;  
using System.Text.Json;  
using System.Text.Json.Serialization;  public class Person  
{  public string Name { get; set; }  public Person BestFriend { get; set; }  
}  public class Program  
{  public static void Main()  {  var person = new Person  {  Name = "Alice",  BestFriend = new Person  {  Name = "Bob",  BestFriend = new Person { Name = "Alice" } // 循环引用  }  };  var options = new JsonSerializerOptions  {  ReferenceHandler = ReferenceHandler.IgnoreCycles  };  string json = JsonSerializer.Serialize(person, options);  Console.WriteLine(json);  }  
}

在这个例子中，Person类有一个BestFriend属性，它指向另一个Person对象。如果BestFriend的BestFriend又指向原始对象，就会形成循环引用。通过设置JsonSerializerOptions的ReferenceHandler为IgnoreCycles，System.Text.Json会忽略这种循环引用，避免序列化时出现异常。

2.2 序列化和反序列化的通知：

System.Text.Json公开了序列化和反序列化的通知接口，如IJsonOnDeserialized、IJsonOnDeserializing、IJsonOnSerialized和IJsonOnSerializing。这使得开发者可以在序列化和反序列化过程中执行自定义逻辑。

using System;  
using System.Text.Json;  
using System.Text.Json.Serialization;  public class Person  
{  [JsonPropertyName("name")]  public string Name { get; set; }  [OnDeserialized]  public void OnDeserialized()  {  Console.WriteLine("Deserialized!");  }  [OnDeserializing]  public void OnDeserializing()  {  Console.WriteLine("Deserializing!");  }  [OnSerialized]  public void OnSerialized()  {  Console.WriteLine("Serialized!");  }  [OnSerializing]  public void OnSerializing()  {  Console.WriteLine("Serializing!");  }  
}  public class Program  
{  public static void Main()  {  var person = new Person { Name = "Alice" };  string json = JsonSerializer.Serialize(person);  Console.WriteLine(json);  Person deserializedPerson = JsonSerializer.Deserialize<Person>(json);  }  
}

在这个例子中，Person类实现了IJsonOnDeserialized、IJsonOnDeserializing、IJsonOnSerialized和IJsonOnSerializing接口中的方法。这些方法在序列化和反序列化过程中会被自动调用，允许开发者在这些过程中执行自定义逻辑。

2.3 属性排序支持：

通过JsonPropertyOrderAttribute特性，System.Text.Json允许控制属性的序列化顺序。这解决了之前序列化顺序由反射顺序决定的问题，提供了更灵活的属性排序方式。

using System;  
using System.Text.Json;  
using System.Text.Json.Serialization;  [JsonPropertyOrder(nameof(LastName), nameof(FirstName))]  
public class Person  
{  public string FirstName { get; set; }  public string LastName { get; set; }  
}  public class Program  
{  public static void Main()  {  var person = new Person { FirstName = "John", LastName = "Doe" };  string json = JsonSerializer.Serialize(person);  Console.WriteLine(json); // 输出: {"LastName":"Doe","FirstName":"John"}  }  
}

在这个例子中，Person类使用了JsonPropertyOrderAttribute来指定属性的序列化顺序。在这个例子中，LastName会在FirstName之前被序列化。

2.4 Utf8JsonWriter的使用：

System.Text.Json提供了Utf8JsonWriter类，用于高效地编写原始JSON。这使得开发者可以直接操作JSON的字节流，提高了JSON生成的效率和灵活性。

using System;  
using System.Buffers.Text;  
using System.Text.Json;  public class Program  
{  public static void Main()  {  using (var doc = new Utf8JsonWriter(new ArrayBufferWriter<byte>()))  {  doc.WriteStartObject();  doc.WriteString("name", "Alice");  doc.WriteNumber("age", 30);  doc.WriteEndObject();  string json = Encoding.UTF8.GetString(doc.Flush());  Console.WriteLine(json);  }  }  
}

2.5 对IAsyncEnumerable的支持：

System.Text.Json现在支持（反）序列化JSON数组为IAsyncEnumerable<T>类型，这使得在处理大量数据时可以更加高效地利用异步编程模式。

using System;  
using System.Collections.Generic;  
using System.IO;  
using System.Linq;  
using System.Text.Json;  
using System.Threading.Tasks;  public class Program  
{  public static async Task Main()  {  async IAsyncEnumerable<int> GetNumbersAsync()  {  for (int i = 0; i < 10; i++)  {  await Task.Delay(100); // 模拟异步操作  yield return i;  }  }  using (var stream = new MemoryStream())  using (var writer = new Utf8JsonWriter(stream))  {  writer.WriteStartArray();  await foreach (var number in GetNumbersAsync())  {  writer.WriteNumberValue(number);  }  writer.WriteEndArray();  string json = Encoding.UTF8.GetString(stream.ToArray());  Console.WriteLine(json);  }  }  
}

在这个例子中，GetNumbersAsync是一个返回IAsyncEnumerable<int>的异步方法。Utf8JsonWriter被用来将异步生成的数字序列化为JSON数组。这种方式对于处理大量数据或需要异步操作的场景特别有用。