在 ASP.NET Core 中使用 reloadOnChange 重新加载选项

Question

在我的 ASP.NET Core 应用程序中，我将 appsettings.json 绑定到强类型类AppSettings。

public Startup(IHostingEnvironment environment)
{
    var builder = new ConfigurationBuilder()
        .SetBasePath(environment.ContentRootPath)
        .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
        .AddJsonFile($"appsettings.{environment.EnvironmentName}.json", optional: true, reloadOnChange: true)
        .AddEnvironmentVariables();

    Configuration = builder.Build();
}

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<AppSettings>(Configuration);
    //...
}

在单例类中，我像这样包装这个 AppSettings 类：

public class AppSettingsWrapper : IAppSettingsWrapper
{
    private readonly IOptions<AppSettings> _options;

    public AppSettingsAdapter(IOptions<AppSettings> options)
    {
        _options = options ?? throw new ArgumentNullException("Options cannot be null");
    }

    public SomeObject SomeConvenienceGetter()
    {
        //...
    }
}

现在，如果 json 文件发生更改，我正在努力重新加载 AppSettings。我在某处读到IOptionsMonitor类可以检测更改，但在我的情况下不起作用。

为了测试目的，我尝试像这样调用OnChange事件：

public void Configure(IApplicationBuilder applicationBuilder, IOptionsMonitor<AppSettings> optionsMonitor)
{
    applicationBuilder.UseStaticFiles();
    applicationBuilder.UseMvc();

    optionsMonitor.OnChange<AppSettings>(vals => 
    {
        System.Diagnostics.Debug.WriteLine(vals);
    });
}

当我更改 json 文件时，永远不会触发该事件。有人知道我可以更改什么以使重新加载机制在我的场景中工作吗？

Answer 1

您可以做的是像在AppSettingsWrapper 中所做的那样围绕配置类创建包装类并注入 IOptionsMonitor。然后保留设置类的私有属性。该包装器可以作为单例注入，并且 IOptionsMonitor 将跟踪您的更改。

public class AppSettingsWrapper
{
    private AppSettings _settings;

    public AppSettingsWrapper(IOptionsMonitor<AppSettings> settings)
    {
        _settings = settings.CurrentValue;

        // Hook in on the OnChange event of the monitor
        settings.OnChange(Listener);
    }

    private void Listener(AppSettings settings)
    {
        _settings = settings;
    }

    // Example getter
    public string ExampleOtherApiUrl => _settings.ExampleOtherApiUrl;
}

然后将您的包装类注册为单例

services.AddSingleton(sp => new AppSettingsWrapper(sp.GetService<IOptionsMonitor<AppSettings>>()));

Answer 2

您需要注入IOptionsSnapshot<AppSettings>才能使重新加载工作。

不幸的是，您无法将其加载IOptionsSnapshot到 Singleton 服务中。IOptionsSnapshot是 Scoped 服务，因此您只能在 Scoped 或 Transient 注册类中引用它。

但是，仔细想想，这是有道理的。设置更改时需要重新加载，因此如果将它们注入单例，则该类将永远不会获得更新的设置，因为不会再次为单例调用构造函数。