ASP.NET Core中OData $Expand配合AutoMapper未返回展开集合的问题

核心根本原因 #

• 序列化管道与业务流程错配：查询阶段AutoMapper.AspNetCore.OData.EFCore扩展已经根据请求中的$expand参数，在EF Core查询链路中通过Include加载了关联的HistoryItems、CustomFields集合，与调试时观测到的“关联数据已加载到内存但未出现在响应中”的现象完全吻合。问题出在返回环节：控制器直接执行return Ok(issues.ToList())时，响应会走ASP.NET Core原生的普通JSON序列化流程，完全绕过OData专属的序列化器。OData的$expand输出逻辑完全依赖ODataMediaTypeFormatter识别EDM模型中的导航属性规则来写入关联集合，普通序列化器既不感知EDM定义的导航关系，也会因为默认的序列化配置（如循环引用保护、属性输出过滤规则）直接跳过未被显式标记的集合属性，哪怕内存中该属性有值，也不会写入最终响应。
• EDM模型配置存在硬伤：
  • 实体集与实体类型映射错位：代码中builder.EntitySet<GeminiIssue>("projects")将GeminiIssue类型挂载到名为"projects"的实体集下，导致OData路由在解析/odata/projects/184/issues路径时，既无法识别正确的实体语义（本该将184匹配为项目实体的主键，实际会被解析为GeminiIssue的主键），也无法正确关联GeminiIssue下的导航属性。
  • 导航属性定义不完整：仅在GeminiIssue端配置了HasMany关联，未在GeminiIssueHistory端配置对应的反向引用与外键约束，ODataConventionModelBuilder无法按照约定将该集合识别为合法的可展开导航属性，仅会将其作为普通业务属性处理，$expand参数解析时自然无法匹配到目标属性。
• 存在版本不兼容的无效配置：endpoints.Filter().OrderBy().Expand().Select().MaxTop(null)属于OData 8.x版本的全局配置语法，当前使用的是7.5.6版本的OData，该配置完全无效，不会对查询展开行为产生任何正向作用。

对应修复方案 #

• 修正EDM模型映射关系：
  • 调整实体集定义：将原错误的builder.EntitySet<GeminiIssue>("projects")修改为符合业务语义的映射——单独定义GeminiProject实体类型并挂载到"projects"实体集，为其配置指向GeminiIssue集合的导航属性；将GeminiIssue实体挂载到独立的"issues"实体集，确保路径解析与实体类型一一对应。
  • 补全双向导航约束：手动配置GeminiIssue与GeminiIssueHistory、GeminiCustomField之间的外键关联，明确外键匹配规则（如issue.HasMany(x => x.HistoryItems).WithOne().HasForeignKey(x => x.IssueId)），确保OData模型将这些集合识别为合法的可展开导航属性。
  • 删除版本不兼容的无效端点配置，避免干扰OData路由的正常初始化。
• 调整控制器返回逻辑，让OData序列化器接管输出流程：
  去掉提前将查询结果ToList()触发普通序列化的写法，将查询结果转为可被OData管道识别的IQueryable对象，让OData序列化器在序列化阶段自动按照EDM规则输出展开的导航集合。示例代码参考：

  // 替换原直接返回ToList()的逻辑
  var queryResult = await _geminiRepository
      .GetQueryableIssues(projectId)
      .GetQueryAsync(_mapper, options, new QuerySettings 
      { 
          ODataSettings = new ODataSettings 
          { 
              HandleNullPropagation = HandleNullPropagationOption.False 
          } 
      });
  // 直接将IQueryable结果交给OData管道处理，不要提前ToList()触发普通序列化
  return Ok(queryResult);
  

  该逻辑修正后，原本在内存中已加载的HistoryItems、CustomFields集合会被OData序列化器识别并写入响应JSON，不再出现“数据已加载但不返回”的问题。

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