当前位置:

首页 > 编程开发 > 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 中的 ReadCommentHandling 和 AllowTrailingCommas 只影响反序列化,而 DefaultIgnoreCondition 同时影响双向。最容易被忽略的是绑定数组或集合时的空字符串处理——它不走 JSON 配置,而是由 ArrayModelBinder 或 ComplexObjectModelBinder 控制。

    • 确保 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 错误。
    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    GitHub六个AI开源项目能做什么?软件理解、语音与求职场景
    GitHub六个AI开源项目能做什么?软件理解、语音与求职场景

    解析六个GitHub AI开源项目的具体用途,包括软件静态分析、智能体回答检查、多语言配音、求职材料生成、本地代码检索及动态歌词展示,帮助开发者根据实际需求筛选工具并正确验证结果。

    opencode安装skills教程及本地配置方法
    opencode安装skills教程及本地配置方法

    遇到OpenCode Skills无法加载或配置无效?本文手把手教你完成Skills的安装、环境变量设置及本地调试,避开常见坑点,让AI助手更懂你的代码习惯。

    如何开启Visual Studio2022实时代码分析警告提示
    如何开启Visual Studio2022实时代码分析警告提示

    解决 Visual Studio 2022 编辑时不显示代码分析警告的问题。指南涵盖 .NET 项目实时分析设置、Roslyn 分析器范围调整及错误列表来源筛选,确保开发者能高效利用实时代码诊断功能。

    如何在Visual Studio2022查看变量监视窗口调试程序
    如何在Visual Studio2022查看变量监视窗口调试程序

    详解 Visual Studio 2022 调试技巧:包括断点设置、监视窗口开启方法、变量添加步骤以及通过 F10 单步执行观察变量值变化的全过程。

    Visual Studio2017设置默认编码为UTF-8不带BOM
    Visual Studio2017设置默认编码为UTF-8不带BOM

    针对 Visual Studio 2017 缺乏全局默认编码选项的情况,详解如何利用 .editorconfig 设定项目级 UTF-8 无 BOM 规则,以及手动转换现有文件并校验字节的方法。

    Visual Studio2022F5调试提示启动项目未配置怎么修复
    Visual Studio2022F5调试提示启动项目未配置怎么修复

    解决 Visual Studio 2022 F5 调试报错问题,通过设置启动项目、检查解决方案属性及正确区分类库与应用项目,快速恢复调试功能。

    Visual Studio2022NuGet包还原失败离线处理方案
    Visual Studio2022NuGet包还原失败离线处理方案

    解决Visual Studio 2022离线环境中NuGet包还原失败的难题,涵盖依赖链分析、本地源配置、包集收集及隔离验证步骤,帮助开发者构建稳定的离线开发环境。

    Visual Studio2017大项目加载缓慢,优化加载性能技巧
    Visual Studio2017大项目加载缓慢,优化加载性能技巧

    解决Visual Studio 2017大型项目加载慢的实用指南。涵盖性能监测、扩展管理、文档恢复优化及版本兼容性检查,帮助开发者精准定位瓶颈并提升工作效率。

    Visual Studio2022设置多启动项目同时调试运行
    Visual Studio2022设置多启动项目同时调试运行

    详解 Visual Studio 2022 多启动项目配置方法,包括启动动作选择、顺序调整及调试技巧,帮助开发者高效调试分布式或前后端分离应用。

    fastapi下载文件接口实现教程
    fastapi下载文件接口实现教程

    深入解析在FastAPI框架中实现文件下载接口的完整方案,涵盖基于FileResponse的本地静态文件传输、基于StreamingResponse的分块流式传输、RFC 5987中文文件名编码规范、路径穿越安全防御及BackgroundTasks临时文件清理,并配备详细代码示例与架构解析图。

    查看更多
    精品专题 更多
    装机必备
    装机必备

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

    Windows
    Windows

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

    PDF教程
    PDF教程

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

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。