.NET6后台Worker中IOptionsSnapshot/IOptionsMonitor配置不更新问题

核心问题梳理 #

你的代码存在四个关键问题导致配置更新不生效：

1. 重复加载配置文件：Program.cs中两次添加了同一个AppSettingsFileLocation配置文件，且手动调用Build()干扰了宿主的配置生命周期管理
2. 相对路径失效：使用../../形式的相对路径，Worker Service运行时工作目录可能与开发环境不一致，导致文件变更监听失败
3. Scoped服务长期存活：Worker创建一次Scope后就进入无限循环，Scoped实例长期存在，IOptionsSnapshot无法通过Scope重建获取新配置；IOptionsMonitor的变更回调虽能触发，但存在线程安全隐患
4. 线程安全问题：Configuration字段在变更回调中被修改，while循环读取时未做线程同步，可能获取到不一致的值

1. 修复Program.cs配置加载逻辑 #

移除重复配置项，基于宿主内容根目录构造绝对路径，删除多余的手动Build操作：

var builder = Host.CreateDefaultBuilder();

// Config
builder.ConfigureAppConfiguration((hostBuilderContext, configurationBuilder) =>
{
    var env = hostBuilderContext.HostingEnvironment;
    var contentRoot = env.ContentRootPath;

    configurationBuilder
        .AddJsonFile(
            Path.Combine(contentRoot, ConfigurationConstants.AppSettingsFileLocation),
            optional: false,
            reloadOnChange: true
        )
        .AddJsonFile(
            Path.Combine(contentRoot, "Configuration", "environments", $"environment.{env.EnvironmentName}.json"),
            optional: false,
            reloadOnChange: true
        );
});

// Services
builder.ConfigureServices((hostBuilderContext, services) =>
{
    services.AddHostedService<Worker>();
    services.AddScoped<MessageRouterProcess>();
    services.AddTransient<IQueueManager, RabbitMQQueueManagerAdapter>();

    services.Configure<WorkerConfiguration>(hostBuilderContext.Configuration.GetSection(nameof(WorkerConfiguration)));
});

var host = builder.Build();
await host.RunAsync();

2. 重构Worker的Scope生命周期 #

让Worker定期重建Scope，确保Scoped服务能获取最新配置，同时避免实例长期存活：

namespace Meloons.Whatsapp.Worker.MessageRouter
{
    public class Worker : BackgroundService
    {
        private readonly ILogger<Worker> _logger;
        private readonly IServiceProvider _services;

        public Worker(IServiceProvider services, ILogger<Worker> logger)
        {
            _services = services;
            _logger = logger;
        }

        protected override async Task ExecuteAsync(CancellationToken stoppingToken)
        {
            _logger.LogInformation("Consume Scoped Service Hosted Service running.");

            while (!stoppingToken.IsCancellationRequested)
            {
                await DoWork(stoppingToken);
                // 可根据业务调整延迟时间
                await Task.Delay(100, stoppingToken);
            }
        }

        private async Task DoWork(CancellationToken stoppingToken)
        {
            _logger.LogInformation("Consume Scoped Service Hosted Service is working.");

            using (var scope = _services.CreateScope())
            {
                var scopedProcessingService = scope.ServiceProvider.GetRequiredService<MessageRouterProcess>();
                // 改为单次批处理，由Worker控制循环逻辑
                await scopedProcessingService.ProcessSingleBatch(stoppingToken);
            }
        }
    }
}

3. 优化MessageRouterProcess的配置获取 #

提供两种可选方案，按需选择：

方案一：使用IOptionsMonitor并保证线程安全

适合需要实时监听配置变更且不想频繁重建Scope的场景：

namespace Meloons.Whatsapp.WebAPI.Core
{
    public class MessageRouterProcess
    {
        private readonly IOptionsMonitor<WorkerConfiguration> _configMonitor;
        private readonly IQueueManager _queueManager;
        private readonly HttpClient _httpClient;
        // 用volatile确保配置变更对所有线程可见
        private volatile WorkerConfiguration _currentConfig;

        public MessageRouterProcess(
            IQueueManager queueManager,
            IOptionsMonitor<WorkerConfiguration> configMonitor
        )
        {
            _queueManager = queueManager;
            _configMonitor = configMonitor;
            _currentConfig = configMonitor.CurrentValue;
            // 监听配置变更
            configMonitor.OnChange(updatedConfig => 
            {
                _currentConfig = updatedConfig;
            });
            _httpClient = new HttpClient();
        }

        public async Task ProcessSingleBatch(CancellationToken stoppingToken)
        {
            var config = _currentConfig;
            if (!config.Lecture)
            {
                await Task.Delay(1000, stoppingToken);
                return;
            }

            var messageAmountToConsume = config.TPS;
            var now = DateTime.UtcNow;

            List<Message> messages = await _queueManager.FetchItem<Message>(messageAmountToConsume, stoppingToken);
            _queueManager.Publish(messages, config.OutboundQueue);

            var timeGap = (int)(DateTime.UtcNow - now).TotalMilliseconds;
            if (1000 - timeGap > 0)
                await Task.Delay(1000 - timeGap, stoppingToken);
        }
    }
}

方案二：使用IOptionsSnapshot（配合Worker重建Scope）

适合配置变更频率不高，希望通过Scope生命周期自动获取最新配置的场景：

namespace Meloons.Whatsapp.WebAPI.Core
{
    public class MessageRouterProcess
    {
        private readonly WorkerConfiguration _configuration;
        private readonly IQueueManager _queueManager;
        private readonly HttpClient _httpClient;

        public MessageRouterProcess(
            IQueueManager queueManager,
            IOptionsSnapshot<WorkerConfiguration> configuration
        )
        {
            _queueManager = queueManager;
            // 每次Scope重建时自动获取最新配置
            _configuration = configuration.Value;
            _httpClient = new HttpClient();
        }

        public async Task ProcessSingleBatch(CancellationToken stoppingToken)
        {
            if (!_configuration.Lecture)
            {
                await Task.Delay(1000, stoppingToken);
                return;
            }

            var messageAmountToConsume = _configuration.TPS;
            var now = DateTime.UtcNow;

            List<Message> messages = await _queueManager.FetchItem<Message>(messageAmountToConsume, stoppingToken);
            _queueManager.Publish(messages, _configuration.OutboundQueue);

            var timeGap = (int)(DateTime.UtcNow - now).TotalMilliseconds;
            if (1000 - timeGap > 0)
                await Task.Delay(1000 - timeGap, stoppingToken);
        }
    }
}

4. 验证配置文件路径 #

• 开发环境：在Visual Studio项目属性→调试→工作目录中设置为项目根目录
• 生产环境：确保发布后的配置文件目录结构与代码中构造的路径一致，或直接使用绝对路径

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