ASP.NET Core中IOptionsMonitor监听配置变更触发所有事件问题

基于.NET 6.0的ASP.NET Core MVC Web应用，尝试通过IOptionsMonitor监听appsettings.json的配置变更，具体实现如下：

appsettings.json 内容 #

{
  "Example1": {
    "param1": "sample1",
    "param2": "sample2"
  },

  "Example2": {
    "param3": "sample3",
    "param4": "sample4"
  }
}

配置映射POCO类 #

public class Example1
{
    public string param1 { get; set; }
    public string param2 { get; set; }
}

public class Example2
{
    public string param3 { get; set; }
    public string param4 { get; set; }
}

配置注册（Program.cs） #

public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);
    // 其他配置...
    builder.Services.Configure<Example1>(builder.Configuration.GetSection("Example1"));
    builder.Services.Configure<Example2>(builder.Configuration.GetSection("Example2")); 
    // 其他配置...
}

控制器中监听变更 #

public class HomeController : Controller
{
    private IDisposable _example1listener;
    private IDisposable _example2listener;

    public HomeController(IOptionsMonitor<Example1> example1, IOptionsMonitor<Example2> example2)
    {
        _example1listener = example1.OnChange(ChangeExample1Listener);
        _example2listener = example2.OnChange(ChangeExample2Listener);
    }

    private void ChangeExample1Listener(Example1 example)
    {
        Console.Write("Changed Example 1");
    }

    private void ChangeExample2Listener(Example2 example)
    {
        Console.Write("Changed Example 2");
    }

    ~HomeController()
    {
        _example1listener?.Dispose();
        _example2listener?.Dispose();
    }
}

实际运行时，修改Example1或Example2任意一段配置，两个监听器都会被触发，疑问：这是预期行为吗？还是操作有误？若为预期行为，如何判断指定配置段是否真变更？

1. 这是预期行为 #

ASP.NET Core的配置系统默认监听整个配置源文件的变更，而非单个配置节点。当你修改appsettings.json的任何内容，整个配置源会被重新加载，所有通过IOptionsMonitor注册的变更回调都会被触发——不管对应的配置Section是否真的发生了变化。

2. 如何判断指定配置段是否真变更 #

要实现只在目标配置Section实际变化时执行逻辑，需要手动对比变更前后的配置值，具体实现如下：

修改HomeController，保存初始配置快照，并在变更回调中对比属性值：

public class HomeController : Controller
{
    private IDisposable _example1listener;
    private IDisposable _example2listener;
    private Example1 _lastExample1;
    private Example2 _lastExample2;

    public HomeController(IOptionsMonitor<Example1> example1, IOptionsMonitor<Example2> example2)
    {
        // 保存初始配置快照
        _lastExample1 = example1.CurrentValue;
        _lastExample2 = example2.CurrentValue;

        _example1listener = example1.OnChange(OnExample1Changed);
        _example2listener = example2.OnChange(OnExample2Changed);
    }

    private void OnExample1Changed(Example1 newConfig)
    {
        // 对比属性值，判断是否真的变更
        if (_lastExample1.param1 != newConfig.param1 || _lastExample1.param2 != newConfig.param2)
        {
            Console.WriteLine("Example1 配置已实际变更");
            // 更新快照
            _lastExample1 = newConfig;
        }
    }

    private void OnExample2Changed(Example2 newConfig)
    {
        if (_lastExample2.param3 != newConfig.param3 || _lastExample2.param4 != newConfig.param4)
        {
            Console.WriteLine("Example2 配置已实际变更");
            _lastExample2 = newConfig;
        }
    }

    protected override void Dispose(bool disposing)
    {
        if (disposing)
        {
            _example1listener?.Dispose();
            _example2listener?.Dispose();
        }
        base.Dispose(disposing);
    }
}

注意：这里重写了Dispose方法替代析构函数，更符合ASP.NET Core控制器的生命周期管理规范（控制器实现了IDisposable接口）。

补充说明 #

如果配置类属性较多，可以使用自定义比较逻辑（如通过反射遍历属性对比）来简化代码，避免逐个属性对比的繁琐。

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