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

C#怎么使用配置文件_C#读取appsettings配置教程【详解】

冬明君_2997

冬明君_2997

发布时间:2026-05-13 19:30:37

|

603人浏览过

|

来源于php中文网

原创

.NET 6/7/8 应使用 IConfiguration + 依赖注入读取 appsettings.json,而非 ConfigurationManager;需确保文件复制到输出目录、未清空默认配置源,并通过 GetSection 绑定强类型对象或用 IOptions 安全访问嵌套配置。

c#怎么使用配置文件_c#读取appsettings配置教程【详解】

直接说结论:C# 读取 appsettings.json 不再推荐用 ConfigurationManager,而是用 IConfiguration + 依赖注入(.NET Core / .NET 5+ 项目);传统 .NET Framework 项目才用 App.config + ConfigurationManager。选错方式会导致配置读不到、启动报错或热重载失效。

怎么在 .NET 6/7/8 项目里正确加载 appsettings.json

现代 C# 项目(Microsoft.NET.Sdk.Web 或 Microsoft.NET.Sdk)默认内置 JSON 配置支持,但必须确认两件事:

  • appsettings.json 文件的 Copy to Output Directory 属性设为 Copy always 或 Copy if newer(否则运行时找不到文件)
  • 主程序入口(如 Program.cs)中没手动清空配置源 —— 默认的 Host.CreateDefaultBuilder() 已自动添加 appsettings.json 和 appsettings.{Environment}.json
  • 如果自定义了 IHostBuilder,需显式调用 .ConfigureAppConfiguration() 并添加 .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)

常见错误:把 appsettings.json 放在子文件夹(如 Config/appsettings.json),却不改 AddJsonFile 的路径参数,结果配置始终为空。

为什么 ConfigurationManager.AppSettings["xxx"] 在新项目里返回 null

因为 ConfigurationManager 是 .NET Framework 时代的 API,它只读取 App.config 或 Web.config 中的 <appSettings> 节点,对 appsettings.json 完全无感知。在 .NET 5+ 项目中引用 System.Configuration.ConfigurationManager NuGet 包后虽能编译通过,但运行时不会自动加载 JSON 文件。

  • 错误写法:ConfigurationManager.AppSettings["ApiUrl"] → 总是 null(除非你额外调用 ConfigurationManager.OpenMappedExeConfiguration 手动加载 JSON,但这违背设计初衷)
  • 正确替代:IConfiguration.GetValue<string>("ApiUrl") 或 configuration["ApiUrl"](configuration 是注入的 IConfiguration 实例)
  • 注意层级:JSON 中 {"ConnectionStrings": {"Default": "..."}} 对应的 key 是 "ConnectionStrings:Default",冒号是层级分隔符,不是点号

怎么安全读取嵌套配置并避免 NullReferenceException

直接用 configuration["Section:SubKey"] 容易因路径拼错或配置缺失导致返回 null,后续调用 .ToString() 或 .Length 就崩。更稳妥的方式是绑定到强类型对象:

Pandas 配置文件报告生成器
Pandas 配置文件报告生成器

使用ydata-profiling(前身为pandas-profiling)生成全面的数据质量报告,包含相关性分析、缺失值模式和基数检测。导出交互式HTML仪表板和JSON摘要。

下载
public class ApiSettings
{
    public string BaseUrl { get; set; } = string.Empty;
    public int TimeoutSeconds { get; set; } = 30;
}

然后在 Program.cs 中注册:

builder.Services.Configure<ApiSettings>(builder.Configuration.GetSection("Api"));

使用时注入 IOptions<ApiSettings> 或 IOptionsSnapshot<ApiSettings>(后者支持环境变化时重新读取):

  • IOptions:只在启动时读取一次,适合静态配置
  • IOptionsSnapshot:每次请求解析新实例,支持 reloadOnChange: true 场景(如开发时改 JSON 立即生效)
  • 别直接用 IOptionsMonitor 除非你需要监听变更事件——它生命周期长,容易引发内存泄漏

为什么本地能读到配置,发布到 IIS 或 Linux 就失效

根本原因常是部署路径和权限问题,不是代码问题:

  • 发布后 appsettings.json 必须和 .dll 同目录(例如 publish/MyApp.dll 和 publish/appsettings.json);若用了 dotnet publish -o /path,要确保目标目录包含该文件
  • Linux 上注意大小写:AppSettings.json ≠ appsettings.json;IIS 应用池 Identity(如 IIS AppPool\MyApp)需有读取 JSON 文件的权限
  • 容器部署(Docker)时,如果挂载了外部配置,要确认 COPY 或 VOLUME 指令没覆盖掉默认 appsettings.json
  • 检查实际加载的配置源:在 Program.cs 加一行 Console.WriteLine(builder.Configuration.AsEnumerable());,看输出里有没有你的 JSON 文件路径

最常被忽略的一点:生产环境设置了 ASPNETCORE_ENVIRONMENT=Production,但忘了提供 appsettings.Production.json,导致只加载了空的默认配置,而你以为是代码没读到。

热门AI工具

更多
咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

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

墨刀AI
墨刀AI Hot

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

切问学术

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

相关专题

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

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

972

2023.08.08

什么是c#
什么是c#

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

2751

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)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

309

2026.04.13

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

80

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
零基础精通 PS 视频教程
零基础精通 PS 视频教程

共268课时 | 119.7万人学习

前端工程师必备技能—PS切图
前端工程师必备技能—PS切图

共11课时 | 2.2万人学习

麦子学院Photoshop切片视频教程
麦子学院Photoshop切片视频教程

共13课时 | 4.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn