.NET中JSON序列化方案对比与最佳实践

1. .NET对象转JSON的常见场景与需求分析

在.NET开发中，对象与JSON之间的转换几乎成为日常开发的标配操作。无论是Web API的请求响应、配置文件读写，还是分布式系统间的数据交换，JSON作为轻量级的数据交换格式都扮演着关键角色。根据我的项目经验，这种转换需求主要出现在以下几个典型场景：

• Web API开发中控制器方法的输入输出
• 前端JavaScript与后端C#的数据交互
• 微服务之间的跨进程通信
• 应用程序配置的序列化存储
• 日志记录和审计跟踪的数据格式化

选择恰当的序列化方式需要考虑多个维度：性能表现、内存占用、功能完整性、自定义灵活性以及跨平台兼容性等。不同的序列化器在这些方面各有优劣，开发者需要根据具体场景做出权衡。

重要提示：在ASP.NET Core 3.0及更高版本中，默认的JSON序列化器已从Newtonsoft.Json切换为System.Text.Json，这是微软官方推荐的性能更优的解决方案。

2. 主流JSON序列化方案深度对比

2.1 System.Text.Json（官方推荐）

作为.NET Core 3.0引入的内置库，System.Text.Json提供了高性能、低内存分配的序列化能力。其API设计简洁明了：

csharp复制// 基本序列化
var json = JsonSerializer.Serialize(myObject);

// 带选项的序列化
var options = new JsonSerializerOptions {
    WriteIndented = true,
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase
};
var formattedJson = JsonSerializer.Serialize(myObject, options);

性能优势主要体现在：

• 采用Span和Memory减少内存分配
• 基于Utf8JsonWriter直接写入UTF-8字节
• 避免反射开销的源代码生成器支持

实测数据显示，在相同硬件环境下，System.Text.Json比Newtonsoft.Json快2-3倍，内存分配减少30-50%。对于高性能要求的场景，这是不二之选。

2.2 Newtonsoft.Json（Json.NET）

作为曾经的事实标准，Newtonsoft.Json以其强大的功能和灵活的配置著称。虽然性能不及System.Text.Json，但在复杂场景下仍不可替代：

csharp复制// 基础用法
string json = JsonConvert.SerializeObject(myObject);

// 高级配置
var settings = new JsonSerializerSettings {
    Formatting = Formatting.Indented,
    NullValueHandling = NullValueHandling.Ignore,
    ContractResolver = new CamelCasePropertyNamesContractResolver()
};
string customJson = JsonConvert.SerializeObject(myObject, settings);

独特优势包括：

• 完善的循环引用处理
• 丰富的类型转换器体系
• 更灵活的自定义序列化控制
• 对动态类型的原生支持

2.3 DataContractJsonSerializer

作为WCF时代的产物，DataContractJsonSerializer仍然在某些遗留系统中发挥作用：

csharp复制var serializer = new DataContractJsonSerializer(typeof(MyClass));
using (var stream = new MemoryStream()) {
    serializer.WriteObject(stream, myObject);
    string json = Encoding.UTF8.GetString(stream.ToArray());
}

特点分析：

• 强依赖[DataContract]和[DataMember]特性
• 严格的类型契约控制
• 与WCF服务高度集成
• 性能表现中等偏下

2.4 JavaScriptSerializer

这是ASP.NET早期提供的简单序列化器，现在基本已被淘汰：

csharp复制var serializer = new JavaScriptSerializer();
string json = serializer.Serialize(myObject);

仅建议在维护旧系统时使用，新项目应避免采用。

3. 高级应用场景与性能优化

3.1 处理循环引用问题

当对象图包含循环引用时，不同序列化器的处理方式各异：

csharp复制// System.Text.Json的解决方案
options.ReferenceHandler = ReferenceHandler.Preserve;

// Newtonsoft.Json的解决方案
settings.PreserveReferencesHandling = PreserveReferencesHandling.All;

实际测试表明，Newtonsoft.Json的循环引用处理更为成熟，能更好地维护对象关系。

3.2 自定义转换器实现

对于特殊类型的序列化，需要自定义转换器：

csharp复制// System.Text.Json自定义转换器
public class CustomDateTimeConverter : JsonConverter<DateTime>
{
    public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        return DateTime.ParseExact(reader.GetString(), "yyyy-MM-dd", CultureInfo.InvariantCulture);
    }

    public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(value.ToString("yyyy-MM-dd"));
    }
}

// 使用转换器
options.Converters.Add(new CustomDateTimeConverter());

3.3 异步序列化实践

对于大对象或流式场景，异步序列化能显著提升响应能力：

csharp复制// System.Text.Json异步序列化
await using var stream = new MemoryStream();
await JsonSerializer.SerializeAsync(stream, largeObject);

4. 实战性能对比与选型建议

通过基准测试对比各方案性能（测试对象：包含1000个复杂属性的对象）：

选型决策树：

1. 是否ASP.NET Core 3.0+？ → 是 → 首选System.Text.Json
2. 需要高级功能？ → 是 → 考虑Newtonsoft.Json
3. 需要WCF兼容？ → 是 → DataContractJsonSerializer
4. 其他情况 → System.Text.Json

5. 常见问题排查与调试技巧

5.1 日期格式不一致问题

不同序列化器默认的日期格式处理不同：

• System.Text.Json：ISO 8601格式（"2023-01-01T00:00:00"）
• Newtonsoft.Json：微软JSON日期格式（"/Date(1672531200000)/"）

统一方案：

csharp复制// System.Text.Json配置
options.Converters.Add(new JsonStringEnumConverter());
options.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;

// Newtonsoft.Json配置
settings.DateFormatHandling = DateFormatHandling.IsoDateFormat;

5.2 大小写策略冲突

前端通常使用camelCase，而后端使用PascalCase，解决方案：

csharp复制// System.TextJson
options.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;

// Newtonsoft.Json
settings.ContractResolver = new CamelCasePropertyNamesContractResolver();

5.3 多态类型处理

处理继承体系时的最佳实践：

csharp复制[JsonDerivedType(typeof(Derived), typeDiscriminator: "derived")]
public class Base { }

public class Derived : Base { }

// 序列化时会自动添加"$type"字段

6. 现代.NET中的最佳实践

对于新项目，我的推荐方案是：

1. 默认使用System.Text.Json
2. 通过源生成器进一步提升性能
3. 仅在需要高级功能时引入Newtonsoft.Json
4. 为Web API配置全局序列化选项：

csharp复制builder.Services.Configure<JsonOptions>(options => {
    options.SerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
    options.SerializerOptions.Converters.Add(new JsonStringEnumConverter());
});

对于高性能场景，可以考虑使用源生成器：

csharp复制[JsonSerializable(typeof(MyPoco))]
public partial class MyContext : JsonSerializerContext {}

// 使用生成的序列化代码
var json = JsonSerializer.Serialize(poco, MyContext.Default.MyPoco);

这种编译时生成的方式可以完全消除反射开销，在频繁序列化的场景下可获得额外30%的性能提升。