ASP.NET Core 8 Web API查询Cosmos DB SQL返回单个属性值的方法

你的代码无法正常运行的核心原因是：当执行SELECT c.name时，Cosmos DB返回的是包含name属性的JSON对象（格式为{"name":"xxx"}），而非单纯的字符串值，直接用GetItemQueryIterator<string>反序列化时，无法将对象转换为string类型，导致失败。

下面是两种正确的实现方式：

方式一：使用SELECT VALUE直接返回纯值（推荐） #

通过SELECT VALUE语法，让Cosmos DB直接返回属性的原始值而非包装对象，这样就能直接映射到string类型：

public async Task<string> GetDriverNameByIdAsync(string id)
{
    // 使用SELECT VALUE直接返回name的纯值，而非包含name的对象
    var queryDefinition = new QueryDefinition("SELECT VALUE c.name FROM c WHERE c.id = @id")
        .WithParameter("@id", id); // 参数化查询，避免SQL注入风险

    var queryResult = await _container.GetItemQueryIterator<string>(queryDefinition).ReadNextAsync();

    return queryResult.FirstOrDefault();
}

方式二：使用DTO接收结果（适合需要扩展的场景） #

如果后续可能需要返回更多属性，可以定义一个轻量DTO类来接收查询结果，再提取目标属性：

// 定义仅包含所需属性的DTO
public class DriverNameDto
{
    public string Name { get; set; }
}

public async Task<string> GetDriverNameByIdAsync(string id)
{
    var queryDefinition = new QueryDefinition("SELECT c.name AS Name FROM c WHERE c.id = @id")
        .WithParameter("@id", id);

    var queryResult = await _container.GetItemQueryIterator<DriverNameDto>(queryDefinition).ReadNextAsync();

    var driverName = queryResult.FirstOrDefault();
    return driverName?.Name;
}

关键注意事项 #

• 禁止字符串拼接构造查询：你原来的代码用$"SELECT * FROM c WHERE c.id = '{id}'"的方式存在严重的SQL注入风险，必须使用WithParameter绑定参数。
• 明确返回值类型：根据查询返回的JSON结构选择对应的映射类型，避免类型不匹配导致的反序列化失败。

内容的提问来源于stack exchange，提问作者R.wilson