使用WebApi和映射模型实现OData

本文关键字:实现 OData 模型 映射 WebApi 使用 | 更新日期: 2023-09-27 18:13:51

我正在尝试在WebApi中实现OData。我正在使用存储库模式和EF5(在后端),这仍然与我发现的所有示例一致。这就是问题所在。我试图将EF生成的类隐藏在控制器中使用AutoMapper映射的模型后面。我看到的例子似乎返回任何从repo

出来的东西。

我不想在控制器中应用OData参数(对已映射的结果),而是在存储库中应用OData参数,以防止延迟执行。我可以将odataccriteria传递到存储库中,但是当我尝试Appy时,我得到了一个错误,因为似乎选项/结果键入到IQueryable from表示层而不是IQueryable .

我看到其他人在另一篇文章中回避了这个问题,但是,这只是文章的一小部分,似乎没有帮助。

有其他人处理过这个吗?我真的不想公开EF类。噢,我先用DB。

使用WebApi和映射模型实现OData

下面的代码演示了您的需求。

要实现这个结果,您需要确保查询已经执行(使用ToList())。最有效的方法是添加分页(bonus)并返回一个PageResult<>对象。

public PageResult<WebPoco> Get(ODataQueryOptions<WebPoco> queryOptions)
{
    var data2 = DatabaseData();
    //Create a set of ODataQueryOptions for the internal class
    ODataModelBuilder modelBuilder = new ODataConventionModelBuilder();
    modelBuilder.EntitySet<DatabasePoco>("DatabasePoco"); 
    var context = new ODataQueryContext(
         modelBuilder.GetEdmModel(), typeof(DatabasePoco));
    var newOptions = new ODataQueryOptions<DatabasePoco>(context, Request);
    var t = new ODataValidationSettings() { MaxTop = 25 };
    var s = new ODataQuerySettings() { PageSize = 25 };
    newOptions.Validate(t);
    IEnumerable<DatabasePoco> results =
        (IEnumerable<DatabasePoco>)newOptions.ApplyTo(data2, s);
    int skip = newOptions.Skip == null ? 0 : newOptions.Skip.Value;
    int take = newOptions.Top == null ? 25 : newOptions.Top.Value;
    List<DatabasePoco> internalResults = results.Skip(skip).Take(take).ToList();
    // map from DatabasePoco to WebPoco here:
    List<WebPoco> webResults; 
    PageResult<WebPoco> page =
        new PageResult<WebPoco>(
            webResults, Request.GetNextPageLink(), Request.GetInlineCount());
    return page;
}

using语句

using System.Web.Http;
using System.Web.Http.OData;
using System.Web.Http.OData.Builder;
using System.Web.Http.OData.Query;

测试类

public class WebPoco
{
    public int id { get; set; }
    public string name { get; set; }
    public string type { get; set; }
}
public class DatabasePoco
{
    public int id { get; set; }
    public string name { get; set; }
    public string type { get; set; }
}

和一些测试数据

private IQueryable<DatabasePoco> DatabaseData()
{
    return (
        new DatabasePoco[] { 
            new DatabasePoco() { id = 1, name = "one", type = "a" },
            new DatabasePoco() { id = 2, name = "two", type = "b" },
            new DatabasePoco() { id = 3, name = "three", type = "c" },
            new DatabasePoco() { id = 4, name = "four", type = "d" },
            new DatabasePoco() { id = 5, name = "five", type = "e" },
            new DatabasePoco() { id = 6, name = "six", type = "f" },
            new DatabasePoco() { id = 7, name = "seven", type = "g" },
            new DatabasePoco() { id = 8, name = "eight", type = "h" },
            new DatabasePoco() { id = 9, name = "nine", type = "i" }
        })
        .AsQueryable();
}

如果您返回的Queryable是通过dbContext.dbSet。选择(x => new Model {Id = x.Id})机制代替AutoMapper。然后,在Queryable上应用的条件可以由EF LINQ提供程序自动翻译和评估。否则,你将不得不编写一个自定义的LINQ提供程序,它将表达式从基于Model属性的表达式更改为基于EF_Class属性的表达式。