使用ODataQueryOptions扩展导航属性

Question

我正在构建一个OData v.4 Web服务，该服务必须公开从另一个第三方网络源检索到的数据，因此该数据与LINQ世界中的任何内容都不相似，即：没有IQueryable，没有Context，什么都没有。

解决方法似乎是手动处理ODataQueryOptions中的参数并返回简单的项目序列。 因此，控制器方法应如下所示：

class MyMasterEntity {
    [Contained]
    public IEnumerable<MyDetailEntity> Details { get; set; }
}

// [EnableQuery]
public IEnumerable<MyMasterEntity> Get(ODataQueryOptions<MyMasterEntity> options)
{
   // process .FilterQueryOption
   // process .SelectExpandQueryOption
   // process .SkipQueryOption
   // process .TopQueryOption
   return myMasterEntityList;
}

除$expand=Details之外，此方法效果很好，在这种情况下，属性不会在得到的响应中扩展，尽管我的逻辑将它们添加得很好。

如果添加[EnableQuery]属性（开始时没有意义，因为它与ODataQueryOptions的整个概念互斥），则扩展开始工作。 还是假装它在工作，因为真正发生的是查询被处理了两次：第一次是由我的代码处理，然后是在我返回数据后由OData机械处理。 这可能是可以忍受的（无论如何，我手动进行了昂贵的调用，因此，没有大量的OData重试已准备好的数据），如果不是因为第二遍通过了诸如$ skip之类的不确定性操作这一事实。 （即：可以应用$ top多次，只要您希望收到相同的结果即可，但是使用$ skip这样做并不可行）。

从逆向工程相关程序集可以理解，标准扩展代码将实体包装到某种东西中，这告诉JSON格式化程序发出相应的属性，无论它们是否实际上在实体内部进行了扩展。

还尝试了：

• 更改返回类型（IQueryable，IHttpActionResult）
• 在手动扩展之后但返回之前SelectExpandQueryOption.ApplyTo(myMasterEntityList, new ODataQuerySettings())强制调用SelectExpandQueryOption.ApplyTo(myMasterEntityList, new ODataQuerySettings())

如何正确扩展导航属性？

Answer 1

为什么要手动处理查询选项？

使用AsQueryable LINQ扩展方法将数据转换为可查询的集合（实际上，您正在使用LINQ to Object）。

• 您的控制器必须继承自ODataController
• IEdmModel必须与路由关联。 使用ODataModelBuilder（或ODataConventionModelBuilder）对其进行定义。
• 您的方法必须返回IQueryable<MyMasterEntity>
• 仅声明[EnableQuery] 。 不要声明显式的ODataQueryOptions参数

Answer 2

我相信您需要介绍一段代码，如下所示

if(options.SelectExpand != null)
{
    Request.ODataProperties().SelectExpandClause = options.SelectExpand.SelectExpandClause;
}

ODataProperties排除方法在名称空间System.Web.OData.Extensions定义。

这告诉OData格式化程序还呈现select并expand到输出。 否则它将无法触及扩展属性，因为它可能会触发枚举。 至少我是这样理解的。

否则，看来您的方法是正确的。 可以这么说对我有用。 我的情况是我有一个无法扩展的数据库优先模型（例如，视图之间的关系），所以我扩展了OData模型，例如，手动expand了“外键链接”和一对多关系不在声明的edmx模型中。 然后，如果可能的话，我希望OData查询达到数据库级别（例如filter ），所以我的工作大致如下

public async Task<IHttpActionResult> Get(ODataQueryOptions<T> options)
{
    IQueryable<T> tempQuery = initialQuery; //E.g. EfContext.T
    IQueryable<T result = tempQuery;

    if(options.SelectExpand != null)
    {
        if(options.Filter != null)
        {
            tempQuery = options.Filter.ApplyTo(tempQuery, new ODataQuerySettings()) as IQueryable<T>;   
        }
        /* Other options that should go to the DB level... */

        //The results need to be materialized, or otherwise EF throws a
        //NotSupportedException due to columns and properties that aren't in the DB...
        result = (await tempQuery.ToListAsync()).AsQueryable();

        //Do here the queries that can't be hit straight by the queries. E.g.
        //navigation properties not defined in EF views (that can't be augmented)...

        //This is needed to that OData formatter knows to render navigation links too.
        Request.ODataProperties().SelectExpandClause = options.SelectExpand.SelectExpandClause;
}

return Ok(result);