OData $expand失效：关联子记录未返回问题求助

你遇到的问题是使用OData的$expand参数时，关联的Product数据没有被返回，这是因为在构建EdmEntityObject时，没有正确地将Products识别为导航属性来处理。下面具体分析原因和解决办法：

核心原因 #

你当前使用TrySetPropertyValue(string propertyName, object value)重载来设置Products属性，这个重载只传递了属性名和值，但OData框架无法仅凭属性名判断这是一个导航属性（而非普通标量属性）。因此当处理$expand=Products时，框架不会将这个属性当作可展开的导航属性进行序列化输出。

另外，还要先确认你的Edm模型中，NS.Customer实体的Products属性已经被正确定义为集合类型的导航属性，关联到NS.Product实体——这是$expand生效的前提。

修复后的代码 #

修改你的代码，改为通过获取对应的IEdmNavigationProperty来设置导航属性的值，具体如下：

public EdmEntityObjectCollection Get() 
{
    IEdmEntityType customerType = (IEdmEntityType)ODataUntypedSample.Model.FindType("NS.Customer");
    // 获取Customer的Products导航属性
    IEdmNavigationProperty productsNavProp = customerType.FindNavigationProperty("Products");
    
    IEdmCollectionType collectionType = Request.ODataProperties().Path.EdmType as IEdmCollectionType;
    EdmEntityObjectCollection collection = new EdmEntityObjectCollection(new EdmCollectionTypeReference(collectionType));

    EdmEntityObject customer1 = new EdmEntityObject(customerType);
    customer1.TrySetPropertyValue("CustomerId", CUSTOMER1id);
    customer1.TrySetPropertyValue("FullName", "Jony Mark One");
    collection.Add(customer1);

    EdmEntityObject customer2 = new EdmEntityObject(customerType);
    customer2.TrySetPropertyValue("CustomerId", CUSTOMER2id);
    customer2.TrySetPropertyValue("FullName", "Pole Sam two");
    // 使用导航属性对象来设置值，而不是属性名字符串
    customer2.TrySetPropertyValue(productsNavProp, GetChildProduct());
    collection.Add(customer2);

    return collection;
}

private static EdmEntityObjectCollection GetChildProduct() 
{
    IEdmEntityType productType = (IEdmEntityType)ODataUntypedSample.Model.FindType("NS.Product");
    IEdmCollectionTypeReference entityCollectionType = new EdmCollectionTypeReference(new EdmCollectionType(new EdmEntityTypeReference(productType, isNullable: false)));
    EdmEntityObjectCollection ec = new EdmEntityObjectCollection(entityCollectionType);

    EdmEntityObject product1 = new EdmEntityObject(productType);
    product1.TrySetPropertyValue("ProductId", 99);
    product1.TrySetPropertyValue("CustomerIdRef", CUSTOMER2id);
    ec.Add(product1);

    EdmEntityObject product2 = new EdmEntityObject(productType);
    product2.TrySetPropertyValue("ProductId", 88);
    product2.TrySetPropertyValue("CustomerIdRef", CUSTOMER2id);
    ec.Add(product2);

    return ec;
}

额外验证点 #

• 确认你的Edm模型定义中，Customer和Product之间的导航关系是正确配置的：Customer的Products属性是Collection(NS.Product)类型的导航属性，Product的CustomerIdRef是关联到Customer.CustomerId的外键。
• 确保你的OData路由和控制器配置正确，没有禁用$expand查询选项（默认OData允许该选项，若有自定义配置需检查）。

这样修改后，当你访问http://localhost:12345/odata/Customers?$expand=Products时，customer2的Products数据就会被正确展开返回了。

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