.NET 5 Web应用Azure App Config动态配置刷新不生效

根因说明 #

• 动态配置不生效核心问题：仅配置缓存过期时间未完成刷新规则注册、中间件注册顺序错误。Azure App Configuration的动态刷新需要显式指定要监听的配置键，且依赖请求管道中的中间件触发配置拉取逻辑，缺失任意环节都只能在应用启动时读取一次配置。
• ViewData读取BackgroundColor失效问题：强类型配置绑定属性名不匹配、Controller向ViewData赋值时键名/属性名拼写错误。直接读取IConfiguration时是逐段匹配键名，大小写不敏感且不依赖强类型绑定，所以能正常读到值。
• 修改路由抛异常问题：控制器默认路由与Razor Pages路由注册冲突，重复注册同模板路由导致运行时路由匹配失败。

修复步骤 #

1. 补全Program.cs中的刷新规则配置 #

仅设置CacheExpiration不会自动触发配置拉取，必须通过ConfigureRefresh注册监听键，参考代码：

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.ConfigureAppConfiguration((hostingContext, config) =>
            {
                var tempConfig = config.Build();
                config.AddAzureAppConfiguration(options =>
                {
                    options.Connect(tempConfig.GetConnectionString("AppConfig"))
                        .ConfigureRefresh(refreshOptions =>
                        {
                            // 监听Sentinel键，该键变更时触发全量配置刷新，减少对配置存储的轮询请求
                            refreshOptions.Register(key: "Sentinel", refreshAll: true)
                                .SetCacheExpiration(TimeSpan.FromSeconds(10));
                        });
                });
            });
            webBuilder.UseStartup<Startup>();
        });

如果不使用Sentinel键，也可以逐个注册需要监听的业务配置键，例如refreshOptions.Register("TestApp:Settings:BackgroundColor")，但这种方式会增加配置存储的请求次数，生产环境优先使用Sentinel键方案。

2. 修正Startup.cs中间件顺序与路由配置 #

UseAzureAppConfiguration必须放在请求处理类中间件之前，否则无法在每个请求进入时触发配置刷新检查，同时调整路由配置避免冲突：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        app.UseExceptionHandler("/Home/Error");
        app.UseHsts();
    }

    app.UseHttpsRedirection();
    app.UseStaticFiles();
    // Azure App Configuration中间件必须放在UseRouting、UseEndpoints之前
    app.UseAzureAppConfiguration();

    app.UseRouting();
    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        // 仅保留需要的路由配置，不需要Razor Pages就注释掉对应映射，避免路由冲突
        endpoints.MapControllerRoute(
            name: "default",
            pattern: "{controller=Home}/{action=Index}/{id?}");
        // endpoints.MapRazorPages(); // 不需要Razor Pages时注释本行即可解决路由抛异常问题
    });
}

3. 修复强类型绑定与ViewData传值问题 #

首先确认Settings强类型类的属性名与配置键后缀完全匹配，例如配置键TestApp:Settings:BackgroundColor对应Settings类中必须存在名为BackgroundColor的公共可读可写属性。
然后修正Controller中的赋值逻辑，确保属性名、ViewData键名与视图中读取的键名完全一致：

public class HomeController : Controller
{
    private readonly Settings _appSettings;
    // 通过IOptionsSnapshot注入配置，每次请求都会拿到最新的配置值
    public HomeController(IOptionsSnapshot<Settings> settings)
    {
        _appSettings = settings.Value;
    }

    public IActionResult Index()
    {
        // 赋值时注意拼写，ViewData键名和视图中读取的名称保持一致
        ViewData["BackgroundColor"] = _appSettings.BackgroundColor;
        ViewData["FontSize"] = _appSettings.FontSize;
        ViewData["FontColor"] = _appSettings.FontColor;
        ViewData["Message"] = _appSettings.Message;
        return View();
    }
}

验证方法 #

1. 重启应用，确认页面初始加载时所有配置值（包括BackgroundColor）都能通过ViewData正常渲染
2. 进入Azure App Configuration控制台，修改目标配置值（例如将BackgroundColor修改为#f0f0f0），随后将Sentinel键的值加1（从1改为2即可）
3. 等待10秒以上刷新页面，无需重启应用即可看到配置变更生效

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