C#如何读取配置文件_C#读写App.config和Web.config【技巧】

风萱君_8864

风萱君_8864

2026-04-20

743人浏览

原创

ConfigurationManager仅适用于.NET Framework项目,.NET Core/5+须用IConfiguration;AppSettings[key]返回null而非异常,ConnectionStrings[name]需判空再取ConnectionString;自定义节需继承ConfigurationSection并注册;App.config需设Copy to Output Directory,Web.config依赖IIS运行时加载。

c#如何读取配置文件_c#读写app.config和web.config【技巧】

ConfigurationManager 是读取 App.config 和 Web.config 最直接的方式,但它在 .NET Core/.NET 5+ 中已被弃用,仅适用于传统 .NET Framework 项目(如 WinForms、WPF、ASP.NET Web Forms、.NET Framework Console)。如果你用的是 .NET Core 或更高版本,请改用 IConfiguration —— 这是根本性差异,不是“写法不同”,而是底层机制完全不同。

读取 appSettings 和 connectionStrings 的最简路径

ConfigurationManager 提供两个静态属性:

  • ConfigurationManager.AppSettings["key"]:获取 下的字符串值,返回 null(不是空串)如果 key 不存在
  • ConfigurationManager.ConnectionStrings["name"]:获取 中指定 name 的连接字符串对象,需进一步访问 .ConnectionString 属性

常见错误现象:

  • 直接调用 ToString() 而不判空,导致 NullReferenceException
  • 拼错 key 名(XML 区分大小写),返回 null 后没处理,下游直接炸
  • 在 ASP.NET Core 项目里硬加 System.Configuration 引用,编译通过但运行时报 ConfigurationErrorsException:“无法识别的配置节”

建议做法:

  • 封装一个安全读取函数,比如:
    public static string GetAppSetting(string key, string defaultValue = "")
    {
      var value = ConfigurationManager.AppSettings[key];
      return string.IsNullOrEmpty(value) ? defaultValue : value;
    }
  • 对 ConnectionStrings,先检查 ConnectionStrings[name] 是否为 null,再取 .ConnectionString
  • 确保项目已引用 System.Configuration.dll,且目标框架是 .NET Framework 4.x(不是 .NET Standard 或 .NET 6+)

读取自定义配置节(如 )必须手动映射类

ConfigurationManager.GetSection("sectionName") 返回的是 object,不能直接强转,必须提前定义匹配的配置类,并在 中注册类型。

典型陷阱:

  • 忘记在 顶部添加 块,运行时抛出异常:“未能识别的配置节”
  • 配置类中属性名与 XML 属性名不一致(比如 XML 是 logPath,C# 属性写成 LogPath),读出来永远是默认值
  • ConfigurationProperty 的 IsRequired 设为 true,但 XML 中漏写了该属性,整个节加载失败

关键点:

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

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

下载
  • 自定义节类必须继承 ConfigurationSection
  • 子元素集合需用 ConfigurationElementCollection,且必须重写 CreateNewElement() 和 GetElementKey()
  • GetSection() 返回值始终要判空:var section = ConfigurationManager.GetSection("mySettings") as MyConfigSection;

为什么 ConfigurationManager.AppSettings[key] 有时返回 null 却不报错?

因为 AppSettings 是只读字典(KeyValueConfigurationCollection),它内部对不存在的 key 返回 null,而非抛异常。这不是 bug,是设计行为。

影响和应对:

  • 它不会触发配置文件语法校验 —— 即使 App.config 根本没被复制到输出目录(Copy to Output Directory 设为 Do not copy),也不会在编译或启动时报错,只会静默返回 null
  • 调试时容易误以为“配置读到了”,实际是空值穿透进业务逻辑
  • 推荐在应用启动时集中验证关键配置项是否存在,例如:
    if (string.IsNullOrWhiteSpace(GetAppSetting("ApiBaseUrl")))
      throw new InvalidOperationException("缺少必需配置:ApiBaseUrl");
  • 不要用 ?? "" 掩盖缺失问题,尤其在连接字符串或路径类配置上

App.config 和 Web.config 的读取行为其实不完全等价

虽然都用 ConfigurationManager,但运行时加载逻辑不同:

  • App.config 编译后自动重命名为 [AppName].exe.config,并放在输出目录;读取时依赖可执行文件名匹配
  • Web.config 由 IIS/ASP.NET 运行时自动加载,支持多层继承(根目录、子目录均可有 web.config),子目录的会合并/覆盖上级配置

容易忽略的细节:

  • 在 Web 项目中,ConfigurationManager.AppSettings 读的是当前请求上下文对应的 web.config,不是物理路径上的某个文件
  • 如果你把 App.config 复制到 Web 项目里并试图用 ConfigurationManager 读它,不会生效 —— 它被忽略
  • Web.config 中的 和 可以用同样 API 读,但其他节(如 )不能用 GetSection 直接拿,得走专门 API

真正麻烦的地方不在怎么写代码,而在于:

  • 没人告诉你 App.config 文件属性里的 Copy to Output Directory 必须设为 Copy always 或 Copy if newer
  • 也没人提醒你,发布 Web 项目时,web.config 的 transform(如 Web.Release.config)是否真起了作用,得看生成后的实际文件内容
  • 更隐蔽的是:某些部署环境(如 IIS 的某些托管管道模式)会缓存配置,改了 web.config 不重启 AppPool 就不生效

这些不是“高级技巧”,是每天都会卡住人的基础事实。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

配置文件 c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3489

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2408

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1340

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1278

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1396

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2298

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3760

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

17575

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Golangci-lint官方文档
Golangci-lint官方文档

共0课时 | 0人学习

Conan 参考手册
Conan 参考手册

共0课时 | 0人学习

Jupyter Notebook官方文档
Jupyter Notebook官方文档

共0课时 | 0人学习