.NET Core OData中ODataQueryOptions的$expand后端不生效问题

控制器代码 #

[EnableQuery]
public async Task<ActionResult<IEnumerable<SecuredEmployee>>> Get([FromQuery] int? managerLevel,
                                                                  [FromQuery] string? managerEmployeeNumber,
                                                                  [FromQuery] bool isSearch = false,
                                                                  ODataQueryOptions<SecuredEmployee>? options = null)
{
    var userId = "Maegan.Effertz.61zi7o@test.com";
    isSearch = true;

    var employees = await mediator.Send(new ListEmployeesQuery(managerLevel, managerEmployeeNumber, userId, isSearch: isSearch), CancellationToken.None);

    var filteredResults = options?.Filter.ApplyTo(employees.AsQueryable(), new ODataQuerySettings()) as IQueryable<SecuredEmployee>;

    var expandedResults = options?.SelectExpand.ApplyTo(filteredResults, new ODataQuerySettings()) as IQueryable<SecuredEmployee>;

    return Ok(employees);
}

接口调用示例 #

https://localhost:7145/odata/ExportSearchResults/
        ?$filter=((contains(forename, 'dange')) or (contains(surname, 'dange')) or (contains(employeeNumber, 'dange'))) and (status eq true)
        &$expand=PerformanceReviews,EngagementScores,TalentAssessments,SecuredEmployeeDetails
        &isSearch=true&$top=5&$skip=0&$count=true

现象 #

• 返回Ok(employees)时，$filter和$expand能通过[EnableQuery]特性自动生效
• 手动调用options?.Filter.ApplyTo可获取正确的过滤结果
• 手动调用options?.SelectExpand.ApplyTo时，expandedResults返回null

OData模型配置代码 #

public static ODataConventionModelBuilder AddODataEntities(this ODataConventionModelBuilder modelBuilder)
{
    modelBuilder.EntitySet<SecuredEmployee>("Employee").EntityType.HasKey(entity => entity.EmployeeId);
    modelBuilder.EntitySet<SecuredPerformanceReview>("PerformanceReview").EntityType.HasKey(entity => entity.Id);
    modelBuilder.EntitySet<SecuredEngagementScore>("EngagementScores").EntityType.HasKey(entity => entity.Id);
    modelBuilder.EntitySet<SecuredTalentAssessment>("TalentAssessments").EntityType.HasKey(entity => new { entity.EmployeeId, entity.Year });
    modelBuilder.EntitySet<TalentAssessmentAuditLog>("TalentAssessmentAuditLogs").EntityType.HasKey(entity => new { entity.EmployeeId, entity.Year, entity.IdentityId, entity.EffectiveDate });
    modelBuilder.EntitySet<SecuredEmployeeDetails>("EmployeeDetails").EntityType.HasKey(entity => new { entity.EmployeeId });
    modelBuilder.EntitySet<SecuredMobilityConsideration>("MobilityConsiderations").EntityType.HasKey(entity => entity.Id);
    modelBuilder.EntitySet<SecuredEmployee>("ExportSearchResults").EntityType.HasKey(entity => entity.EmployeeId);

    return modelBuilder;
}

AddOData服务配置 #

services.AddControllers().AddOData(opt => opt.Count().Filter().Expand().Select().OrderBy().SetMaxTop(100)
    .AddRouteComponents("odata", builder.GetEdmModel()));

问题原因分析 #

1. SelectExpand.ApplyTo返回类型不匹配：使用$expand或$select时，该方法返回的是包装类型（如SelectExpandWrapper<SecuredEmployee>），直接强转为IQueryable<SecuredEmployee>会得到null。
2. filteredResults可能为null：如果请求中没有$filter参数，options?.Filter为null，导致filteredResults为null，此时传入SelectExpand.ApplyTo会返回null。
3. [EnableQuery]与手动处理冲突：该特性会自动处理所有OData参数，而你手动处理后并未使用处理后的结果，反而返回原始employees，逻辑存在冗余和冲突。

解决方案 #

方案1：正确处理SelectExpand.ApplyTo的返回值 #

针对包装类型做转换，避免直接强转：

var queryableEmployees = employees.AsQueryable();

// 应用Filter（兼容无Filter的情况）
var queryAfterFilter = options?.Filter != null 
    ? options.Filter.ApplyTo(queryableEmployees, new ODataQuerySettings()) as IQueryable<SecuredEmployee> 
    : queryableEmployees;

// 应用SelectExpand并处理包装类型
var expandResult = options?.SelectExpand.ApplyTo(queryAfterFilter, new ODataQuerySettings());

// 从包装类型中提取实体
var expandedResults = expandResult != null 
    ? expandResult.Cast<dynamic>().Select(e => e.Instance as SecuredEmployee).ToList() 
    : queryAfterFilter.ToList();

// 用expandedResults生成Excel或返回

方案2：禁用[EnableQuery]，完整手动处理所有OData参数 #

去掉自动处理特性，统一手动处理所有查询选项：

// 移除[EnableQuery]特性
public async Task<ActionResult<IEnumerable<SecuredEmployee>>> Get([FromQuery] int? managerLevel,
                                                                  [FromQuery] string? managerEmployeeNumber,
                                                                  [FromQuery] bool isSearch = false,
                                                                  ODataQueryOptions<SecuredEmployee>? options = null)
{
    var userId = "Maegan.Effertz.61zi7o@test.com";
    isSearch = true;

    var employees = await mediator.Send(new ListEmployeesQuery(managerLevel, managerEmployeeNumber, userId, isSearch: isSearch), CancellationToken.None);
    var queryable = employees.AsQueryable();

    if (options != null)
    {
        // 依次应用所有OData查询选项
        queryable = options.Filter?.ApplyTo(queryable, new ODataQuerySettings()) as IQueryable<SecuredEmployee> ?? queryable;
        
        var selectExpandResult = options.SelectExpand.ApplyTo(queryable, new ODataQuerySettings());
        queryable = selectExpandResult is IQueryable<SecuredEmployee> 
            ? selectExpandResult as IQueryable<SecuredEmployee> 
            : selectExpandResult.Cast<dynamic>().Select(e => e.Instance).AsQueryable();

        queryable = options.Top?.ApplyTo(queryable, new ODataQuerySettings()) as IQueryable<SecuredEmployee> ?? queryable;
        queryable = options.Skip?.ApplyTo(queryable, new ODataQuerySettings()) as IQueryable<SecuredEmployee> ?? queryable;
        queryable = options.OrderBy?.ApplyTo(queryable, new ODataQuerySettings()) as IQueryable<SecuredEmployee> ?? queryable;
    }

    var finalResults = queryable.ToList();
    // 此处用finalResults生成Excel
    return Ok(finalResults);
}

方案3：检查导航属性的模型配置 #

确保SecuredEmployee的导航属性在OData模型中正确识别：

• 导航属性需为public virtual（适配EF Core延迟加载）
• 显式配置导航关系（若自动发现失效）：

modelBuilder.EntityType<SecuredEmployee>()
    .HasMany(e => e.PerformanceReviews)
    .WithOne()
    .HasForeignKey(pr => pr.EmployeeId); // 根据实际外键调整

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