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

c#如何写入JSON文件_c#写入JSON文件常见问题与排错指南

风墨吖_4030

风墨吖_4030

发布时间:2026-04-07 14:17:35

|

333人浏览过

|

来源于php中文网

原创

最稳妥方式是直接用 System.Text.Json.JsonSerializer.Serialize 配合 File.WriteAllText,显式指定 Encoding.UTF8,避免手动拼接、乱码、非法 JSON;需排除 Type 等不可序列化类型,空对象应判空处理,中文转义可通过 JavaScriptEncoder.UnsafeRelaxedJsonEscaping 关闭。

c#如何写入json文件_c#写入json文件常见问题与排错指南

用 JsonSerializer.Serialize 写入 JSON 文件最稳妥

直接调用 System.Text.Json.JsonSerializer.Serialize + File.WriteAllText 是 .NET 5+ 推荐方式,不依赖第三方库,性能好、默认安全。别再用过时的 JsonConvert.SerializeObject(Newtonsoft)除非项目强绑定旧代码。

常见错误是把对象序列化后手动拼字符串再写入,比如先 ToString() 再写文件——这会破坏转义和编码,尤其含中文或特殊字符时直接生成非法 JSON。

  • 正确写法:
    var data = new { Name = "张三", Age = 28 };<br>string json = JsonSerializer.Serialize(data, new JsonSerializerOptions { WriteIndented = true });<br>File.WriteAllText("user.json", json, Encoding.UTF8);
  • 必须显式传 Encoding.UTF8,否则 Windows 默认 ANSI 编码,中文变乱码
  • 若对象含 DateTime,默认输出格式是 ISO 8601(如 "2024-05-20T14:30:00"),无需额外配置;但若需自定义格式,得用 JsonConverter,不是改 ToString()

写入时抛出 NotSupportedException: Serialization and deserialization of 'System.Type' instances are not supported

这是典型反射型对象误序列化:比如类里有 Type、MethodInfo、Delegate 或未标记 [Serializable] 的非公共字段。JSON 格式无法表达这些运行时类型信息。

常见场景:DTO 类继承了含 GetType() 返回值的基类,或用了 object 字段存了委托/类型实例。

C#
C#

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

下载
  • 检查目标对象所有属性类型,排除 Type、Assembly、MethodInfo 等运行时类型
  • 用 [JsonIgnore] 跳过有问题的属性(加在属性上,不是字段)
  • 不要试图用 JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()) 解决这个问题——它只管枚举,不处理类型元数据
  • 若必须保留某些元数据,应提前转换为字符串或字典,例如:TypeName = typeof(MyClass).FullName

写入空对象或 null 导致文件内容为 null 而不是空 JSON 对象

当序列化的对象是 null,JsonSerializer.Serialize 默认输出字符串 "null",而不是 {}。这会让下游解析失败,尤其前端 JS 用 JSON.parse() 时直接报错。

这不是 bug,是设计行为——JSON 规范中 null 是合法值,但业务上常需要“空对象占位”。

  • 写入前做空值判断:if (data == null) data = new object();
  • 或统一用可空包装类,如 MyDto? 配合 JsonSerializerOptions.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,但这只跳过字段,不改变根对象为 null 的行为
  • 更可靠的做法是封装一个写入方法:
    public static void WriteJson<T>(string path, T value, JsonSerializerOptions options = null)<br>{<br>    var json = value switch<br>    {<br>        null => "{}",<br>        _ => JsonSerializer.Serialize(value, options ?? new JsonSerializerOptions { WriteIndented = true })<br>    };<br>    File.WriteAllText(path, json, Encoding.UTF8);<br>}

中文写入后显示为 Unicode 转义(如 \u5f20\u4e09)

这是 JsonSerializerOptions 默认启用 Encoder 导致的——它为防 XSS 强制转义非 ASCII 字符。开发阶段看着难受,部署到 Web API 时反而合理;但写配置文件或日志时,显然要可读。

注意:这不是编码问题(UTF-8 没错),是序列化器主动编码策略。

  • 关闭转义只需一行:options.Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping;
  • 不要用 new UTF8Encoding(false) 替代——它解决不了这个现象
  • 该设置不影响安全性,因为写入文件不涉及浏览器渲染;但若该 JSON 后续被 Web 页面直接 innerHTML 插入,就得自己做 HTML 转义,不能依赖这个设置
  • 如果只对特定字符串字段禁用转义,应自定义 JsonConverter<string>,而非全局改 Encoder
实际项目里最容易忽略的是:写入路径权限不足导致静默失败(尤其 Windows 服务或 Docker 容器内),建议写入前加 Directory.CreateDirectory(Path.GetDirectoryName(path)) 并捕获 UnauthorizedAccessException。

热门AI工具

更多
切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

WorkBuddy

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

豆包大模型

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

DeepSeek

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

UpDream
UpDream Hot

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

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

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

992

2023.08.08

什么是c#
什么是c#

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

2791

2023.08.31

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

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

865

2024.03.13

C#Task用法
C#Task用法

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

2615

2024.03.14

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

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

312

2026.02.03

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

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

389

2026.02.06

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

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

611

2026.03.11

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

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

329

2026.04.13

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

0

2026.10.15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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