MVC调用方法时从appsettings读取CosmosDB配置失败问题排查

开发一个连接多个CosmosDB的MVC数据清理程序，会根据调用查询方法的不同建立Cosmos连接，查询结束后释放连接。实现了ConfigurationService辅助类返回EndpointConfiguration实例用于连接查询，但调用时获取的settings始终为null。相关代码及配置如下：

辅助服务代码 #

public static class ConfigurationService
{
    public static EndpointConfiguration GetByName(string configKeyName)
    {
        var environmentName = "Development";

        var config = new ConfigurationBuilder()
            .AddJsonFile($"appsettings.{environmentName}.json")
            .Build();

        var section = config.GetSection("CosmosConnectionStrings");
        var endpointConfiguration = section.Get<EndpointConfiguration>();

        return endpointConfiguration;
    }
}

模型定义 #

public class EndpointConfiguration
{
    public string DatabaseUrl { get; set; }
    public string SourceDatabase { get; set; }
    public string SourceContainer { get; set; }
}

查询方法代码 #

public static async Task<List<EventDocument>> GetEventDocsWithQueryAsync(string queryString, [CallerMemberName] string memberName = "")
{
    string databaseName = ResolveDatabaseFromCallingMethod(memberName); //返回"DatabaseCosmosDb1"或"DatabaseCosmosDb2"
    var settings = ConfigurationService.GetByName(databaseName); //始终为null

    CosmosClient client = new CosmosClient(settings.DatabaseUrl, new CosmosClientOptions()
    {
        ConnectionMode = ConnectionMode.Gateway,
        AllowBulkExecution = true
    });
    Container container = client.GetContainer(settings.SourceDatabase, settings.SourceContainer);
    List<EventDocument> results = new List<EventDocument>();

    using (FeedIterator<EventDocument> resultSetIterator = container.GetItemQueryIterator<EventDocument>(queryString))
    {
        while (resultSetIterator.HasMoreResults)
        {
            FeedResponse<EventDocument> response = await resultSetIterator.ReadNextAsync();
            results.AddRange(response);
        }
    }

    client.Dispose();
    return results;
}

appsettings.Development.json配置 #

"CosmosConnectionStrings": {
    "DatabaseCosmosDb1": {
      "DatabaseUrl": "AccountEndpoint=[endpoint]",
      "SourceDatabase": "DatabaseA",
      "SourceContainer": "EventsA"
    },
    "DatabaseCosmosDb2": {
      "DatabaseUrl": "AccountEndpoint=[endpoint]",
      "SourceDatabase": "DatabaseB",
      "SourceContainer": "EventsB"
    }
}

需要修复该问题，使方法执行时能正确获取数据库连接变量。

核心问题 #

当前ConfigurationService.GetByName方法仅获取了CosmosConnectionStrings根配置节点，直接尝试将整个根节点反序列化为EndpointConfiguration对象，但实际上根节点下是多个以数据库名为Key的子节点，每个子节点才对应一个EndpointConfiguration实例。方法没有使用传入的configKeyName定位具体子节点，导致反序列化失败返回null。

修复后的ConfigurationService代码 #

public static class ConfigurationService
{
    public static EndpointConfiguration GetByName(string configKeyName)
    {
        var environmentName = "Development";

        var config = new ConfigurationBuilder()
            .AddJsonFile($"appsettings.{environmentName}.json", optional: false, reloadOnChange: true)
            .Build();

        // 定位到CosmosConnectionStrings下的目标子节点
        var section = config.GetSection($"CosmosConnectionStrings:{configKeyName}");
        var endpointConfiguration = section.Get<EndpointConfiguration>();

        return endpointConfiguration;
    }
}

额外优化建议 #

1. 避免重复构建Configuration：每次调用GetByName都重新读取配置文件会浪费性能，建议在Program.cs/Startup.cs中全局初始化Configuration实例，通过依赖注入获取使用。
2. CosmosClient复用：CosmosClient是线程安全的，无需每次查询后Dispose，建议将其注册为单例服务，全局复用可大幅提升性能。
3. 环境变量自动获取：不要硬编码environmentName，改用Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")自动读取当前环境，适配生产、测试等多环境场景。

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