讲师中心 微信公众号
AI工具推荐 视频效率加速

C#怎么读写JSON文件 C#如何用Newtonsoft.Json序列化和反序列化对象【技巧】

风强小哥_3693

风强小哥_3693

发布时间:2026-03-29 15:10:31

|

1010人浏览过

|

来源于php中文网

原创

Newtonsoft.Json是最稳的JSON处理起点,需注意大小写匹配、无参构造函数、字段可见性、编码处理、异常捕获及日期/HTML转义等细节;System.Text.Json存在兼容性断层,迁移需谨慎。

c#怎么读写json文件 c#如何用newtonsoft.json序列化和反序列化对象【技巧】

用 JsonConvert.SerializeObject 和 JsonConvert.DeserializeObject<t></t> 是最稳的起点

Newtonsoft.Json(即 Json.NET)仍是 C# 里读写 JSON 最可靠的选择,尤其在 .NET Framework 和早期 .NET Core 项目中。它不依赖运行时反射优化,类型推导清晰,出错时提示也更贴近实际问题。

常见错误现象:JsonConvert.DeserializeObject<myclass>(json)</myclass> 报 JsonSerializationException,但 JSON 看起来“完全合法”——大概率是字段名大小写不匹配、缺少无参构造函数,或用了 readonly 字段没配 [JsonConstructor]。

  • 默认只序列化 public 实例属性/字段;private 或 readonly 字段需显式加 [JsonProperty]
  • 反序列化要求目标类型有 public 无参构造函数(除非用 [JsonConstructor] 指定)
  • 如果 JSON 中有额外字段,而类里没有对应属性,默认会静默忽略;加 JsonSerializerSettings.MissingMemberHandling = MissingMemberHandling.Error 可提前暴露问题
  • 日期格式默认是 ISO 8601,若服务端返回的是 Unix 时间戳或自定义格式,得配 DateTimeZoneHandling 或自定义 JsonConverter

读文件别直接 File.ReadAllText + DeserializeObject,小心编码和异常

Windows 默认记事本保存的 UTF-8 文件可能带 BOM,File.ReadAllText(path) 在没指定编码时会按系统默认(如 GBK)读取,导致中文乱码或解析失败;更糟的是,JSON 格式错误或文件为空时,DeserializeObject 直接抛异常,没留机会处理空值或日志。

C#
C#

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

下载
  • 读文件务必显式指定编码:File.ReadAllText(path, Encoding.UTF8)
  • 先检查文件是否存在、是否为空:if (!File.Exists(path) || new FileInfo(path).Length == 0)
  • 用 try/catch 包住 DeserializeObject,捕获 JsonReaderException(可拿到具体行号和位置)和 JsonSerializationException
  • 示例片段:
    string json = File.ReadAllText(path, Encoding.UTF8);<br>try {<br>    return JsonConvert.DeserializeObject<Config>(json);<br>} catch (JsonReaderException ex) {<br>    throw new InvalidOperationException($"JSON 解析失败(第 {ex.LineNumber} 行,第 {ex.LinePosition} 列):{ex.Message}", ex);<br>}

写文件记得用 JsonConvert.SerializeObject 配 Formatting.Indented 和 StringEscapeHandling.EscapeHtml

直接 SerializeObject(obj) 输出的是紧凑 JSON,人眼难读;更隐蔽的问题是,默认不转义 HTML 特殊字符(如 、<code>&),如果 JSON 后续要嵌入 HTML 或被前端 innerHTML 渲染,可能引发 XSS 或解析中断。

  • 开发调试阶段加 Formatting.Indented:JsonConvert.SerializeObject(obj, Formatting.Indented)
  • 若 JSON 会进网页上下文(比如内联 script 标签),加 new JsonSerializerSettings { StringEscapeHandling = StringEscapeHandling.EscapeHtml }
  • 避免用 File.WriteAllText 写完立刻被其他进程读取——考虑先写到临时文件,再 File.Move 原子替换,防止读到半截内容
  • 注意 DateTime 序列化:默认输出带时区信息(如 "2024-05-20T14:30:00+08:00"),若后端只要日期或 UTC,设 DateTimeZoneHandling = DateTimeZoneHandling.Utc

.NET 6+ 用 System.Text.Json?先看清兼容性断层

虽然微软主推 System.Text.Json,但它和 Newtonsoft.Json 在行为上有多处不兼容:比如默认不支持循环引用、不支持 DataSet/DataTable、对字典 key 的类型限制更死(只接受 string)、JsonElement 不可变导致修改成本高。很多老项目迁过去后,JsonConvert.DeserializeObject<dictionary object>></dictionary> 这种灵活写法直接崩。

  • 如果你的项目已重度依赖 JObject、JArray 动态操作,或用了大量自定义 JsonConverter,别硬切 System.Text.Json
  • System.Text.Json 的 JsonSerializerOptions.PropertyNamingPolicy 默认是驼峰,Newtonsoft 默认是原样;迁移时字段名大小写错位是高频坑
  • 若必须共存(比如部分模块用新库),注意两个库对同一对象序列化的结果可能不同——尤其是 null 值处理、浮点数精度、DBNull 映射

真正麻烦的不是语法怎么写,而是 JSON 结构松散、上下游契约模糊时,序列化器替你做的“自动适配”反而掩盖了数据不一致。宁可多写几行验证逻辑,也别信默认行为。

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

1132

2023.08.08

什么是c#
什么是c#

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

3331

2023.08.31

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

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

945

2024.03.13

C#Task用法
C#Task用法

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

2655

2024.03.14

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

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

352

2026.02.03

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

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

429

2026.02.06

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

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

631

2026.03.11

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

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

329

2026.04.13

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

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

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn