C# JSON序列化方法 C#如何实现JSON序列化

6次阅读

system.text.json是.net core 3.0+默认推荐序列化方式,性能好、内存低、原生异步;需处理NULL输入和循环引用(用referencehandler.preserve或ignorecycles);newtonsoft.json功能更全但需注意特性配置与类型安全。

C# JSON序列化方法 C#如何实现JSON序列化

System.Text.Json 序列化对象最直接

这是 .NET Core 3.0+ 和 .NET 5+ 的默认推荐方式,性能好、内存占用低、原生支持异步。它不依赖第三方库,也不需要安装 Newtonsoft.Json

常见错误是传入 null 对象却没处理,会抛出 ArgumentNullException;或者对象里有循环引用,System.Text.Json 默认直接报错(InvalidOperationException: A possible Object cycle was detected)。

  • 简单序列化:
    var json = JsonSerializer.Serialize<Person>(person);
  • 带选项(忽略 null 值、驼峰命名):
    var options = new JsonSerializerOptions {     DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,     PropertyNamingPolicy = JsonNamingPolicy.CamelCase }; var json = JsonSerializer.Serialize(person, options);
  • 写入流(适合大对象或文件输出):
    await JsonSerializer.SerializeAsync(stream, person, options);

遇到循环引用必须显式配置 ReferenceHandler

System.Text.Json 默认禁止循环引用,不像 Newtonsoft.Json 那样默认开启引用跟踪。如果你的对象图里有父子双向引用(比如 Order 持有 CustomerCustomer 又持有 Order 列表),不配就会崩溃。

可选值只有两个:ReferenceHandler.Preserve(保留引用,生成 $id/$ref)和 ReferenceHandler.IgnoreCycles(跳过循环边,静默截断)。

  • 保留引用(JSON 更大,但能反序列化还原):
    var options = new JsonSerializerOptions {     ReferenceHandler = ReferenceHandler.Preserve,     WriteIndented = true };
  • 忽略循环(更轻量,但丢失部分关系):
    options.ReferenceHandler = ReferenceHandler.IgnoreCycles;
  • 注意:Preserve 模式下,反序列化也必须用相同选项,否则会失败

Newtonsoft.Json 时别漏掉 [JsonObject][JsonProperty]

虽然它兼容性更好、功能更全(比如动态属性、自定义转换器更灵活),但很多老项目升级后发现字段名不对、null 值没忽略、日期格式混乱——大概率是没加特性控制序列化行为。

  • [JsonObject(MemberSerialization.OptIn)] 表示只序列化打了 [JsonProperty] 的字段
  • [JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore)] 跳过默认值(如 0falsenull
  • [JsonProperty("user_id")] 强制指定字段名,比靠命名策略更可靠
  • 全局设置示例:
    var settings = new JsonSerializerSettings {     NullValueHandling = NullValueHandling.Ignore,     DateFormatString = "yyyy-MM-dd HH:mm:ss" };

序列化接口或抽象类要小心运行时类型丢失

如果字段声明为 IList<animal></animal>,实际是 List<dog></dog>System.Text.Json 默认只会序列化 Animal 定义的成员,Dog 特有字段直接消失。这不是 bug,是设计如此。

Newtonsoft.JsonTypeNameHandling 可以写入类型信息,但会带来安全风险(反序列化任意类型),生产环境一般禁用。

  • 安全做法:显式转成具体类型再序列化:
    var dogs = animals.Cast<Dog>().ToList(); var json = JsonSerializer.Serialize(dogs);
  • 或用 JsonSerializerContextSystem.Text.Json 源生生成)预注册派生类型,避免反射开销
  • 接口序列化没有银弹,得根据消费方是否知道具体类型来决定方案

实际项目里,选 System.Text.Json 还是 Newtonsoft.Json 不是看“好不好用”,而是看团队是否已深度绑定后者、有没有历史 JSON 格式契约要兼容、以及是否需要那些高级定制能力。一旦选定,就别在同一个项目里混用——序列化结果可能不一致,调试时容易绕晕。

text=ZqhQzanResources