c#如何使用System.Text.Json_c#System.Text.Json完整教程与代码实例

小磊君_1472

小磊君_1472

2026-04-02

854人浏览

原创

system.text.json 默认不支持私有字段和循环引用,需显式配置includefields、allowreadonlyproperties等选项,并通过自定义converter处理枚举、空字符串、datetime时区等场景。

c#如何使用system.text.json_c#system.text.json完整教程与代码实例

System.Text.Json 默认不支持私有字段序列化,也不处理循环引用——这不是 bug,是设计选择;想用它替代 Newtonsoft.Json,必须主动补足这些缺口。

序列化私有字段和只读属性要显式配置 JsonSerializerOptions

默认情况下,System.Text.Json 只序列化 public get/set 属性,连 private set 都被忽略。比如:

class Person {
    public string Name { get; set; }
    private int _age;
    public int Age => _age; // 只读属性,无 setter
}

直接 JsonSerializer.Serialize(person) 会丢失 _age 和 Age。解决办法是启用字段访问 + 允许只读属性:

  • 添加 DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull(可选,控制 null 处理)
  • 设置 IncludeFields = true 让私有字段参与序列化
  • 设置 PropertyNamingPolicy = JsonNamingPolicy.CamelCase(如需驼峰)
  • 关键一步:用 JsonSerializerOptions 的 GetTypeInfo 或自定义 converter 处理只读属性(.NET 6+ 支持 AllowReadOnlyProperties = true)

.NET 6 起可直接写:

var options = new JsonSerializerOptions {
    IncludeFields = true,
    AllowReadOnlyProperties = true,
    WriteIndented = true
};

JsonSerializer.Deserialize<t></t> 报错 “Cannot create an instance of type T” 怎么办

常见于反序列化抽象类、接口或无参构造函数被删的类。错误信息通常是:System.NotSupportedException: Cannot create an instance of an interface. 或类似提示。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • 确保目标类型有 public 无参构造函数(哪怕只是 protected,也要加 [JsonConstructor] 标记)
  • 接口/抽象类必须配 JsonConverter,不能靠默认行为
  • 如果用了 record,注意 .NET 5+ 才支持 record 的位置参数自动绑定;.NET 6+ 才支持 with 表达式在反序列化中生效
  • 泛型类型如 List<t></t> 没问题,但 Dictionary<string object></string> 中的 object 值会被当作 JsonElement,不是任意 CLR 类型

处理 DateTime 时区和格式容易踩坑

System.Text.Json 默认把 DateTime 当作本地时间序列化成 ISO 8601 格式(如 "2023-04-05T10:30:00"),不带时区标识,反序列化也按本地时区解释——这在跨服务场景下极易出错。

  • 统一用 DateTimeOffset 替代 DateTime,它自带偏移量,序列化结果如 "2023-04-05T10:30:00+08:00"
  • 若必须用 DateTime,通过 JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()) 不起作用;得注册 JsonConverter<datetime></datetime> 子类,手动控制格式(例如固定为 UTC + "o" 格式)
  • options.DateTimeZoneHandling 这个属性不存在——那是 Newtonsoft.Json 的,System.Text.Json 没有等价项

自定义 Converter 是绕不开的硬需求

比如枚举转字符串、空字符串转 null、或者把 "true"/"false" 字符串反序列化为 bool,都得靠自定义 JsonConverter<t></t>。

  • 继承 JsonConverter<t></t>,重写 Read() 和 Write()
  • Read() 里用 ref Utf8JsonReader reader 手动跳过 token,避免调 reader.GetString() 前没判断 token 类型(否则抛 JsonException)
  • 别在 converter 里 new 大对象或做 IO,它会被高频复用
  • 注册方式有两种:全局加到 JsonSerializerOptions.Converters,或局部用 [JsonConverter(typeof(MyConverter))] 贴在字段上

一个典型例子:把空字符串转为 null 的 string converter,必须先判 reader.TokenType == JsonTokenType.String,再取值,否则遇到 null token 会崩。

System.Text.Json 看似轻量,但一旦脱离“public 属性 + DateTime + 基本类型”的舒适区,就得直面 converter、options 配置、版本兼容性这些细节——尤其在升级旧项目时,.NET 5 和 .NET 7 对 AllowReadOnlyProperties、JsonNumber 的支持差异,很容易漏掉。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

972

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

2731

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

865

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2615

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

312

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

389

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

611

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

309

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习