ASP.NET读取配置文件多种方式详解 一文搞定所有使用场景

这篇文章把ASP.NET读取配置文件的全场景方案一次性讲透：从.NET Framework的ConfigurationManager、WebConfigurationManager，到.NET Core/.NET 5+的IConfiguration、IOptions模式，再到自定义配置源（如JSON、XML、数据库）的实现，每种方法的具体步骤“适用场景”“避坑细节”都掰碎了说。不管你是新手学基础用法，还是老鸟解决复杂需求（比如嵌套配置、动态刷新、多环境切换），都能在这里找到直接能用的答案——不用再东拼西凑查资料，一篇文章覆盖配置读取的所有常见场景。

配置读取是ASP.NET开发的“基础但关键”技能，这篇文章帮你把这个技能补扎实，从此不再为“读配置”发愁。

做ASP.NET开发的朋友，肯定都遇到过配置读取的“糟心时刻”——比如Framework项目里web.config的appSettings明明写了值，用ConfigurationManager读出来却是null；或者Core项目里改了appsettings.json，重启项目才生效；再或者需要从数据库读配置，不知道怎么集成进去。这些问题我之前全踩过，有的是因为没搞懂不同框架的机制，有的是没找对方法。今天这篇文章，把ASP.NET从Framework到Core的所有常用读取方式，还有进阶场景的解决办法，全给你讲透，看完你再遇到配置问题，直接按文章里的方法套就行。

从Framework到Core，最常用的基础读取方式

先说说.NET Framework，这应该是很多老项目还在用水的框架。Framework的配置文件是web.config，里面最常用的就是appSettings和connectionStrings节点。比如你要存一个API密钥，就在appSettings里写，然后用ConfigurationManager.AppSettings["ApiKey"]就能读出来；要是存数据库连接字符串，就写在connectionStrings里，比如，然后用ConfigurationManager.ConnectionStrings["DefaultConnection"].ConnectionString读取。

我去年帮一个做电商的朋友调项目，他的项目是Framework 4.7.2，用ConfigurationManager读不到connectionStrings，我看了下他的配置文件，发现connectionStrings节点写在了appSettings里面——这就错了！connectionStrings是独立的节点，得跟appSettings同级。还有一次，他没引用System.Configuration这个NuGet包，结果编译报错“找不到ConfigurationManager类”，后来加上包就好了。其实Framework的ConfigurationManager原理很简单：它依赖于System.Configuration.dll，这个dll会读取web.config的配置并缓存，所以第一次读之后，后面再读都是缓存内容，除非重启应用。

再说说.NET Core/.NET 5+，这两年新项目基本都用这个框架了。Core的配置文件是appsettings.json，比web.config更灵活，支持嵌套结构——比如你可以写{"JwtSettings":{"SecretKey":"xxx","ExpireHours":2}}这样的多层配置。Core用IConfiguration接口读取配置，不用自己实例化，直接在Program.cs里通过WebApplication.CreateBuilder(args)获取（builder.Configuration就是IConfiguration的实例）。

读取嵌套配置的话，用冒号分隔键就行，比如builder.Configuration["JwtSettings:SecretKey"]能读到SecretKey的值；要是想把配置绑定到实体类更方便——比如定义一个JwtSettings类（有SecretKey和ExpireHours属性），然后用builder.Configuration.GetSection("JwtSettings").Bind(jwtSettings)，或者更简洁的builder.Configuration.GetSection("JwtSettings").Get()。我上个月帮同事做Core项目，他想把appsettings.json里的“JwtSettings”绑定到实体类，结果绑不上——后来发现他的实体类属性名和配置文件键不一致（配置文件是“SecretKey”，实体类是“Secret”），改一致就好了。

还有个关键知识点：Core的配置是按顺序加载的——builder.Configuration会先加载appsettings.json，再加载appsettings.Development.json（开发环境），最后加载环境变量和命令行参数，后面的配置会覆盖前面的。比如开发环境下，appsettings.Development.json里的JwtSettings:ExpireHours会覆盖appsettings.json里的相同键，这就是Core配置灵活的原因。

为了让你更清楚两者的区别，我做了个对比表：

进阶场景：自定义配置与动态刷新，解决90%的复杂需求

基础方式会了，接下来讲进阶场景——比如从数据库读配置、改配置不用重启，这些问题怎么解决？

自定义配置源：想读什么就读什么，数据库/XML/Redis都行

默认配置文件满足不了所有需求——比如有些项目的配置需要存数据库（方便后台管理），或者从Redis读（提高性能）。这时候需要自定义配置源，核心是实现IConfigurationSource和IConfigurationProvider接口。

比如我去年做SAAS项目，每个租户有自己的配置，需要从数据库读，我写了个DbConfigurationSource：

public class DbConfigurationSource IConfigurationSource
{
 public IConfigurationProvider Build(IConfigurationBuilder builder)
 {
 return new DbConfigurationProvider(); // 返回自定义Provider
 }
}
public class DbConfigurationProvider ConfigurationProvider
{
 public override void Load()
 {
 // 从数据库读配置，存到Data字典（ConfigurationProvider的核心属性）
 using (var db = new TenantDbContext())
 {
 Data = db.TenantConfigurations
 .Where(c => c.TenantId == CurrentTenant.Id)
 .ToDictionary(c => c.Key, c => c.Value);
 }
 }
}

然后在Program.cs里加builder.Configuration.Add(new DbConfigurationSource())，这样IConfiguration就能读到数据库里的配置了。要是想读XML文件更简单，直接用builder.Configuration.AddXmlFile("config.xml")，跟加JSON文件一样。

