Azure Functions + Cosmos DB实现姓名/姓模糊查询的优化方案咨询

现有代码的问题 #

1. SQL语法错误：FROM c.FirstName 应为 FROM c，且WHERE子句逻辑错误，当前写法将c.FirstName与参数surname比较，不符合需求。
2. 参数灵活性不足：路由Review/{firstName}/{surname}要求两个参数必须传入，无法支持空FirstName或空Surname的查询场景。
3. 硬编码SQL扩展性差：直接在CosmosDB特性中写死SQL，无法动态根据参数是否为空调整查询条件，维护和扩展成本高。

更优实现方案 #

改用CosmosClient手动构建动态查询，替代特性注入的硬编码SQL，同时调整路由支持可选参数，具体实现如下：

1. 调整路由与请求参数
   将路由改为支持可选参数，允许空值传入：

[HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "Review/{firstName?}/{surname?}")]

2. 注入CosmosClient构建动态查询
   在函数中注入CosmosClient，通过它动态生成查询语句，适配参数为空的场景：

[FunctionName("People_Get")]
public async Task<IActionResult> GetPeople(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", Route = "Review/{firstName?}/{surname?}")] PeopleRequest request,
    [CosmosDBConnection("CosmosDbConnectionString")] CosmosClient cosmosClient,
    ILogger log)
{
    var container = cosmosClient.GetContainer("CosmosDB", "PeopleContainer");
    var queryBuilder = new StringBuilder(@"SELECT c.id, c.FirstName, c.Surname FROM c WHERE 1=1");
    var parameters = new Dictionary<string, object>();

    // 动态添加FirstName查询条件
    if (!string.IsNullOrEmpty(request.FirstName))
    {
        queryBuilder.Append(" AND c.FirstName = @firstName");
        parameters.Add("@firstName", request.FirstName);
    }

    // 动态添加Surname查询条件
    if (!string.IsNullOrEmpty(request.Surname))
    {
        queryBuilder.Append(" AND c.Surname = @surname");
        parameters.Add("@surname", request.Surname);
    }

    // 处理双参数为空的情况（可根据需求调整逻辑）
    if (parameters.Count == 0)
    {
        return new BadRequestObjectResult("至少需要传入FirstName或Surname中的一个参数");
    }

    var queryDefinition = new QueryDefinition(queryBuilder.ToString())
        .WithParameters(parameters);

    var queryResultSetIterator = container.GetItemQueryIterator<Models.People>(queryDefinition);
    var results = new List<Models.People>();

    while (queryResultSetIterator.HasMoreResults)
    {
        var currentResultSet = await queryResultSetIterator.ReadNextAsync();
        results.AddRange(currentResultSet);
    }

    return new OkObjectResult(results);
}

3. 模糊匹配扩展（可选）
   如果需要支持包含式模糊查询（如返回姓中包含Smith的所有用户），可将条件改为使用CONTAINS函数：

// 替换Surname的查询条件
queryBuilder.Append(" AND CONTAINS(c.Surname, @surname)");

方案优势 #

• 灵活性高：可根据参数是否为空动态调整查询条件，完全适配空参数场景。
• 可维护性强：查询逻辑集中在代码中，便于后续修改和扩展（如新增查询字段）。
• 安全性好：使用参数化查询避免SQL注入风险，同时修正了原SQL的语法错误。

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