Azure多租户函数：如何为Configuration添加多路径键并绑定到Options

问题场景 #

在Azure多租户函数运行时，尝试向Configuration添加带租户ID的冒号分隔配置键，示例如下：

Key 1 => "api:BaseUrl:tenantId1", "www.tenant1.com"
Key 2 => "api:BaseUrl:tenantId2", "www.tenant2.com"
Key 3 => "api:BaseUrl:tenantId3", "www.tenant3.com"

添加后Configuration会生成层级键结构：

Key                      Value
"api"                    null
"api:BaseUrl"            null 
"api:BaseUrl:tenantId1"  "www.tenant1.com"

但绑定到ApiOptions类时出现两类问题：

• 执行configuration.Bind(apiOptions)后，apiOptions的所有属性值均为null
• 执行configuration.GetSection(nameof(ApiOptions)).Get<ApiOptions>()时抛出异常：

  "Cannot create instance of type 'System.String' because it has multiple public parameterized constructors."
  

相关代码定义：
ApiOptions类：

public class ApiOptions
{
    public string BaseUrl { get; set; }
    public string IntegrationUrl{ get; set; }
}

待添加的配置字典：

var inMemorySettings = new Dictionary<string, string>
{
    {"ApiOptions:BaseUrl:1ce1f5cc-7e01-4ee8-8e80-36e3e68405f3", "https://tenant1.lab.com"},
    {"ApiOptions:IntegrationUrl:1ce1f5cc-7e01-4ee8-8e80-36e3e68405f3", "api/id"},
};

配置构建与绑定代码：

var configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddInMemoryCollection(inMemorySettings);
var configuration = configurationBuilder.Build();
configuration.Bind(apiOptions);

问题原因 #

当前配置结构中，ApiOptions:BaseUrl下存在子节点（租户ID），但ApiOptions类的BaseUrl是string类型。配置系统尝试将子节点集合绑定到string时，由于string有多个参数化构造函数，无法自动选择合适的构造方式，因此抛出异常；而Bind方法因为找不到直接匹配ApiOptions:BaseUrl的单值配置，所以属性值为null。

解决方案 #

调整ApiOptions类的结构，将BaseUrl和IntegrationUrl改为Dictionary<string, string>类型，让配置系统自动将租户ID作为字典键、对应的URL作为值进行绑定，完美适配多租户的层级配置结构。

修改后的ApiOptions类 #

public class ApiOptions
{
    public Dictionary<string, string> BaseUrl { get; set; } = new Dictionary<string, string>();
    public Dictionary<string, string> IntegrationUrl { get; set; } = new Dictionary<string, string>();
}

配置绑定代码 #

var inMemorySettings = new Dictionary<string, string>
{
    {"ApiOptions:BaseUrl:1ce1f5cc-7e01-4ee8-8e80-36e3e68405f3", "https://tenant1.lab.com"},
    {"ApiOptions:IntegrationUrl:1ce1f5cc-7e01-4ee8-8e80-36e3e68405f3", "api/id"},
};

var configurationBuilder = new ConfigurationBuilder();
configurationBuilder.AddInMemoryCollection(inMemorySettings);
var configuration = configurationBuilder.Build();

// 方式1：使用Get<T>
var apiOptions = configuration.GetSection(nameof(ApiOptions)).Get<ApiOptions>();

// 方式2：使用Bind
// var apiOptions = new ApiOptions();
// configuration.Bind(apiOptions);

便捷使用扩展 #

如果需要根据租户ID快速获取对应URL，可以封装扩展方法：

public static class ApiOptionsExtensions
{
    public static string GetBaseUrlForTenant(this ApiOptions options, string tenantId)
    {
        return options.BaseUrl.TryGetValue(tenantId, out var url) ? url : null;
    }

    public static string GetIntegrationUrlForTenant(this ApiOptions options, string tenantId)
    {
        return options.IntegrationUrl.TryGetValue(tenantId, out var url) ? url : null;
    }
}

调用示例：

var tenantId = "1ce1f5cc-7e01-4ee8-8e80-36e3e68405f3";
var baseUrl = apiOptions.GetBaseUrlForTenant(tenantId); // 返回"https://tenant1.lab.com"
var integrationUrl = apiOptions.GetIntegrationUrlForTenant(tenantId); // 返回"api/id"

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