.NET Core 3.1中如何解析ODataQuery/ODataQueryOptions适配自定义请求

我来帮你搞定这个问题！在.NET Core 3.1里解析OData查询并转换成其他REST服务的请求其实不难，核心是利用ODataQueryOptions来获取所有查询参数，然后把这些参数转换成目标服务需要的格式。下面一步步来：

核心思路 #

当你在控制器方法中注入ODataQueryOptions<T>（注意要用泛型版本，绑定你的实体类型，比如WeatherForecast），这个对象已经封装了所有OData查询的元数据——包括$select、$filter、$orderby、$top、$skip、$count这些选项的具体内容。我们要做的就是把这些元数据转换成目标REST服务能识别的查询参数格式。

分步解析与转换 #

下面是一个完整的示例，包含从解析OData选项到构建目标请求的全流程：

1. 调整控制器方法参数 #

首先确保你的控制器方法使用泛型的ODataQueryOptions<WeatherForecast>，这样才能正确解析实体的属性信息：

[HttpGet]
[ODataRoute]
[EnableQuery(HandleNullPropagation = HandleNullPropagationOption.False, MaxTop = 100, 
             AllowedQueryOptions = AllowedQueryOptions.Select | AllowedQueryOptions.Count | 
                                   AllowedQueryOptions.Filter | AllowedQueryOptions.OrderBy | 
                                   AllowedQueryOptions.Top | AllowedQueryOptions.Skip)]
public async Task<IActionResult> Getlist(ODataQueryOptions<WeatherForecast> options)
{
    // 后续代码放在这里
}

2. 解析基础OData查询选项 #

我们可以创建一个字典来存储转换后的查询参数，然后逐个解析简单的OData选项：

// 构建目标服务的查询参数字典
var queryParams = new Dictionary<string, string>();

// 解析$select：转换为目标服务的fields参数（示例）
if (options.SelectExpand != null)
{
    var selectedFields = options.SelectExpand.SelectExpandClause.SelectedItems
        .OfType<PathSelectItem>()
        .Select(item => item.Path.FirstSegment.Identifier)
        .Where(field => !string.IsNullOrEmpty(field));
    
    if (selectedFields.Any())
    {
        queryParams["fields"] = string.Join(",", selectedFields);
    }
}

// 解析$orderby：转换为目标服务的sort参数（示例）
if (options.OrderBy != null)
{
    var sortClauses = options.OrderBy.OrderByNodes
        .Select(node => 
        {
            var propNode = node as OrderByPropertyNode;
            if (propNode == null) return null;
            
            var direction = node.OrderByDirection == OrderByDirection.Ascending ? "asc" : "desc";
            return $"{propNode.Property.Name} {direction}";
        })
        .Where(s => !string.IsNullOrEmpty(s));
    
    if (sortClauses.Any())
    {
        queryParams["sort"] = string.Join(",", sortClauses);
    }
}

// 解析$top和$skip：转换为limit和offset参数（示例）
if (options.Top != null)
{
    queryParams["limit"] = options.Top.Value.ToString();
}
if (options.Skip != null)
{
    queryParams["offset"] = options.Skip.Value.ToString();
}

// 解析$count：转换为count=true参数（示例）
if (options.Count?.Value == true)
{
    queryParams["count"] = "true";
}

3. 解析$filter：自定义表达式转换 #

$filter是最复杂的部分，因为OData的过滤表达式是一个表达式树，我们需要遍历这个树，转换成目标服务的过滤语法（比如类似SQL的格式，或者目标服务自定义的过滤规则）。可以通过继承SingleValueNodeVisitor来实现：

// 解析$filter
if (options.Filter != null)
{
    var filterString = ConvertODataFilterToTargetSyntax(options.Filter.FilterClause.Expression);
    if (!string.IsNullOrEmpty(filterString))
    {
        queryParams["filter"] = filterString;
    }
}

// 自定义Filter转换方法
private string ConvertODataFilterToTargetSyntax(SingleValueNode expression)
{
    var visitor = new ODataFilterToTargetSyntaxVisitor();
    expression.Accept(visitor);
    return visitor.Result;
}

// 自定义表达式访问器，转换OData过滤语法为目标格式
private class ODataFilterToTargetSyntaxVisitor : SingleValueNodeVisitor<string>
{
    public string Result { get; private set; }

    public override string Visit(SingleValuePropertyAccessNode node)
    {
        // 返回属性名
        return node.Property.Name;
    }

    public override string Visit(BinaryOperatorNode node)
    {
        var leftExpr = node.Left.Accept(this);
        var rightExpr = node.Right.Accept(this);
        
        // 转换OData操作符为目标服务支持的操作符
        var operatorStr = node.OperatorKind switch
        {
            BinaryOperatorKind.Equal => "=",
            BinaryOperatorKind.NotEqual => "!=",
            BinaryOperatorKind.GreaterThan => ">",
            BinaryOperatorKind.GreaterThanOrEqual => ">=",
            BinaryOperatorKind.LessThan => "<",
            BinaryOperatorKind.LessThanOrEqual => "<=",
            BinaryOperatorKind.And => "AND",
            BinaryOperatorKind.Or => "OR",
            _ => throw new NotSupportedException($"操作符 {node.OperatorKind} 暂不支持")
        };

        return $"({leftExpr} {operatorStr} {rightExpr})";
    }

    public override string Visit(ConstantNode node)
    {
        // 处理常量值，字符串加引号
        if (node.Value is string strVal)
        {
            return $"'{strVal}'";
        }
        return node.Value.ToString();
    }

    // 如果需要支持Contains、StartsWith等函数，需要重写对应的方法
    public override string Visit(FunctionCallNode node)
    {
        if (node.Name == "contains")
        {
            var property = node.Parameters[0].Accept(this);
            var value = node.Parameters[1].Accept(this);
            return $"{property} CONTAINS {value}";
        }
        // 其他函数可以在这里扩展
        throw new NotSupportedException($"函数 {node.Name} 暂不支持");
    }
}

4. 构建并发送请求到目标服务 #

最后把转换后的查询参数拼接到目标服务的URL，然后发送请求：

// 构建目标服务URL
var targetUrlBuilder = new UriBuilder("https://your-target-service.com/api/weatherforecasts");
var queryString = new FormUrlEncodedContent(queryParams).ReadAsStringAsync().Result;
targetUrlBuilder.Query = queryString;

// 发送HTTP请求
using var httpClient = new HttpClient();
var response = await httpClient.GetAsync(targetUrlBuilder.Uri);
response.EnsureSuccessStatusCode();

// 解析目标服务返回的结果
var result = await response.Content.ReadFromJsonAsync<IEnumerable<WeatherForecast>>();
return Ok(result);

关键注意事项 #

• 字段映射：如果目标服务的字段名和你的OData实体字段名不一致，需要维护一个映射字典，在转换时替换字段名。
• 扩展过滤函数：如果需要支持更多OData过滤函数（比如StartsWith、EndsWith），需要在ODataFilterToTargetSyntaxVisitor中重写对应的Visit(FunctionCallNode)方法。
• 错误处理：要添加适当的异常捕获，比如处理不支持的操作符、函数，或者目标服务返回错误的情况。
• 参数校验：可以利用OData的EnableQuery特性限制允许的查询选项，避免解析不需要的参数。

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