C#怎么格式化输出JSON_C#如何美化字符串缩进【必备】

落涛同学_2673

落涛同学_2673

2026-03-27

592人浏览

原创

最稳妥的JSON字符串缩进方案是使用System.Text.Json的JsonSerializerOptions并设置WriteIndented = true,它内置支持、轻量安全,.NET Core 3.0+默认推荐;该选项仅影响序列化输出(4空格缩进),不改变反序列化行为,且不可配置缩进宽度。

JSON字符串缩进用JsonSerializerOptions最稳妥

直接用system.text.json内置的序列化器,比手动拼接或第三方库更轻、更安全,也避免了newtonsoft.json(json.net)的额外依赖。.net core 3.0+ 默认推荐这条路。

关键不是“怎么加空格”,而是“怎么让序列化器自动做这件事”——靠JsonSerializerOptions里的WriteIndented开关:

  • WriteIndented = true:开启缩进,输出带换行和4空格缩进的可读JSON
  • WriteIndented = false(默认):紧凑格式,无换行无空格
  • 该选项只影响序列化(对象→字符串),不改变反序列化行为

示例:

var options = new JsonSerializerOptions { WriteIndented = true };
string json = JsonSerializer.Serialize(new { Name = "Alice", Age = 30 }, options);
// 输出:
// {
//   "Name": "Alice",
//   "Age": 30
// }

别用JsonConvert.SerializeObject(Newtonsoft)除非已有依赖

如果你项目里已经用了Newtonsoft.Json,那确实可以继续用JsonConvert.SerializeObject配合Formatting.Indented——但它不是.NET原生方案,且在高频/低延迟场景下有轻微性能开销。

常见踩坑点:

  • 忘记传Formatting.Indented参数,结果还是压缩格式:JsonConvert.SerializeObject(obj) → ❌;JsonConvert.SerializeObject(obj, Formatting.Indented) → ✅
  • 混用两个JSON库导致类型解析冲突,比如JObject和JsonElement不能直接互转
  • .NET 6+ 新项目硬上Newtonsoft,反而增加维护成本和冷启动时间

原始JSON字符串想美化?必须先解析再重序列化

如果手头只有string类型的JSON(比如从API响应拿到的紧凑字符串),不能直接“加缩进”。它本质是文本,没有结构信息——你得先解析成对象,再用带缩进的选项重新序列化。

否则会出错或白忙活:

C#
C#

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

下载
  • 错误做法:对字符串做正则替换加空格 → 容易破坏引号内内容、转义字符、注释(虽然JSON本不该有注释)
  • 正确路径:JsonSerializer.Deserialize(rawJson) → 再Serialize(..., options)
  • 注意:若原始JSON非法(如末尾逗号、单引号),解析阶段就会抛JsonException,这是必要校验,不是bug

简写示例:

string raw = @"{""name"":""Bob"",""tags"":[""a"",""b""]}";
var doc = JsonSerializer.Deserialize<jsonelement>(raw);
string pretty = JsonSerializer.Serialize(doc, new JsonSerializerOptions { WriteIndented = true });</jsonelement>

缩进宽度不可配置,4空格是硬编码值

System.Text.Json目前(.NET 8)不支持自定义缩进空格数,WriteIndented = true固定输出4个空格。这不是bug,是设计选择。

如果你真需要2空格或tab,只能:

  • 用Newtonsoft.Json的JsonTextWriter.Indentation和IndentChar控制(但代价是引入旧库)
  • 或解析后手动替换前导空格(不推荐:易误伤字符串字面量中的空格)
  • 或封装一层包装器,在Serialize后对每行开头的4空格做二次处理(仅限极端需求)

绝大多数调试、日志、配置导出场景,4空格完全够用;纠结这个宽度,往往说明还没遇到真正难搞的问题。

相关文章

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

3331

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人学习