.NET Core 6升级后OData无法处理查询字符串请求

问题根源 #

OData 8.x 相较于旧版本，**必须显式配置EDM（实体数据模型）**来声明实体的结构、可查询属性等元数据信息。你当前的配置仅启用了查询选项，但未定义Location实体的元数据，导致OData无法识别Id、Name等属性，进而出现$select无返回结果、$filter验证报错的问题。

解决步骤 #

1. 构建EDM模型

创建EDM模型来描述Location实体的结构，有两种方式可选：

方式一：使用约定式模型构建器

在ConfigureServices中直接通过ODataConventionModelBuilder自动识别实体属性：

public void ConfigureServices(IServiceCollection services)
{
    // 构建EDM模型
    var builder = new ODataConventionModelBuilder();
    builder.EntitySet<Location>("Locations"); // 注册Location实体集

    // 添加控制器并配置OData，关联EDM模型
    services.AddControllers()
        .AddOData(options => options
            .AddRouteComponents("odata", builder.GetEdmModel()) // 指定路由前缀和模型
            .Count().Filter().Expand().Select().OrderBy().SetMaxTop(10000));
}

方式二：手动配置实体属性（适用于需要自定义元数据的场景）

如果需要更精细的控制，可创建实体配置类：

public class LocationEntityTypeConfiguration : IEntityTypeConfiguration<Location>
{
    public void Configure(EntityTypeBuilder<Location> builder)
    {
        builder.HasKey(l => l.Id); // 指定主键
        builder.Property(l => l.Name).IsRequired(); // 配置Name属性为必填
        // 其他属性配置...
    }
}

然后在模型构建器中应用该配置：

var builder = new ODataConventionModelBuilder();
builder.EntityType<Location>().ApplyConfiguration(new LocationEntityTypeConfiguration());
builder.EntitySet<Location>("Locations");

2. 优化控制器返回类型

将控制器方法的返回类型从IEnumerable<Location>改为IQueryable<Location>，这样OData可以将查询转换为数据库层面的SQL语句，避免内存中过滤/选择，提升性能：

[HttpGet]
[EnableQuery]
public IQueryable<Location> GetLocationsQuery()
{
     return _context.Locations;
}

3. 调整请求路由

如果使用了odata路由前缀，请求URL需要调整为：

http://localhost:5017/odata/Locations?$select=Id

或者如果希望保留原控制器路由，可在配置OData时不指定路由前缀，改用控制器属性路由：

// Startup中的OData配置
services.AddControllers()
    .AddOData(options => options
        .AddRouteComponents(builder.GetEdmModel()) // 不指定前缀，使用控制器的路由
        .Count().Filter().Expand().Select().OrderBy().SetMaxTop(10000));

// 控制器添加Route属性
[Route("SalesOrders")]
public class SalesOrdersController : Controller
{
    [HttpGet("GetLocationsQuery")]
    [EnableQuery]
    public IQueryable<Location> GetLocationsQuery()
    {
         return _context.Locations;
    }
}

此时原请求URL可正常使用：

http://localhost:5017/SalesOrders/GetLocationsQuery?$select=Id

验证测试 #

完成配置后，重新启动服务：

• 调用$select=Id应正常返回仅包含Id字段的数组
• 使用$filter=Name eq 'xxx'应能正确过滤结果，不再抛出属性无法识别的异常

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