C#怎么生成json字符串_C#如何将实体类序列化为json【技巧】

老宇吖_3483

老宇吖_3483

2026-03-25

490人浏览

原创

推荐使用 System.Text.Json 序列化对象,它是 .NET Core 3.0+ 内置高性能 JSON 库,无需额外 NuGet,结果紧凑、安全且 UTF-8 友好;需注意配置差异、循环引用处理、特性迁移(如 [JsonPropertyName])、类型兼容性及 null/默认值控制策略。

c#怎么生成json字符串_c#如何将实体类序列化为json【技巧】

用 System.Text.Json 序列化对象最稳妥

默认推荐走 System.Text.Json,它是 .NET Core 3.0+ 内置的高性能 JSON 库,无需额外 NuGet,序列化结果紧凑、安全(默认不序列化私有字段和循环引用),且对 UTF-8 友好。

常见错误是直接用 JsonConvert.SerializeObject(来自 Newtonsoft.Json)却没装包,或者混用两个库导致配置不一致。

  • JsonSerializer.Serialize(obj) 是最简调用,适合大多数场景
  • 需要控制格式时加 JsonSerializerOptions:比如 options.WriteIndented = true 美化输出,options.PropertyNamingPolicy = JsonNamingPolicy.CamelCase 转驼峰
  • 若实体含只读属性或私有 setter,需显式启用:options.IgnoreReadOnlyProperties = false(默认为 true)
  • 遇到 NotSupportedException: A possible object cycle was detected,不是要关循环检测,而是检查是否真有循环引用;真需要忽略,设 options.ReferenceHandler = ReferenceHandler.Preserve(仅限 .NET 6+)

Newtonsoft.Json 还能用,但要注意版本和配置差异

老项目还在用 Newtonsoft.Json(即 JsonConvert)很常见,它更灵活,但默认行为和 System.Text.Json 不同——比如默认序列化私有字段、支持更多类型、循环引用处理更宽松。

容易踩的坑是:升级到 .NET 6/7 后仍沿用旧习惯,结果发现日期格式变了(System.Text.Json 默认 ISO 8601,Newtonsoft 默认是 "\/Date(123)\/" 风格),或空字符串被序列化成 null(因 NullValueHandling.Ignore 配置未同步)。

C#
C#

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

下载
  • 用 JsonConvert.SerializeObject(obj, new JsonSerializerSettings { DateFormatHandling = DateFormatHandling.IsoDateFormat }) 统一日期格式
  • 若想让 string.Empty 不被跳过,确保没设 NullValueHandling.Ignore,或改用 DefaultValueHandling.Ignore
  • 迁移时注意 [JsonProperty("xxx")] 在 System.Text.Json 中对应的是 [JsonPropertyName("xxx")],别漏改特性

序列化失败时先看异常堆栈里的具体类型

报错信息里带 NotSupportedException 或 InvalidOperationException 很常见,但真正卡点往往藏在内层类型上——比如你序列化一个 List,实际崩在 MyClass 里某个 DateTimeOffset? 字段(.NET 5 以下不支持),或某个自定义类没无参构造函数(Newtonsoft 要求,System.Text.Json 默认不要求但反序列化时要)。

  • 把对象先简化:只留 1–2 个基础字段,确认能跑通,再逐步加回
  • 检查字段类型是否在目标框架中受支持(如 System.Drawing.Color、DBNull、Pointer 类型基本都不行)
  • 若用 ASP.NET Core,默认 MVC 的 JSON 输出走 System.Text.Json,但你手动调 JsonConvert 就可能触发混合行为,导致同一对象在 API 返回和日志打印里格式不一致

别忘了 null 值和默认值的处理逻辑

JSON 字符串里要不要出现 "name": null 或 "count": 0,不是由语言决定的,而是由序列化器的选项和属性上的特性共同控制。很多人以为加了 [JsonIgnore] 就万事大吉,其实 System.Text.Json 和 Newtonsoft 对它的响应方式不同。

  • [JsonIgnore] 在两者中都生效,但 System.Text.Json 还认 [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] 这种细粒度条件(.NET 5+)
  • 想让 int? count = null 不出现在 JSON 里,Newtonsoft 用 NullValueHandling.Ignore;System.Text.Json 则需 options.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
  • 默认值(如 public bool IsActive { get; set; } = true)不会自动省略,除非加 [DefaultValue(true)] 并配合对应选项(Newtonsoft 支持,System.Text.Json 不支持该特性)

字段级控制比全局选项更可靠,尤其当一个类里有些字段要保留 null、有些要忽略时。别指望靠“统一配一个选项”解决所有问题。

相关文章

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

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

下载

相关标签:

c#

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

相关专题

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

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

2023.08.08

1132

5

什么是c#
什么是c#

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

2023.08.31

3351

3

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

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

2024.03.13

945

8

C#Task用法
C#Task用法

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

2024.03.14

2655

11

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

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

2026.02.03

352

18

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

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

2026.02.06

429

20

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

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

2026.03.11

631

24

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

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

2026.04.13

329

20

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.02

7199

3

热门下载

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

精品课程

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

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

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

共0课时 | 0人学习