注册StackExchangeRedisCache中间件后如何动态修改RedisCacheOptions配置

默认的AddStackExchangeRedisCache注册的IDistributedCache是单例生命周期，构造时读取一次配置后就不会再更新，要实现配置热更新可以按以下步骤操作：

1. 封装动态Redis缓存提供者 #

首先定义一个包装类，持有可更新的StackExchangeRedisCache实例，同时实现IDistributedCache接口，保证和原有缓存代码的兼容性：

public class DynamicRedisCache : IDistributedCache
{
    private volatile StackExchangeRedisCache _innerCache;
    private readonly object _lockObj = new();
    private readonly ConfigurationService _configService;
    private RedisConfig _currentConfig;

    public DynamicRedisCache(ConfigurationService configService)
    {
        _configService = configService;
        // 初始化首次实例
        _currentConfig = configService.GetRedisConfig();
        _innerCache = CreateNewCache(_currentConfig);
        
        // 监听配置变更事件（需要你在ConfigurationService中实现该事件）
        configService.RedisConfigChanged += OnRedisConfigChanged;
    }

    private StackExchangeRedisCache CreateNewCache(RedisConfig config)
    {
        var options = new RedisCacheOptions
        {
            Configuration = config.ConnectionString,
            InstanceName = config.InstanceName
            // 其他你需要的配置项
        };
        return new StackExchangeRedisCache(options);
    }

    private void OnRedisConfigChanged(object sender, RedisConfig newConfig)
    {
        // 配置无变化直接跳过
        if (_currentConfig.Equals(newConfig)) return;
        
        // 加锁保证线程安全，避免并发替换实例
        lock (_lockObj)
        {
            // 销毁旧实例的连接
            (_innerCache as IDisposable)?.Dispose();
            // 创建新的缓存实例
            _innerCache = CreateNewCache(newConfig);
            _currentConfig = newConfig;
        }
    }

    // 实现IDistributedCache的所有方法，全部转发到_innerCache
    public byte[] Get(string key) => _innerCache.Get(key);
    public Task<byte[]> GetAsync(string key, CancellationToken token = default) => _innerCache.GetAsync(key, token);
    public void Set(string key, byte[] value, DistributedCacheEntryOptions options) => _innerCache.Set(key, value, options);
    public Task SetAsync(string key, byte[] value, DistributedCacheEntryOptions options, CancellationToken token = default) => _innerCache.SetAsync(key, value, options, token);
    public void Refresh(string key) => _innerCache.Refresh(key);
    public Task RefreshAsync(string key, CancellationToken token = default) => _innerCache.RefreshAsync(key, token);
    public void Remove(string key) => _innerCache.Remove(key);
    public Task RemoveAsync(string key, CancellationToken token = default) => _innerCache.RemoveAsync(key, token);

    // 实例销毁时释放资源
    public void Dispose()
    {
        (_innerCache as IDisposable)?.Dispose();
    }
}

以上代码中的RedisConfig是你自定义的Redis配置实体类，RedisConfigChanged是需要在ConfigurationService中实现的事件，当你检测到Redis配置更新时触发该事件即可。

可选优化：无事件时的定时检测 #

如果你的ConfigurationService没有提供配置变更通知事件，可以在DynamicRedisCache的构造函数中启动一个后台定时任务，定期拉取最新配置和当前使用的配置对比，有差异就触发替换逻辑即可。

2. 替换原有服务注册 #

修改Program.cs/Startup.cs里的服务注册代码，注释掉原来的AddStackExchangeRedisCache，改为注册我们自己的DynamicRedisCache：

// 注释掉原来的注册逻辑
// services.AddStackExchangeRedisCache(options => { ... });

// 先确认ConfigurationService已经注册到DI容器
services.AddSingleton<ConfigurationService>();
// 注册动态缓存，替换原有IDistributedCache实现
services.AddSingleton<IDistributedCache, DynamicRedisCache>();

3. 注意事项 #

• 配置切换的瞬间，正在处理的请求可能会用到旧的连接实例，加锁可以保证实例替换的原子性，不会出现半初始化的问题
• 旧实例销毁时会自动释放持有的Redis连接，不会出现连接泄漏
• 原有调用IDistributedCache的业务代码完全不需要修改，对上层业务无感知

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