.Net Framework 4.7.1 MVC项目如何让Azure App Configuration在启动阶段生效

问题根因 #

.NET Framework 配置系统的默认加载逻辑中，web.config中注册的ConfigurationBuilders会在应用初始化完成后才生效填充AppSettings集合，因此在Startup.cs、Global.asax启动阶段、DI容器构建阶段直接调用ConfigurationManager.AppSettings无法获取到Azure存储的配置值。

具体解决步骤 #

1. 基础环境与配置校验 #

首先保证项目目标框架为 .NET Framework 4.7.1及以上，这是官方ConfigurationBuilders的最低支持版本。
然后修正web.config配置，确保appSettings节点绑定了你注册的配置构建器：

<configuration>
  <configBuilders>
    <builders>
      <!-- 你已注册的配置构建器，连接字符串可以引用本地配置避免硬编码 -->
      <add name="MyConfigStore" mode="Greedy" connectionString="${appSettings:AzureConfigConnString}" type="Microsoft.Configuration.ConfigurationBuilders.AzureAppConfigurationBuilder, Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration" />
    </builders>
  </configBuilders>
  <!-- 核心：给appSettings节点指定configBuilders属性，漏加会导致配置构建器不生效 -->
  <appSettings configBuilders="MyConfigStore">
    <add key="AzureConfigConnString" value="你的Azure App Configuration连接字符串" />
    <!-- 其他本地配置项 -->
  </appSettings>
  <!-- 其他配置节点 -->
</configuration>

mode="Greedy" 配置会在配置加载时就拉取所有Azure配置，而非按需读取，符合启动阶段就要获取所有配置的需求。

2. 提前触发配置构建（推荐方案） #

使用.NET Framework的预应用启动特性，在应用所有初始化逻辑执行前就触发配置构建，填充AppSettings集合：

1. 新增启动引导类：

using System.Configuration;

public static class AzureConfigBootstrapper
{
    public static void Init()
    {
        // 手动刷新appSettings节点，触发配置构建器执行
        ConfigurationManager.RefreshSection("appSettings");
    }
}

2. 在项目Properties/AssemblyInfo.cs中添加预启动特性，指定启动时先执行上面的Init方法：

[assembly: System.Web.PreApplicationStartMethod(typeof(AzureConfigBootstrapper), nameof(AzureConfigBootstrapper.Init))]

3. 兼容兜底方案 #

如果上述方案仍不满足需求，你已经可以通过IConfigurationRoot显式读取到Azure配置，直接批量同步到ConfigurationManager.AppSettings即可，完全兼容原有代码：

IConfigurationRoot configuration = new ConfigurationBuilder()
    .AddAzureAppConfiguration(options =>
    {
        options.Connect(ConfigurationManager.AppSettings["AzureConfigConnString"])
            .UseFeatureFlags();
    }).Build();

// 同步所有Azure配置到AppSettings
foreach (var kvp in configuration.AsEnumerable())
{
    if (!string.IsNullOrWhiteSpace(kvp.Value))
    {
        // 已有配置项会覆盖，无配置项会新增
        ConfigurationManager.AppSettings[kvp.Key] = kvp.Value;
    }
}

// 之后所有调用ConfigurationManager.AppSettings的代码都可以正常读取Azure配置
var someValue = ConfigurationManager.AppSettings["key"];

将这段逻辑放在Global.asax的Application_Start方法最开头执行即可。

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