C# JSON处理技术演进从Newtonsoft.Json到System.Text.Json的深度迁移实践在.NET生态系统中JSON数据处理一直是开发者日常工作的核心部分。过去十年间Newtonsoft.Json又称Json.NET几乎成为了C#处理JSON数据的代名词其强大的功能和灵活性赢得了广大开发者的青睐。然而随着.NET Core的崛起和.NET 5的统一平台战略微软推出了内置的System.Text.Json库旨在提供更高性能、更低内存占用的JSON处理方案。本文将深入探讨这两个库的关键差异并提供从Newtonsoft.Json迁移到System.Text.Json的实用指南包括详细的性能对比、API差异解析以及实际迁移中可能遇到的坑与解决方案。1. 技术背景与迁移动因当微软在2019年推出System.Text.Json时许多开发者提出了一个合理的问题既然Newtonsoft.Json已经如此完善为什么还要另起炉灶这个问题的答案涉及多个层面从性能优化到平台战略都是推动这一变革的重要因素。性能瓶颈的突破是System.Text.Json诞生的首要原因。Newtonsoft.Json虽然功能丰富但在处理大规模JSON数据时其性能表现和内存效率逐渐成为瓶颈。根据微软官方基准测试System.Text.Json在典型场景下能减少30-50%的内存分配并提升约20-40%的序列化/反序列化速度。这种性能优势在微服务架构和高并发场景中尤为珍贵。// 性能测试示例代码框架 var testData GenerateTestData(); var stopwatch Stopwatch.StartNew(); // Newtonsoft.Json测试 var newtonsoftJson JsonConvert.SerializeObject(testData); var newtonsoftTime stopwatch.ElapsedMilliseconds; // System.Text.Json测试 stopwatch.Restart(); var systemTextJson JsonSerializer.Serialize(testData); var systemTextTime stopwatch.ElapsedMilliseconds; Console.WriteLine($Newtonsoft.Json: {newtonsoftTime}ms); Console.WriteLine($System.Text.Json: {systemTextTime}ms);平台整合需求是另一个关键因素。作为.NET运行时的一部分System.Text.Json能够深度集成到ASP.NET Core等框架中实现更高效的管道处理和更紧密的框架协作。这种原生支持带来了诸如零拷贝反序列化等高级特性这是第三方库难以实现的。从技术架构角度看两个库的主要差异体现在特性Newtonsoft.JsonSystem.Text.Json依赖关系外部NuGet包.NET运行时内置默认编码策略UTF-8/UTF-16仅UTF-8异步支持有限支持全面支持内存分配策略常规分配高度优化默认大小写策略保留原始大小写驼峰命名循环引用处理支持有限支持对于新项目微软明确推荐使用System.Text.Json特别是对于性能敏感型应用。而对于现有项目评估迁移成本与收益后逐步过渡也是值得考虑的技术决策。迁移不仅带来性能提升还能减少外部依赖简化部署流程。在后续章节中我们将深入探讨具体的迁移策略和实践技巧。2. API差异详解与迁移适配从Newtonsoft.Json转向System.Text.Json过程中最大的挑战莫过于两者API设计哲学的差异。Newtonsoft.Json以灵活性见长提供了大量配置选项和扩展点而System.Text.Json则更注重性能和安全性在灵活性上有所取舍。理解这些差异是成功迁移的关键。基础序列化对比展示了两个库最直观的差异。Newtonsoft.Json使用静态类JsonConvert的SerializeObject和DeserializeObject方法而System.Text.Json通过JsonSerializer类提供类似功能// Newtonsoft.Json方式 var person new Person { Name 张三, Age 30 }; string newtonsoftJson JsonConvert.SerializeObject(person); Person newtonsoftObj JsonConvert.DeserializeObjectPerson(newtonsoftJson); // System.Text.Json方式 string systemTextJson JsonSerializer.Serialize(person); Person systemTextObj JsonSerializer.DeserializePerson(systemTextJson);属性控制方式的差异尤为明显。Newtonsoft.Json使用JsonProperty属性标注而System.Text.Json使用JsonPropertyNamepublic class Person { // Newtonsoft.Json方式 [JsonProperty(PropertyName person_name)] public string Name { get; set; } // System.Text.Json方式 [JsonPropertyName(person_name)] public string Name { get; set; } }特殊类型处理是另一个需要注意的领域。下表对比了常见场景下的处理差异场景Newtonsoft.Json处理方式System.Text.Json处理方式日期格式通过DateFormatString自定义通过JsonSerializerOptions配置枚举处理StringEnumConverterJsonStringEnumConverter忽略null值NullValueHandling.IgnoreDefaultIgnoreCondition.WhenWritingNull只读属性默认支持反序列化需特别配置多态序列化TypeNameHandling.Auto需自定义转换器自定义转换器的实现也有显著不同。System.Text.Json的转换器接口更为严格需要显式处理更多细节// System.Text.Json自定义转换器示例 public class DateTimeOffsetConverter : JsonConverterDateTimeOffset { public override DateTimeOffset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return DateTimeOffset.Parse(reader.GetString()); } public override void Write(Utf8JsonWriter writer, DateTimeOffset value, JsonSerializerOptions options) { writer.WriteStringValue(value.ToString(yyyy-MM-dd HH:mm:ss)); } } // 使用方式 var options new JsonSerializerOptions { Converters { new DateTimeOffsetConverter() } }; string json JsonSerializer.Serialize(data, options);迁移过程中开发者需要特别注意行为差异带来的影响。例如System.Text.Json默认情况下更加严格属性名称区分大小写、不允许尾随逗号、不处理注释等。这些行为可以通过JsonSerializerOptions配置但需要显式指定var options new JsonSerializerOptions { PropertyNameCaseInsensitive true, // 不区分大小写 ReadCommentHandling JsonCommentHandling.Skip, // 允许注释 AllowTrailingCommas true // 允许尾随逗号 };对于复杂场景如循环引用处理System.Text.Json采取了不同的策略。Newtonsoft.Json可以自动处理循环引用而System.Text.Json出于性能和安全考虑默认会抛出异常。解决方案是通过ReferenceHandler配置var options new JsonSerializerOptions { ReferenceHandler ReferenceHandler.Preserve };理解这些API差异后开发者可以更有针对性地进行代码迁移。下一节我们将通过具体案例展示如何将这些知识应用到实际迁移过程中。3. 分步迁移策略与实战案例将现有项目从Newtonsoft.Json迁移到System.Text.Json需要系统化的策略而非简单的全局替换。本节将介绍一种渐进式迁移方法通过实际案例演示如何安全、高效地完成这一转换。迁移准备阶段的首要工作是建立全面的测试覆盖。JSON处理代码往往涉及核心业务逻辑任何微小的行为差异都可能导致难以察觉的bug。建议创建专门的测试用例覆盖以下场景基础数据类型序列化/反序列化复杂对象图嵌套对象、集合等自定义转换器逻辑特殊值处理null、默认值等性能敏感路径渐进式迁移策略可以分为四个阶段并行运行阶段在项目中同时引入System.Text.Json但不移除Newtonsoft.Json。通过适配器模式或条件编译允许两种实现共存。// 条件编译示例 #if SYSTEMTEXTJSON using System.Text.Json; #else using Newtonsoft.Json; #endif public class JsonHelper { public static string SerializeT(T obj) { #if SYSTEMTEXTJSON return JsonSerializer.Serialize(obj); #else return JsonConvert.SerializeObject(obj); #endif } }逐模块迁移阶段按功能模块逐步替换Newtonsoft.Json调用。每个模块迁移后都需进行充分验证。自定义转换器实现阶段对于复杂场景实现必要的自定义JsonConverter。以下是处理多态类型的转换器示例public class PolymorphicConverterT : JsonConverterT { public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { using (JsonDocument doc JsonDocument.ParseValue(ref reader)) { var root doc.RootElement; string typeDiscriminator root.GetProperty($type).GetString(); Type targetType Type.GetType(typeDiscriminator); var json root.GetRawText(); return (T)JsonSerializer.Deserialize(json, targetType, options); } } public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options) { JsonSerializer.Serialize(writer, (object)value, options); } }性能优化阶段迁移完成后利用System.Text.Json的特性进行针对性优化如使用源生成器减少运行时反射。常见问题解决方案问题1属性名称大小写不一致// 解决方案统一配置命名策略 var options new JsonSerializerOptions { PropertyNamingPolicy JsonNamingPolicy.CamelCase };问题2私有成员序列化// 解决方案使用IncludeFields选项 var options new JsonSerializerOptions { IncludeFields true };问题3构造器参数反序列化// 解决方案使用[JsonConstructor]标注或配置ParameterizedConstructorHandling public class Person { [JsonConstructor] public Person(string name) Name name; public string Name { get; } }迁移检查清单[ ] 测试覆盖率达标建议85%[ ] 自定义转换器实现完成[ ] 性能基准测试通过[ ] 第三方库兼容性验证[ ] 文档更新完成对于大型项目可以采用混合模式逐步迁移。例如ASP.NET Core项目可以同时配置两个JSON处理器// Program.cs中配置 builder.Services.AddControllers() .AddNewtonsoftJson() // 兼容现有API .AddJsonOptions(options { // 逐步迁移到System.Text.Json });实际案例表明一个中等规模的项目约10万行代码通常需要2-4周的迁移周期其中测试和验证占用了大部分时间。迁移后的性能提升因项目而异但普遍报告显示序列化操作速度提升20-40%内存分配减少30-50%。4. 性能优化与高级技巧成功迁移到System.Text.Json后开发者可以进一步探索其高级特性和优化技巧充分发挥其性能潜力。本节将深入探讨各种优化手段和实用技巧帮助您将JSON处理性能推向极致。**源生成器(Source Generator)**是System.Text.Json最具革命性的特性之一。它通过在编译时生成序列化代码完全避免了运行时反射带来的性能开销。启用源生成器只需几个简单步骤定义部分类并标注JsonSerializerContext[JsonSerializable(typeof(Person))] [JsonSerializable(typeof(ListPerson))] public partial class JsonContext : JsonSerializerContext { }在序列化时使用生成的代码var persons new ListPerson { /*...*/ }; string json JsonSerializer.Serialize(persons, JsonContext.Default.ListPerson); Person[] deserialized JsonSerializer.Deserialize(json, JsonContext.Default.PersonArray);基准测试表明源生成器可以带来以下改进序列化速度提升40-60%反序列化速度提升30-50%启动时间缩短80%以上内存分配减少60-80%池化技术是另一个重要优化手段。System.Text.Json大量使用ArrayPool来减少内存分配开发者可以进一步扩展这一理念// 自定义ArrayPool实现 public class CustomArrayPool : ArrayPoolbyte { public override byte[] Rent(int minimumLength) { // 自定义分配逻辑 } public override void Return(byte[] array, bool clearArray false) { // 自定义回收逻辑 } } // 使用自定义池 var options new JsonSerializerOptions { DefaultBufferSize 16384, ArrayPool new CustomArrayPool() };异步处理在大文件场景下至关重要。System.Text.Json提供了真正的异步API可以高效处理大型JSON流// 异步写入大型JSON文件 await using (var fileStream File.Create(large.json)) { var data GenerateLargeData(); await JsonSerializer.SerializeAsync(fileStream, data); } // 异步读取大型JSON文件 await using (var fileStream File.OpenRead(large.json)) { var data await JsonSerializer.DeserializeAsyncMyDataType(fileStream); }高级配置选项可以微调序列化行为。以下是一些实用配置组合var optimizedOptions new JsonSerializerOptions { WriteIndented false, // 紧凑格式 IgnoreNullValues true, // 忽略null值 DefaultIgnoreCondition JsonIgnoreCondition.WhenWritingDefault, PropertyNamingPolicy JsonNamingPolicy.CamelCase, DictionaryKeyPolicy JsonNamingPolicy.CamelCase, NumberHandling JsonNumberHandling.AllowReadingFromString, ReferenceHandler ReferenceHandler.IgnoreCycles, MaxDepth 64, // 防止深度嵌套攻击 Encoder JavaScriptEncoder.UnsafeRelaxedJsonEscaping // 性能更好的编码器 };性能对比数据展示了优化前后的差异基于1MB JSON数据测试场景耗时(ms)内存分配(MB)Newtonsoft.Json1258.2System.Text.Json(基本)855.6System.Text.Json(优化)522.1源生成器模式310.8疑难问题解决方案问题处理动态或弱类型JSON// 使用JsonNode处理动态JSON JsonNode node JsonNode.Parse(jsonString); string name node[person][name].GetValuestring(); // 修改动态JSON node[person][age] 31; string modifiedJson node.ToJsonString();问题处理非公共成员var options new JsonSerializerOptions { IncludeFields true, // 包含字段 PropertyNamingPolicy JsonNamingPolicy.CamelCase, Encoder JavaScriptEncoder.UnsafeRelaxedJsonEscaping };问题处理特殊日期格式public class DateTimeConverter : JsonConverterDateTime { public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return DateTime.ParseExact(reader.GetString(), yyyy-MM-dd HH:mm:ss, CultureInfo.InvariantCulture); } public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options) { writer.WriteStringValue(value.ToString( yyyy-MM-dd HH:mm:ss, CultureInfo.InvariantCulture)); } }掌握这些高级技巧后您的JSON处理代码不仅会更加高效还能更好地适应各种复杂场景。记得始终通过基准测试验证优化效果因为不同场景下的最佳实践可能有所差异。
C#处理JSON数据：从Newtonsoft.Json到System.Text.Json的迁移指南（附性能对比）
C# JSON处理技术演进从Newtonsoft.Json到System.Text.Json的深度迁移实践在.NET生态系统中JSON数据处理一直是开发者日常工作的核心部分。过去十年间Newtonsoft.Json又称Json.NET几乎成为了C#处理JSON数据的代名词其强大的功能和灵活性赢得了广大开发者的青睐。然而随着.NET Core的崛起和.NET 5的统一平台战略微软推出了内置的System.Text.Json库旨在提供更高性能、更低内存占用的JSON处理方案。本文将深入探讨这两个库的关键差异并提供从Newtonsoft.Json迁移到System.Text.Json的实用指南包括详细的性能对比、API差异解析以及实际迁移中可能遇到的坑与解决方案。1. 技术背景与迁移动因当微软在2019年推出System.Text.Json时许多开发者提出了一个合理的问题既然Newtonsoft.Json已经如此完善为什么还要另起炉灶这个问题的答案涉及多个层面从性能优化到平台战略都是推动这一变革的重要因素。性能瓶颈的突破是System.Text.Json诞生的首要原因。Newtonsoft.Json虽然功能丰富但在处理大规模JSON数据时其性能表现和内存效率逐渐成为瓶颈。根据微软官方基准测试System.Text.Json在典型场景下能减少30-50%的内存分配并提升约20-40%的序列化/反序列化速度。这种性能优势在微服务架构和高并发场景中尤为珍贵。// 性能测试示例代码框架 var testData GenerateTestData(); var stopwatch Stopwatch.StartNew(); // Newtonsoft.Json测试 var newtonsoftJson JsonConvert.SerializeObject(testData); var newtonsoftTime stopwatch.ElapsedMilliseconds; // System.Text.Json测试 stopwatch.Restart(); var systemTextJson JsonSerializer.Serialize(testData); var systemTextTime stopwatch.ElapsedMilliseconds; Console.WriteLine($Newtonsoft.Json: {newtonsoftTime}ms); Console.WriteLine($System.Text.Json: {systemTextTime}ms);平台整合需求是另一个关键因素。作为.NET运行时的一部分System.Text.Json能够深度集成到ASP.NET Core等框架中实现更高效的管道处理和更紧密的框架协作。这种原生支持带来了诸如零拷贝反序列化等高级特性这是第三方库难以实现的。从技术架构角度看两个库的主要差异体现在特性Newtonsoft.JsonSystem.Text.Json依赖关系外部NuGet包.NET运行时内置默认编码策略UTF-8/UTF-16仅UTF-8异步支持有限支持全面支持内存分配策略常规分配高度优化默认大小写策略保留原始大小写驼峰命名循环引用处理支持有限支持对于新项目微软明确推荐使用System.Text.Json特别是对于性能敏感型应用。而对于现有项目评估迁移成本与收益后逐步过渡也是值得考虑的技术决策。迁移不仅带来性能提升还能减少外部依赖简化部署流程。在后续章节中我们将深入探讨具体的迁移策略和实践技巧。2. API差异详解与迁移适配从Newtonsoft.Json转向System.Text.Json过程中最大的挑战莫过于两者API设计哲学的差异。Newtonsoft.Json以灵活性见长提供了大量配置选项和扩展点而System.Text.Json则更注重性能和安全性在灵活性上有所取舍。理解这些差异是成功迁移的关键。基础序列化对比展示了两个库最直观的差异。Newtonsoft.Json使用静态类JsonConvert的SerializeObject和DeserializeObject方法而System.Text.Json通过JsonSerializer类提供类似功能// Newtonsoft.Json方式 var person new Person { Name 张三, Age 30 }; string newtonsoftJson JsonConvert.SerializeObject(person); Person newtonsoftObj JsonConvert.DeserializeObjectPerson(newtonsoftJson); // System.Text.Json方式 string systemTextJson JsonSerializer.Serialize(person); Person systemTextObj JsonSerializer.DeserializePerson(systemTextJson);属性控制方式的差异尤为明显。Newtonsoft.Json使用JsonProperty属性标注而System.Text.Json使用JsonPropertyNamepublic class Person { // Newtonsoft.Json方式 [JsonProperty(PropertyName person_name)] public string Name { get; set; } // System.Text.Json方式 [JsonPropertyName(person_name)] public string Name { get; set; } }特殊类型处理是另一个需要注意的领域。下表对比了常见场景下的处理差异场景Newtonsoft.Json处理方式System.Text.Json处理方式日期格式通过DateFormatString自定义通过JsonSerializerOptions配置枚举处理StringEnumConverterJsonStringEnumConverter忽略null值NullValueHandling.IgnoreDefaultIgnoreCondition.WhenWritingNull只读属性默认支持反序列化需特别配置多态序列化TypeNameHandling.Auto需自定义转换器自定义转换器的实现也有显著不同。System.Text.Json的转换器接口更为严格需要显式处理更多细节// System.Text.Json自定义转换器示例 public class DateTimeOffsetConverter : JsonConverterDateTimeOffset { public override DateTimeOffset Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return DateTimeOffset.Parse(reader.GetString()); } public override void Write(Utf8JsonWriter writer, DateTimeOffset value, JsonSerializerOptions options) { writer.WriteStringValue(value.ToString(yyyy-MM-dd HH:mm:ss)); } } // 使用方式 var options new JsonSerializerOptions { Converters { new DateTimeOffsetConverter() } }; string json JsonSerializer.Serialize(data, options);迁移过程中开发者需要特别注意行为差异带来的影响。例如System.Text.Json默认情况下更加严格属性名称区分大小写、不允许尾随逗号、不处理注释等。这些行为可以通过JsonSerializerOptions配置但需要显式指定var options new JsonSerializerOptions { PropertyNameCaseInsensitive true, // 不区分大小写 ReadCommentHandling JsonCommentHandling.Skip, // 允许注释 AllowTrailingCommas true // 允许尾随逗号 };对于复杂场景如循环引用处理System.Text.Json采取了不同的策略。Newtonsoft.Json可以自动处理循环引用而System.Text.Json出于性能和安全考虑默认会抛出异常。解决方案是通过ReferenceHandler配置var options new JsonSerializerOptions { ReferenceHandler ReferenceHandler.Preserve };理解这些API差异后开发者可以更有针对性地进行代码迁移。下一节我们将通过具体案例展示如何将这些知识应用到实际迁移过程中。3. 分步迁移策略与实战案例将现有项目从Newtonsoft.Json迁移到System.Text.Json需要系统化的策略而非简单的全局替换。本节将介绍一种渐进式迁移方法通过实际案例演示如何安全、高效地完成这一转换。迁移准备阶段的首要工作是建立全面的测试覆盖。JSON处理代码往往涉及核心业务逻辑任何微小的行为差异都可能导致难以察觉的bug。建议创建专门的测试用例覆盖以下场景基础数据类型序列化/反序列化复杂对象图嵌套对象、集合等自定义转换器逻辑特殊值处理null、默认值等性能敏感路径渐进式迁移策略可以分为四个阶段并行运行阶段在项目中同时引入System.Text.Json但不移除Newtonsoft.Json。通过适配器模式或条件编译允许两种实现共存。// 条件编译示例 #if SYSTEMTEXTJSON using System.Text.Json; #else using Newtonsoft.Json; #endif public class JsonHelper { public static string SerializeT(T obj) { #if SYSTEMTEXTJSON return JsonSerializer.Serialize(obj); #else return JsonConvert.SerializeObject(obj); #endif } }逐模块迁移阶段按功能模块逐步替换Newtonsoft.Json调用。每个模块迁移后都需进行充分验证。自定义转换器实现阶段对于复杂场景实现必要的自定义JsonConverter。以下是处理多态类型的转换器示例public class PolymorphicConverterT : JsonConverterT { public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { using (JsonDocument doc JsonDocument.ParseValue(ref reader)) { var root doc.RootElement; string typeDiscriminator root.GetProperty($type).GetString(); Type targetType Type.GetType(typeDiscriminator); var json root.GetRawText(); return (T)JsonSerializer.Deserialize(json, targetType, options); } } public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions options) { JsonSerializer.Serialize(writer, (object)value, options); } }性能优化阶段迁移完成后利用System.Text.Json的特性进行针对性优化如使用源生成器减少运行时反射。常见问题解决方案问题1属性名称大小写不一致// 解决方案统一配置命名策略 var options new JsonSerializerOptions { PropertyNamingPolicy JsonNamingPolicy.CamelCase };问题2私有成员序列化// 解决方案使用IncludeFields选项 var options new JsonSerializerOptions { IncludeFields true };问题3构造器参数反序列化// 解决方案使用[JsonConstructor]标注或配置ParameterizedConstructorHandling public class Person { [JsonConstructor] public Person(string name) Name name; public string Name { get; } }迁移检查清单[ ] 测试覆盖率达标建议85%[ ] 自定义转换器实现完成[ ] 性能基准测试通过[ ] 第三方库兼容性验证[ ] 文档更新完成对于大型项目可以采用混合模式逐步迁移。例如ASP.NET Core项目可以同时配置两个JSON处理器// Program.cs中配置 builder.Services.AddControllers() .AddNewtonsoftJson() // 兼容现有API .AddJsonOptions(options { // 逐步迁移到System.Text.Json });实际案例表明一个中等规模的项目约10万行代码通常需要2-4周的迁移周期其中测试和验证占用了大部分时间。迁移后的性能提升因项目而异但普遍报告显示序列化操作速度提升20-40%内存分配减少30-50%。4. 性能优化与高级技巧成功迁移到System.Text.Json后开发者可以进一步探索其高级特性和优化技巧充分发挥其性能潜力。本节将深入探讨各种优化手段和实用技巧帮助您将JSON处理性能推向极致。**源生成器(Source Generator)**是System.Text.Json最具革命性的特性之一。它通过在编译时生成序列化代码完全避免了运行时反射带来的性能开销。启用源生成器只需几个简单步骤定义部分类并标注JsonSerializerContext[JsonSerializable(typeof(Person))] [JsonSerializable(typeof(ListPerson))] public partial class JsonContext : JsonSerializerContext { }在序列化时使用生成的代码var persons new ListPerson { /*...*/ }; string json JsonSerializer.Serialize(persons, JsonContext.Default.ListPerson); Person[] deserialized JsonSerializer.Deserialize(json, JsonContext.Default.PersonArray);基准测试表明源生成器可以带来以下改进序列化速度提升40-60%反序列化速度提升30-50%启动时间缩短80%以上内存分配减少60-80%池化技术是另一个重要优化手段。System.Text.Json大量使用ArrayPool来减少内存分配开发者可以进一步扩展这一理念// 自定义ArrayPool实现 public class CustomArrayPool : ArrayPoolbyte { public override byte[] Rent(int minimumLength) { // 自定义分配逻辑 } public override void Return(byte[] array, bool clearArray false) { // 自定义回收逻辑 } } // 使用自定义池 var options new JsonSerializerOptions { DefaultBufferSize 16384, ArrayPool new CustomArrayPool() };异步处理在大文件场景下至关重要。System.Text.Json提供了真正的异步API可以高效处理大型JSON流// 异步写入大型JSON文件 await using (var fileStream File.Create(large.json)) { var data GenerateLargeData(); await JsonSerializer.SerializeAsync(fileStream, data); } // 异步读取大型JSON文件 await using (var fileStream File.OpenRead(large.json)) { var data await JsonSerializer.DeserializeAsyncMyDataType(fileStream); }高级配置选项可以微调序列化行为。以下是一些实用配置组合var optimizedOptions new JsonSerializerOptions { WriteIndented false, // 紧凑格式 IgnoreNullValues true, // 忽略null值 DefaultIgnoreCondition JsonIgnoreCondition.WhenWritingDefault, PropertyNamingPolicy JsonNamingPolicy.CamelCase, DictionaryKeyPolicy JsonNamingPolicy.CamelCase, NumberHandling JsonNumberHandling.AllowReadingFromString, ReferenceHandler ReferenceHandler.IgnoreCycles, MaxDepth 64, // 防止深度嵌套攻击 Encoder JavaScriptEncoder.UnsafeRelaxedJsonEscaping // 性能更好的编码器 };性能对比数据展示了优化前后的差异基于1MB JSON数据测试场景耗时(ms)内存分配(MB)Newtonsoft.Json1258.2System.Text.Json(基本)855.6System.Text.Json(优化)522.1源生成器模式310.8疑难问题解决方案问题处理动态或弱类型JSON// 使用JsonNode处理动态JSON JsonNode node JsonNode.Parse(jsonString); string name node[person][name].GetValuestring(); // 修改动态JSON node[person][age] 31; string modifiedJson node.ToJsonString();问题处理非公共成员var options new JsonSerializerOptions { IncludeFields true, // 包含字段 PropertyNamingPolicy JsonNamingPolicy.CamelCase, Encoder JavaScriptEncoder.UnsafeRelaxedJsonEscaping };问题处理特殊日期格式public class DateTimeConverter : JsonConverterDateTime { public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return DateTime.ParseExact(reader.GetString(), yyyy-MM-dd HH:mm:ss, CultureInfo.InvariantCulture); } public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options) { writer.WriteStringValue(value.ToString( yyyy-MM-dd HH:mm:ss, CultureInfo.InvariantCulture)); } }掌握这些高级技巧后您的JSON处理代码不仅会更加高效还能更好地适应各种复杂场景。记得始终通过基准测试验证优化效果因为不同场景下的最佳实践可能有所差异。
