如何在C#中为Azure Search Service传递多筛选器OData查询？

问题描述 #

我正在为Web API使用Azure Search Service，需要指导如何通过C#向该搜索服务传递包含多个筛选选项的筛选查询（带多筛选器的OData）。要求应用筛选后，搜索结果需与筛选条件完全匹配。我尝试的代码如下：

string searchServiceEndPoint = configuration["AzureSearchService:SearchServiceEndPoint"];
string queryApiKey = configuration["AzureSearchService:SearchServiceQueryApiKey"];
SearchClient searchClient = new SearchClient(new Uri(searchServiceEndPoint), indexName, new AzureKeyCredential(queryApiKey));

SearchOptions options = new SearchOptions()
{
    IncludeTotalCount = true,
    Filter = "SalesPlay eq '" + filterQuery["SalesPlay"] + "' And EventPrimaryLanguage eq '" + filterQuery["EventPrimaryLanguage"] + "' And EventStatus eq '" + filterQuery["EventStatus"] + "'"
};

var results = searchClient.Search<Azureview>("Local", options);

解决方案 #

你当前的字符串拼接方式存在注入风险，且若筛选值包含单引号会直接触发语法错误。以下两种安全可靠的实现方式：

方法一：使用FilterBuilder（推荐）

FilterBuilder是Azure Search SDK提供的强类型API，能自动处理语法细节和注入防护，代码可读性更高。

using Azure;
using Azure.Search.Documents;
using Azure.Search.Documents.Models;

// 初始化SearchClient
string searchServiceEndPoint = configuration["AzureSearchService:SearchServiceEndPoint"];
string queryApiKey = configuration["AzureSearchService:SearchServiceQueryApiKey"];
SearchClient searchClient = new SearchClient(new Uri(searchServiceEndPoint), indexName, new AzureKeyCredential(queryApiKey));

// 链式构建多条件筛选器
FilterBuilder filter = FilterBuilder.Create("SalesPlay", Operator.Equal, filterQuery["SalesPlay"])
    .And(FilterBuilder.Create("EventPrimaryLanguage", Operator.Equal, filterQuery["EventPrimaryLanguage"]))
    .And(FilterBuilder.Create("EventStatus", Operator.Equal, filterQuery["EventStatus"]));

SearchOptions options = new SearchOptions()
{
    IncludeTotalCount = true,
    Filter = filter.ToString()
};

var results = searchClient.Search<Azureview>("Local", options);

方法二：参数化筛选

通过OData的参数化语法手动构建筛选器，同样能避免注入问题：

// 初始化SearchClient（同方法一）
SearchClient searchClient = new SearchClient(new Uri(searchServiceEndPoint), indexName, new AzureKeyCredential(queryApiKey));

SearchOptions options = new SearchOptions()
{
    IncludeTotalCount = true,
    // 使用参数占位符定义筛选逻辑
    Filter = "SalesPlay eq @salesPlay And EventPrimaryLanguage eq @lang And EventStatus eq @status"
};

// 绑定筛选参数
options.FilterParameters.Add("@salesPlay", filterQuery["SalesPlay"]);
options.FilterParameters.Add("@lang", filterQuery["EventPrimaryLanguage"]);
options.FilterParameters.Add("@status", filterQuery["EventStatus"]);

var results = searchClient.Search<Azureview>("Local", options);

关键注意事项 #

• 确保索引中SalesPlay、EventPrimaryLanguage、EventStatus字段的可筛选（Filterable）属性已启用，否则筛选条件会失效。
• 若筛选参数可能为空，需提前判断并跳过对应条件，避免生成无效的筛选逻辑。
• 两种方法都会自动处理字符串值的单引号转义，无需手动操作。

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