C#与ASP.NET Core中动态按需初始化密钥存储接口方案问询

问题背景 #

现有IKeyVault接口定义了多个密钥属性，AzureKeyVault实现类在Initialize方法中会一次性拉取所有密钥，导致初始化耗时过长（6个密钥约4秒）。但实际业务中并非所有服务都需要全部密钥，且未来可能新增更多密钥，需要优化实现，让调用方仅加载所需密钥，同时保持接口易用性，且不使用异步Getter，在一处完成初始化。

原接口代码：

namespace SampleNamespace.Interfaces 
{
    public interface IKeyVault 
    {
        string string1 { get; }
        string string2 { get; }
        string string3 { get; }
        //... more member variables
        string stringN { get; }

        //initialize the class with the values from the keyvault
        public Task<bool> Initialize();
    }
}

原实现代码：

namespace SampleNamespace.Classes 
{
    public class AzureKeyVault : IKeyVault 
    {
        string string1 { get; private set; }
        string string2 { get; private set; }
        string string3 { get; private set; }
        ...
        string stringN { get; private set; }

        public async Task<bool> Initialize() 
        {
            if (AzureKeyVaultProvider.InitializeClient("somekey")) 
            {
                string1 = await AzureKeyVaultProvider.GetSecret("string1");
                //...more fetches
                stringN = await AzureKeyVaultProvider.GetSecret("stringN");

                return true;
            }

            return false;
        }
    }
}

优化方案 #

方案一：重载Initialize方法，传入所需密钥列表 #

修改接口新增带参数的Initialize重载，让调用方指定需要加载的密钥名称；同时保留无参重载兼容原有逻辑（加载全部密钥）。

1. 更新接口定义

namespace SampleNamespace.Interfaces 
{
    public interface IKeyVault 
    {
        string string1 { get; }
        string string2 { get; }
        string string3 { get; }
        //... more member variables
        string stringN { get; }

        // 兼容原有逻辑：加载全部密钥
        Task<bool> Initialize();
        // 新增：仅加载指定密钥
        Task<bool> Initialize(IEnumerable<string> requiredSecretNames);
    }
}

2. 修改AzureKeyVault实现

通过映射关系关联密钥名称与类属性，初始化时仅处理指定密钥：

namespace SampleNamespace.Classes 
{
    public class AzureKeyVault : IKeyVault 
    {
        public string string1 { get; private set; }
        public string string2 { get; private set; }
        public string string3 { get; private set; }
        //... more member variables
        public string stringN { get; private set; }

        // 建立密钥名称到属性设置器的映射
        private readonly Dictionary<string, Action<string>> _secretSetters = new()
        {
            { "string1", value => string1 = value },
            { "string2", value => string2 = value },
            { "string3", value => string3 = value },
            //... 新增密钥时只需添加对应的映射项
            { "stringN", value => stringN = value }
        };

        public async Task<bool> Initialize()
        {
            // 无参调用时加载全部密钥
            return await Initialize(_secretSetters.Keys);
        }

        public async Task<bool> Initialize(IEnumerable<string> requiredSecretNames)
        {
            if (!AzureKeyVaultProvider.InitializeClient("somekey"))
            {
                return false;
            }

            // 过滤出合法的密钥名称（避免传入不存在的密钥）
            var validSecrets = requiredSecretNames.Intersect(_secretSetters.Keys);

            // 并行获取密钥提升效率
            var secretTasks = validSecrets.Select(async name =>
            {
                var value = await AzureKeyVaultProvider.GetSecret(name);
                _secretSetters[name](value);
            });

            await Task.WhenAll(secretTasks);
            return true;
        }
    }
}

优势

• 兼容原有代码，无参Initialize仍加载全部密钥
• 调用方可按需指定密钥，减少网络请求数量和初始化时间
• 并行获取密钥进一步缩短耗时（原串行6个密钥4秒，并行可大幅降低）
• 新增密钥时只需在映射字典中添加对应项，维护成本低

方案二：按业务领域拆分接口（可选，适合密钥分类明确的场景） #

如果密钥可按业务模块分类，拆分出多个细分接口，让服务只依赖自身需要的接口，实现类按需加载对应密钥。

1. 拆分接口

namespace SampleNamespace.Interfaces 
{
    public interface IAuthKeyVault
    {
        string string1 { get; }
        string string2 { get; }
        Task<bool> Initialize();
    }

    public interface IPaymentKeyVault
    {
        string string3 { get; }
        string string4 { get; }
        Task<bool> Initialize();
    }

    // 保留原接口作为全量密钥的入口
    public interface IKeyVault : IAuthKeyVault, IPaymentKeyVault
    {
        //... 其他密钥属性
        Task<bool> Initialize();
    }
}

2. 修改实现类

namespace SampleNamespace.Classes 
{
    public class AzureKeyVault : IKeyVault 
    {
        public string string1 { get; private set; }
        public string string2 { get; private set; }
        public string string3 { get; private set; }
        public string string4 { get; private set; }
        //... more member variables

        private readonly Dictionary<Type, IEnumerable<string>> _domainSecretMap = new()
        {
            { typeof(IAuthKeyVault), new[] { "string1", "string2" } },
            { typeof(IPaymentKeyVault), new[] { "string3", "string4" } }
        };

        public async Task<bool> Initialize()
        {
            return await Initialize(_domainSecretMap.Values.SelectMany(v => v));
        }

        // 为细分接口提供初始化方法
        public async Task<bool> Initialize<T>() where T : class
        {
            if (_domainSecretMap.TryGetValue(typeof(T), out var secrets))
            {
                return await Initialize(secrets);
            }
            return false;
        }

        private async Task<bool> Initialize(IEnumerable<string> requiredSecretNames)
        {
            if (!AzureKeyVaultProvider.InitializeClient("somekey"))
            {
                return false;
            }

            var secretTasks = requiredSecretNames.Select(async name =>
            {
                // 这里可以复用方案一中的映射逻辑，或者直接赋值
                switch(name)
                {
                    case "string1": string1 = await AzureKeyVaultProvider.GetSecret(name); break;
                    case "string2": string2 = await AzureKeyVaultProvider.GetSecret(name); break;
                    case "string3": string3 = await AzureKeyVaultProvider.GetSecret(name); break;
                    //...
                }
            });

            await Task.WhenAll(secretTasks);
            return true;
        }
    }
}

优势

• 服务依赖更精准，符合接口隔离原则
• 初始化时仅加载对应业务领域的密钥
• 扩展性好，新增业务模块只需新增接口和映射

注意事项 #

• 确保AzureKeyVaultProvider.GetSecret支持并行调用，避免服务端限流问题
• 可添加日志记录，跟踪加载的密钥列表，方便排查问题
• 对于未加载的密钥，访问对应属性时可抛出明确异常（如InvalidOperationException），提示该密钥未被初始化

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