自定义配置源的原理其实很直白：ConfigurationBuilder会加载所有IConfigurationSource，每个Source对应一个IConfigurationProvider，Provider负责从数据源（数据库/XML/Redis）读取配置，并存到Data字典里，IConfiguration就是从这些Data字典里取数据的。

动态刷新：改了配置不用重启，生产环境超实用

你有没有遇到过？生产环境改了配置，得重启项目才能生效——要是项目是集群部署，重启一次要几分钟，影响用户体验。这时候动态刷新就派上用场了。

ASP.NET Core里有三种Options模式，我给你掰扯清楚：

我上次帮朋友做生产项目，他需要改appsettings.json里的缓存时间，不用重启项目。我告诉他两步：

他试了之后说：“之前重启项目要等5分钟，现在直接改配置就行，太方便了！”其实动态刷新的原理是IChangeToken：当配置文件变化时，ChangeToken触发通知，IOptionsMonitor监听这个通知，然后重新加载配置。而IOptionsSnapshot是每次请求创建新实例，所以每次请求重新读配置，但不会实时监听文件变化。

微软官方文档明确说，IOptionsMonitor是处理动态配置的推荐方式（链接：微软Options模式文档）。要是你用了动态刷新，一定要测试——改一下appsettings.json里的某个值，然后在接口里打印配置，看是不是立即变化了；要是没变化，检查是不是加了reloadOnChange: true，或者用错了Options类型。

你最近在配置读取上遇到过什么坑？比如自定义配置源没读到数据，或者动态刷新不生效？欢迎在评论区留言，我帮你分析分析！

.NET Framework项目里用ConfigurationManager读不到appSettings的值，可能是哪里错了？

先别急，常见问题就那几个原因。首先看web.config里的appSettings节点是不是独立的——别把它嵌套在其他节点（比如system.web）里面，得跟connectionStrings同级才行；然后检查项目有没有引用System.Configuration这个NuGet包，没引用的话肯定找不到ConfigurationManager类；还有个容易忘的点，确认web.config的“生成操作”是不是设为了“内容”，不然发布的时候配置文件没被复制到输出目录，读出来肯定是null。我去年帮朋友调过类似问题，他就是把appSettings写进了system.web里，改回独立节点就好了。

如果是嵌套在子目录的配置文件（比如configs/app.config），得用ConfigurationManager.OpenMappedExeConfiguration指定路径，但大部分情况直接用根目录的web.config就行。

.NET Core里appsettings.json有嵌套配置，比如{“JwtSettings”:{“SecretKey”:”xxx”}}，怎么读出来？

Core里读嵌套配置很灵活，两种方法随便选。第一种用IConfiguration的冒号分隔键——比如要读SecretKey，直接写configuration["JwtSettings:SecretKey"]（注意是英文冒号）；第二种更方便，定义一个和配置结构对应的实体类（比如叫JwtSettings，里面有SecretKey和ExpireHours属性），然后用configuration.GetSection("JwtSettings").Get()，就能把嵌套配置直接绑定成实体对象，用的时候直接点属性就行。

我之前帮同事踩过坑：他的实体类属性名是“Secret”，但配置文件里写的是“SecretKey”，结果绑出来都是null，后来把属性名改成和配置键一致就好了——这步千万别粗心！

想从数据库读配置，ASP.NET Core里怎么实现？

需要写个“自定义配置源”，其实就是两步：先实现IConfigurationSource（负责返回配置提供者），再实现IConfigurationProvider（负责从数据库读数据）。比如Provider里的Load方法，你可以用EF Core或者Dapper查数据库里的配置表，把键值对存到Provider的Data字典里（Data是ConfigurationProvider的核心属性，IConfiguration就是从这里取数据的）。

然后在Program.cs里把这个配置源加进去——比如builder.Configuration.Add(new DbConfigurationSource())，这样IConfiguration就能读到数据库里的配置了。我去年做SAAS项目的时候，每个租户的配置都存在数据库里，就是这么搞的，后台改配置直接生效，不用动配置文件。

生产环境改了appsettings.json不想重启项目，Core里有办法吗？

当然有，这招我在生产环境用了好多次。首先得开启配置文件的自动刷新——在Program.cs里加JSON文件的时候，把reloadOnChange设为true，比如builder.Configuration.AddJsonFile("appsettings.json", reloadOnChange: true)；然后用IOptionsMonitor代替IOptions来读配置——比如注入IOptionsMonitor，用monitor.CurrentValue就能拿到最新的配置，改了appsettings.json不用重启项目，实时生效。

要是你用的是自定义配置源（比如数据库），还得让Provider支持“变化监听”——比如数据库里配置改了，触发Provider重新执行Load方法，这样IOptionsMonitor也能拿到最新值。对了，IOptionsSnapshot也能刷新，但它是“每次请求刷新”，适合多租户场景；IOptionsMonitor是“实时监听变化”，生产环境更常用。

ASP.NET Core里的IOptions、IOptionsSnapshot、IOptionsMonitor有什么区别？

这三个都是用来处理配置的，但适用场景完全不一样。IOptions是单例模式，第一次加载配置后就再也不刷新了——适合那些永远不会变的配置，比如JWT的SecretKey；IOptionsSnapshot是“作用域级别”，每次请求都会重新读配置——适合多租户场景，比如每个租户的数据库连接字符串不一样，每次请求对应不同租户，就能读不同的配置；IOptionsMonitor是单例，但能实时监听配置变化——改了appsettings.json不用重启项目，生产环境想动态更新配置就用它。

我之前做项目的时候，一开始用IOptions存缓存时间，结果改了配置没反应，换成IOptionsMonitor加上reloadOnChange: true，立马就生效了——记着，要动态刷新就得用这俩组合！

YUANLEISVIP

收藏 链接