展开菜单
首页 精品内容 本月促销 装机必备 Windows macOS软件 IOS软件 Android AI PDF教程 专题
全部分类

当前位置:

首页 > 编程开发 > C# ASP.NET Core JSON配置方法

C# ASP.NET Core JSON配置方法

全局JSON配置须在Program.cs服务注册阶段、AddControllers()之后Build()之前调用ConfigureHttpJsonOptions;System.Text.Json需手动设CamelCase、WhenWritingNull等,Newtonsoft需AddNewtonsoftJson且注意版本兼容。

全局JSON配置须在Program.cs服务注册阶段、AddControllers()之后Build()之前调用ConfigureHttpJsonOptions;System.Text.Json需手动设CamelCase、WhenWritingNull等,Newtonsoft需AddNewtonsoftJson且注意版本兼容。

C# 全局JSON序列化配置方法 C# ASP.NET Core如何统一配置JsonOptions

ASP.NET Core 6+ 中 ConfigureJsonOptions 的正确注册位置

全局 JSON 序列化配置必须在 Program.cs 的服务注册阶段完成,且要在 AddControllers()AddEndpointsApiExplorer() 之后、Build() 之前调用 ConfigureJsonOptions;否则配置不生效。常见错误是把它写在 app.Use...() 链中,或误放在 WebApplication.CreateBuilder() 之前。

  • ASP.NET Core 6+ 推荐写法:builder.Services.ConfigureHttpJsonOptions(options => { ... })(用于 System.Text.Json
  • 若项目仍用 Newtonsoft.Json,需先安装 Microsoft.AspNetCore.Mvc.NewtonsoftJson,再用 AddControllers().AddNewtonsoftJson(options => { ... })
  • ConfigureJsonOptions 是扩展方法,本质是对 IOptionsMonitor 的配置,不是直接修改单例实例

System.Text.Json 全局配置常用选项与陷阱

System.Text.Json 默认不支持循环引用、不忽略 null 值、属性名大小写敏感,且无法直接序列化 DateTime 为 Unix 时间戳——这些都得手动配。最易踩的坑是以为 PropertyNamingPolicy 能影响反序列化字段映射,其实它只控制序列化输出的 key 名,反序列化仍依赖属性名或 [JsonPropertyName] 特性。

  • 驼峰命名:options.PropertyNamingPolicy = JsonNamingPolicy.CamelCase
  • 忽略 null 值:options.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull(注意是 WhenWritingNull,不是 Always
  • 处理循环引用:原生不支持,必须改用 ReferenceHandler.Preserve(.NET 6+),但会引入 $id/$ref 字段,前端需兼容
  • 自定义 DateTime 格式:需添加 Converters.Add(new JsonStringEnumConverter()) 类似方式注册 JsonConverter 子类

Newtonsoft.Json 在 ASP.NET Core 中的全局配置方式

虽然微软已转向 System.Text.Json,但大量老项目仍依赖 Newtonsoft.Json 的灵活性,比如动态属性、 TypeNameHandling、更细粒度的日期格式控制。它的全局配置入口和生命周期与原生不同,不能混用 ConfigureJsonOptions

  • 必须显式调用 AddNewtonsoftJson(),例如:services.AddControllers().AddNewtonsoftJson(options => { options.DateFormatString = "yyyy-MM-dd HH:mm:ss"; })
  • ContractResolver 是核心扩展点,如用 CamelCasePropertyNamesContractResolver 实现驼峰,但它不会自动处理下划线转驼峰(需继承并重写 ResolvePropertyName
  • 若控制器方法返回 JsonResult,且未指定 JsonSerializerSettings,才走全局配置;若手动 new JsonSerializer,则不受影响
  • 注意包版本兼容性:Microsoft.AspNetCore.Mvc.NewtonsoftJson 6.0.x 只支持 .NET 6,不兼容 .NET 8 运行时

如何让 API 返回值和 ModelBinding 输入共用同一套 JSON 配置

默认情况下,System.Text.Json 的序列化(输出)和反序列化(ModelBinding 输入)共享同一组 JsonOptions,但有个关键例外:JsonSerializerOptions 中的 ReadCommentHandlingAllowTrailingCommas 只影响反序列化,而 DefaultIgnoreCondition 同时影响双向。最容易被忽略的是绑定数组或集合时的空字符串处理——它不走 JSON 配置,而是由 ArrayModelBinderComplexObjectModelBinder 控制。

  • 确保 services.Configure(...)services.ConfigureHttpJsonOptions(...) 配置一致,后者优先级更高
  • 若需对特定 Action 参数做定制反序列化,应使用 [FromBody] [JsonConverter(typeof(CustomConverter))],而非改全局
  • ModelBinding 对于 application/json 请求体,底层仍调用 JsonSerializer.DeserializeAsync,所以 Converters 列表对输入输出都生效
  • 全局配置无法覆盖 [JsonIgnore][JsonPropertyName] 等特性,特性始终具有更高优先级
实际项目里,JsonOptions 配置看似简单,但一旦涉及多环境(开发/生产)、多客户端(Web/iOS/Android)、多数据源(DTO/Entity),各环节的序列化行为就容易错位。尤其要注意 DateTime 处理、null 值策略、以及 Newtonsoft 和原生 JSON 的转换器注册时机——差一行代码,就可能让前端拿到空对象或 400 错误。
本文内容来源于互联网,如有侵权请联系删除。
作者最新文章
编程开发
相关文章 更多
精品专题 更多
本月促销

正软商城本月促销专区,汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动,提供限时折扣、特价授权和优惠购买信息,活动库存及价格以页面实时展示为准。

装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

IOS软件

正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

AI

正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

Mac软件 更多
灵活计算器
灵活计算器

灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

赤友清理大师
赤友清理大师

赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

图几
图几

图几是一款适用于 macOS 的截图、标注与美化工具,支持离线操作保障隐私。界面整理和高频系统操作被放到一起考虑,桌面或窗口内容一多时,管理起来会更省心。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Menuist
Menuist

Menuist 是一款面向 macOS 的 Finder 右键菜单增强工具,主要用来补充新建文件、快捷导航等常用操作,让日常文件管理和访问路径时更高效、更顺手。

Mole
Mole

Mole 是一款专为 Mac 设计的深度清理优化工具,涵盖缓存清理、应用管理及实时状态监控等功能。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

WINDOWS 更多
Windows 10
Windows 10

Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

傲梅轻松备份
傲梅轻松备份

傲梅轻松备份是一款专业易用的数据备份软件,为重要数据提供安全保障。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

Wise Folder Hider Pro
Wise Folder Hider Pro

Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件,为私密数据添加多重保护。高频操作更强调就近处理,浏览、整理和跨目录移动文件时,来回切换和重复点击都会少很多。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

PinStack
PinStack

PinStack是一款轻量级的Windows平台剪贴板管理工具,优化您的剪贴板使用体验。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Seer
Seer

Seer是一款在Win平台下的空格键功能增强效率工具,只需轻敲空格键,就能预览几乎任何格式的文件。它更适合把零散的小功能集中起来使用,处理高频琐碎任务时会更省事。