.NET Blazor项目中CosmosDB authKey为空错误排查与修复

核心问题 #

你混淆了Azure Cosmos DB的两种API：实际使用的是MongoDB API，但参考的是SQL API的示例代码，两者的客户端SDK、认证逻辑完全不兼容。DocumentClient是SQL API专属客户端，不适用于MongoDB API场景，即便解决当前的authKey空值问题，后续也会出现更多兼容性错误。

排查与修复步骤 #

1. 解决当前ArgumentNullException（表面问题） #

错误直接说明调用AddCosmosDb时传入的authKey参数为null，排查点：

• 检查appsettings.json等配置文件，确认Cosmos DB密钥是否正确配置，无拼写错误或遗漏
• 验证依赖注入时，是否正确读取配置值并传入方法，排查配置绑定是否出错

2. 替换为MongoDB API的正确客户端（根本解决） #

放弃SQL API的DocumentClient，改用MongoDB官方.NET驱动适配Cosmos DB的MongoDB API：

步骤1：安装NuGet包

Install-Package MongoDB.Driver

步骤2：重构服务注册代码

替换原AddCosmosDb扩展方法，改为MongoDB API的注册逻辑：

public static IServiceCollection AddCosmosMongoDb(this IServiceCollection services, string connectionString, string databaseName)
{
    var client = new MongoClient(connectionString);
    var database = client.GetDatabase(databaseName);
    
    // 可选：初始化数据库/集合，比如检查集合是否存在
    // database.CreateCollectionIfNotExistsAsync("your-collection-name").Wait();
    
    services.AddSingleton<IMongoClient>(client);
    services.AddSingleton<IMongoDatabase>(database);
    
    return services;
}

步骤3：配置连接字符串

在appsettings.json中配置Cosmos DB MongoDB API的连接字符串（可直接从Azure门户的Cosmos DB账户「连接字符串」页面复制）：

{
  "ConnectionStrings": {
    "CosmosMongoDb": "mongodb://<账户名称>:<主键>@<账户名称>.mongo.cosmos.azure.com:10255/?ssl=true&replicaSet=globaldb&retrywrites=false&maxIdleTimeMS=120000&appName=@<账户名称>@"
  }
}

步骤4：在Program.cs中注册服务

var connectionString = builder.Configuration.GetConnectionString("CosmosMongoDb");
var databaseName = "你的数据库名称";
builder.Services.AddCosmosMongoDb(connectionString, databaseName);

3. 重构Repository层 #

基于MongoDB驱动重写数据访问逻辑，示例：

public class ProductRepository
{
    private readonly IMongoCollection<Product> _products;
    
    public ProductRepository(IMongoDatabase database)
    {
        _products = database.GetCollection<Product>("products");
    }
    
    public async Task<Product> GetByIdAsync(string id)
    {
        return await _products.Find(p => p.Id == id).FirstOrDefaultAsync();
    }
    
    // 其他CRUD方法按需实现
}

总结 #

• 优先解决API不匹配问题，这是所有错误的根源
• 确保配置的连接字符串/密钥正确，避免参数空值问题
• 基于MongoDB驱动重构数据访问层，适配Cosmos DB的MongoDB API

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