如何防止OData移除计算属性中的EntitySet对象并实现自动展开？

问题背景 #

当计算字段包含EntitySet类型值时，使用常规OData展开方法会触发报错——这是因为计算字段无法直接从数据库查询，属于计算值的固有特性。当前OData能正常返回ObjectA实例，但其中的EntitySetB无法显示；业务场景要求EntitySetB必须为实体集，后续需要通过GUID调用并对其执行过滤操作。

相关代码示例：

class EntitySetA
{
    public ObjectA? ObjectA
    {
        get
        {        
            // 获取ObjectA的逻辑代码            
        }
        set
        {
            
        }
    }
}

class ObjectA
{
    // 其他属性定义...
    public EntitySetB? EntitySetB { get; set;}
    // 其他属性定义...
}

解决方法 #

1. 手动拦截并处理$expand逻辑 #

在OData控制器中检查请求的$expand参数，当发现需要展开ObjectA/EntitySetB时，手动加载并填充EntitySetB的数据，完全绕过OData自动查询数据库的逻辑。

示例控制器代码：

public async Task<IActionResult> Get([FromODataUri] int key, ODataQueryOptions<EntitySetA> options)
{
    // 获取主实体EntitySetA
    var entitySetA = await _dataRepository.GetEntitySetAById(key);
    
    // 判断是否需要展开ObjectA下的EntitySetB
    if (options.SelectExpand?.RawExpand?.Contains("ObjectA/EntitySetB") == true)
    {
        // 根据业务逻辑加载EntitySetB，比如通过GUID过滤
        entitySetA.ObjectA.EntitySetB = await _dataRepository.GetEntitySetBByGuid(entitySetA.ObjectA.TargetGuid);
    }
    
    return Ok(entitySetA);
}

2. 正确配置EDM模型 #

在构建OData的EDM模型时，将ObjectA标记为计算属性，同时确保EntitySetB被注册为实体集，并正确定义导航关系：

public IEdmModel GetEdmModel()
{
    var builder = new ODataConventionModelBuilder();
    
    // 注册主实体集
    builder.EntitySet<EntitySetA>("EntitySetA");
    // 将ObjectA标记为计算属性，避免OData尝试从数据库查询
    builder.EntityType<EntitySetA>().Property(e => e.ObjectA).Computed();
    
    // 注册EntitySetB实体集
    builder.EntitySet<EntitySetB>("EntitySetB");
    // 定义ObjectA与EntitySetB的导航关系（注意：若EntitySetB是集合，建议将类型改为ICollection<EntitySetB>）
    builder.EntityType<ObjectA>().HasMany(o => o.EntitySetB);
    
    return builder.GetEdmModel();
}

3. 适配实体集类型要求 #

如果业务上需要通过GUID过滤EntitySetB，建议将ObjectA中的EntitySetB类型从单个实体改为集合类型（如ICollection<EntitySetB>），这样才能支持OData的过滤语法（如$filter=Guid eq 'xxx'）。

注意事项 #

• 必须手动处理所有需要展开EntitySetB的场景，确保数据在返回前已填充完成。
• 计算属性的标记Computed()不可省略，否则OData会尝试生成SQL查询该字段，导致报错。
• 若需要对EntitySetB执行过滤，需确保其在EDM模型中被正确注册为实体集，且支持对应的查询选项。

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