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

当前位置:

首页 > 编程开发 > 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
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

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

    Windows

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

    PDF教程

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

    macOS软件

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

    IOS软件

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

    AI

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

    Mac软件 更多
    Aperty macOS版
    Aperty macOS版

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

    火山引擎 网页版
    火山引擎 网页版

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

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

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

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

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

    火山引擎 网页版
    火山引擎 网页版

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

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

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

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirServer Windows版
    AirServer Windows版

    AirServer Windows版可把电脑变成AirPlay、Google Cast和Miracast无线投屏接收端,适合会议演示、课堂教学及家庭大屏分享。发送设备通常无需另装客户端,并可同时接收和智能排列多个镜像会话。