.NET Core中如何为appSettings的HMAC配置添加MLC层级并读取

现有配置与代码回顾 #

假设你的appSettings.json配置片段如下：

"HMAC": {
  "MLC": {
    "Server": {
      "PE": {
        "ApiKey": "pe-api-key",
        "SecretKey": "pe-secret-key"
      },
      "DNB": {
        "ApiKey": "dnb-api-key",
        "SecretKey": "dnb-secret-key"
      }
    },
    "Clients": {
      "Billing": {
        "ApiKey": "billing-api-key",
        "SecretKey": "billing-secret-key"
      },
      "Finance": {
        "ApiKey": "finance-api-key",
        "SecretKey": "finance-secret-key"
      }
    }
  }
}

原有实体类仅直接定义Server和Clients，未包含MLC层级：

public class HMACSettings
{
    public Dictionary<string, HMACCredential> Server { get; set; }
    public Dictionary<string, HMACCredential> Clients { get; set; }
}

public class HMACCredential
{
    public string ApiKey { get; set; }
    public string SecretKey { get; set; }
}

方案1：修改实体类实现动态节点读取 #

通过新增MLC层级实体，并添加动态获取节点的方法，既保留强类型绑定，又支持不硬编码读取。

1. 更新实体类结构

// 保留原HMACCredential不变
public class HMACCredential
{
    public string ApiKey { get; set; }
    public string SecretKey { get; set; }
}

// 新增MLC层级配置类，包含对应节点并提供动态读取方法
public class MLCConfig
{
    // 与配置中的Server、Clients节点一一对应
    public Dictionary<string, HMACCredential> Server { get; set; }
    public Dictionary<string, HMACCredential> Clients { get; set; }

    // 动态获取指定节点的方法，无需硬编码属性名
    public Dictionary<string, HMACCredential> GetNode(string nodeKey)
    {
        var property = GetType().GetProperty(nodeKey, 
            System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Instance);
        return property?.GetValue(this) as Dictionary<string, HMACCredential> ?? new Dictionary<string, HMACCredential>();
    }
}

// 更新HMACSettings，添加MLC层级
public class HMACSettings
{
    public MLCConfig MLC { get; set; }
}

2. 读取配置并动态获取节点

// 绑定配置（.NET 6+可在Program.cs中执行）
var hmacSettings = Configuration.GetSection("HMAC").Get<HMACSettings>();

// 动态读取Server节点，无需硬编码hmacSettings.MLC.Server
var serverCredentials = hmacSettings.MLC.GetNode("Server");
var peCredential = serverCredentials["PE"];

// 动态读取Clients节点
var clientCredentials = hmacSettings.MLC.GetNode("Clients");
var billingCredential = clientCredentials["Billing"];

方案2：直接使用IConfiguration动态读取（无需修改实体类） #

如果不想改动原有实体类结构，可直接通过IConfiguration的路径语法动态读取指定节点，完全规避硬编码。

// 读取MLC下的Server节点
var serverSection = Configuration.GetSection("HMAC:MLC:Server");
var serverCredentials = serverSection.Get<Dictionary<string, HMACCredential>>();

// 动态指定节点名称（比如从配置或变量传入）
string targetNode = "Clients";
var targetSection = Configuration.GetSection($"HMAC:MLC:{targetNode}");
var targetCredentials = targetSection.Get<Dictionary<string, HMACCredential>>();

关键注意事项 #

• 反射方式的GetNode方法对节点名称大小写敏感，若需要忽略大小写，可在获取属性时添加BindingFlags.IgnoreCase
• 使用IConfiguration读取时，路径分隔符为冒号:，需确保路径与配置结构完全匹配
• 建议添加空值判断，避免NullReferenceException（比如方案1中GetNode返回空字典而非null）

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