EF Core中拥有类型的OData导航属性展开失败问题

问题场景 #

实体类定义如下：

[Table("tblA")]
public class EntityA
{
    [Key]
    public int ID { get; set; }

    [Required]
    public virtual EntityB EntityB { get; set; }
}

[Owned]
public class EntityB
{   
    public string Name { get; set; }

    public string Description { get; set; }

    public virtual EntityD EntityD { get; set; }
}

[Table("tblD")]
public class EntityD
{
    [Key]
    public int ID { get; set; }

    public int Count { get; set; }
}

尝试通过OData检索EntityA并包含关联的EntityD，发起请求：

https://localhost:7249/EntityA?$expand=EntityD

请求失败，返回错误：

"message": "The query specified in the URI is not valid. Could not find a property named 'EntityD' on type 'EntityA'."

解决方法 #

1. 修正OData请求URL #

EntityD并非EntityA的直接属性，而是嵌套在EntityB中的关联实体，需要使用嵌套展开语法：

https://localhost:7249/EntityA?$expand=EntityB($expand=EntityD)

该语法表示：先展开EntityA的EntityB属性，再在EntityB内部展开其EntityD属性。

2. 配置OData模型支持嵌套展开 #

确保OData模型构建时，允许EntityA展开EntityB，同时允许EntityB展开EntityD。示例配置代码：

// 方式1：分步配置
builder.EntitySet<EntityA>("EntityA")
       .EntityType.Expand(a => a.EntityB);
builder.EntityType<EntityB>()
       .Expand(b => b.EntityD);

// 方式2：链式配置
builder.EntitySet<EntityA>("EntityA")
       .EntityType.Expand("EntityB($expand=EntityD)");

3. 验证EF Core实体关系配置 #

由于EntityB是Owned实体，需确保EF Core能正确识别其与EntityD的关联。可在DbContext的OnModelCreating中显式配置：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<EntityA>()
               .OwnsOne(a => a.EntityB, bBuilder =>
               {
                   // 配置EntityB与EntityD的关联
                   bBuilder.HasOne(b => b.EntityD)
                           .WithMany() // 根据实际关系调整为WithOne或WithMany
                           .HasForeignKey("EntityDId"); // 若存在外键字段需指定
               });
}

原理说明 #

OData的$expand操作严格遵循实体的属性层级结构。EntityD属于EntityB的属性，而EntityB才是EntityA的直接属性，因此必须通过EntityB的路径来嵌套展开EntityD，直接在EntityA层级指定EntityD会因属性不存在而报错。

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