.NET Framework 4.8类库读取Azure App Service未定义配置项问题

问题本质 #

.NET Framework的ConfigurationManager.AppSettings默认依赖当前应用程序域的配置文件（主项目的web.config），Azure App Service的应用设置仅会覆盖web.config中已存在的键值对，不会自动向AppSettings集合中添加新的未定义项。这就是类库直接读取未在web.config中定义的配置项返回null的原因。

可行解决办法 #

1. 直接读取Azure App Service对应的环境变量 #

Azure App Service会将所有应用设置转换为前缀为APPSETTING_的环境变量（例如配置项MyCustomKey对应环境变量APPSETTING_MyCustomKey）。类库中可以直接通过环境变量读取，无需依赖web.config：

var settingValue = Environment.GetEnvironmentVariable("APPSETTING_MyCustomKey");

• 优点：完全符合需求，本地开发无环境变量时返回null，Azure环境下自动读取配置值；无需修改web.config；类库无需额外依赖。
• 缺点：需要记住环境变量的命名规则（前缀+原键名），如果配置项名称有特殊字符，Azure会自动转换（比如冒号换成下划线）。

2. 在web.config中添加空值配置项（妥协方案） #

如果更倾向于继续使用ConfigurationManager.AppSettings，可以在主项目的web.config中添加空值的目标配置项：

<appSettings>
  <!-- 其他配置项 -->
  <add key="MyCustomKey" value="" />
</appSettings>

这样本地开发时读取到空值（等同于null的业务逻辑），发布到Azure App Service后，平台会用配置中心的对应值覆盖这个空值，类库通过ConfigurationManager.AppSettings["MyCustomKey"]就能读到正确的值。

• 优点：无需修改类库的读取逻辑，延续原有代码习惯。
• 缺点：需要在web.config中添加占位项，不符合“不想在web.config定义变量”的初始要求，但属于最小侵入的妥协方案。

3. 加载主项目的Web配置文件 #

如果类库可以引用System.Web程序集，可以通过WebConfigurationManager加载主项目的web配置，直接读取最新的配置（包括Azure覆盖后的值）：

using System.Web.Configuration;

var config = WebConfigurationManager.OpenWebConfiguration("~");
var settingValue = config.AppSettings.Settings["MyCustomKey"]?.Value;

• 优点：可以直接使用配置项原名读取，无需关心环境变量转换。
• 缺点：类库需要依赖System.Web，仅适用于Web应用场景；需要确保应用程序域上下文正确（Azure App Service环境下正常）。

内容的提问来源于stack exchange，提问作者John