如何在Microsoft.AspNetCore.OData中用filter替代$filter实现关键字过滤？

要在Microsoft.AspNetCore.OData中用filter替代默认的$filter查询参数，核心思路是通过自定义中间件拦截请求，将自定义参数映射为OData识别的系统参数，具体步骤如下：

1. 编写自定义参数转换中间件 #

创建中间件类，检查请求中的filter参数，将其值赋值给$filter，让OData能够正常解析过滤条件：

public class ODataCustomFilterMiddleware
{
    private readonly RequestDelegate _next;

    public ODataCustomFilterMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        var query = context.Request.Query;
        if (query.TryGetValue("filter", out var filterValue))
        {
            // 构建新查询集合，将filter替换为$filter
            var queryDict = query.ToDictionary(kv => kv.Key, kv => kv.Value);
            queryDict.Remove("filter");
            queryDict.Add("$filter", filterValue);
            
            context.Request.Query = new QueryCollection(queryDict);
        }

        await _next(context);
    }
}

2. 正确注册中间件 #

在Program.cs中，将自定义中间件注册到OData路由处理之前，确保参数转换先执行：

var builder = WebApplication.CreateBuilder(args);

// 配置OData服务
builder.Services.AddControllers().AddOData(options =>
{
    options.Select().Filter().OrderBy().Expand().Count().SetMaxTop(100);
    // 这里添加你的OData模型配置，例如：
    // options.AddRouteComponents("odata", GetEdmModel());
});

var app = builder.Build();

app.UseRouting();

// 注册自定义中间件，位置必须在UseRouting之后、UseEndpoints之前
app.UseMiddleware<ODataCustomFilterMiddleware>();

app.UseAuthorization();

app.MapControllers();

app.Run();

3. 测试验证 #

发送请求http://localhost:5142/odata/devices/summaries?filter=name eq 'test'，中间件会自动将请求转换为带$filter的格式，OData即可按照指定条件过滤数据。

额外说明 #

• 如果需要同时兼容filter和$filter，可以修改中间件逻辑：仅当$filter不存在时，才将filter的值赋值给$filter
• 确保中间件注册顺序正确，否则参数转换不会生效，OData会忽略未识别的filter参数

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