问题

Web API 怎么支持通用的 OData 系统查询项,例如 $select 或 $filter。

解决方案

为了在 Web API 中启用查询项,我们需要在 Action 上使用 EnableQueryAttribute。

如果 Action 没有返回集合,而是返回单个对象的实例,调用端仍然可以使用 $expand 和 $select 两个查询语句,要达到这个目的,我们必须将返回对象包装在 SingleResult<T> 中。集合和单个对象实例作为返回值的例子如订单 12-7 所示

清单 12-7. 在两个路由上启用查询语句

     public class PlayersController : ODataController

     {

         private readonly PlayersContext playersDbContext = new PlayersContext();

         [EnableQuery]

         public IQueryable<Player> GetAllPlayers()

         {

             Return playersDbContext;

         }

         [EnableQuery]

         public SingleResult<Player> GetSinglePlayers(int key)

         {

             return SingleResult.Create(playersDbContext.Where(x => x.Id == key).AsQueryable());

         }

     }

工作原理

OData 查询选项是被定义在 OData 规范中,如,查询字符串的参数控制的是返回资源的数量和顺序。ASP.NET Web API 几乎支持所有的标准查询项:

  • $expand:允许响应给客户端的信息包含关联资源(导航属性)
  • $select:限制返回的属性
  • $filter:过滤 Api 暴露出来的资源
  • $count:获取集合中实体的总数
  • $orderby:指定集合的排序 key
  • $skip:获取集合跳过的数量
  • $top:限制集合返回集合的数量
  • $format:请求特定的响应格式

唯一不支持的是 $search 查询参数。

小提示 可以查看 OData 4.0 支持的完整的文档地址:http://docs.oasis-open.org/OData/new-in-OData/v4.0/cn01/new-in-OData-v4.0-cn01.html

查询项是在 ASP.NET Web API 中被 ODataQueryOption 类所描述的。EnableQueryAttribute 的工作方式实际是非常简单的。因为他是 Action 的 Filter,在 OnActionExecuted 方法中会获取 Action 的响应,并转换 HttpContent 为ObjectContent<T>。然后根据 HttpRequest 基于客户端的参数构造 ODataQueryOptions 实例,并返回相应的响应给客户端。如果响应是集合的话,可以响应客户端所有的查询项。如果响应不是集合,就会通过 ObjectContent 包装成 SingleResult<T>。这些时候,$expand 和 $select 都是可用的。

不使用 EnableQueryAttribute,也可以使用 ODataQueryOptions,他是可以接受 Action 的参数的。这种方式是通过自定义 HttpParameterBinding 类型的 ODataQueryParameterBinding 来支持的。我们也可以使用 ODataQueryOptions 实例中的信息手动执行相关查询。

在 Web API 中我们不需要完全掌握 OData 就可以体会到查询项给我们带来的便利。就算不是基于 ODataCotrollers,只要 Action 上使用了 EnableQueryAttribute 属性标签,我们还是可以在 Web API 上使用一些基础查询项,例如,$top,$skip,$select。

代码演示

在 Controller 的 Action 上使用 EnableQueryAttribute,这样的请求就可以使用 OData 查询项,如清单 12-7

  • Host/Plays(1)$select=Name,Team:使用 Player 实体的 Id 进行过滤,仅仅返回 Name 和 Team 两个属性。这个例子的响应,如清单 12-8.

清单 12-8. 从 OData 的 Web API 查询响应例子

{
"@OData.context":"http://localhost:43539/OData/$metadata#Players(Name,Team)/$entity","Name":"Name1","Team":"Team"
  • Host/Players?skip=1&$top=2:忽略集合中第一个实体,然后再剩下的实体中获取两个返回(可以理解为分页的第二页数据,每页大小是 2)。具体响应,如清单 12-9 所示。

清单 12-9. 从 OData 的 Web API 查询响应例子

{
"@OData.context":"http://localhost:43539/OData/$metadata#Players","value":[
{
"Id":1,"Name":"Name1","Team":"Team"
},{
"Id":2,"Name":"Name11","Team":"Team"
}
]
}
  • Host/Players?$format=application/json;OData.metadata=full&$filter=Team%20eq%20%27Team2%27:请求条件你为 Team 属性值为 Whales,以 json 格式返回 ,包含 OData 元数据的所有信息,包含类型和导航链接。具体响应结果,如清单 12-10 所示
{
"@OData.context":"http://localhost:43539/OData/$metadata#Players","value":[
{
"@OData.type":"#BoiledCode.WebApi.Recipe.ODataDemo.Models.Player","@OData.id":"http://localhost:43539/OData/Players(3)","@OData.editLink":"http://localhost:43539/OData/Players(3)","Id":3,"Name":"Name2","Team":"Team2"
},{
"@OData.type":"#BoiledCode.WebApi.Recipe.ODataDemo.Models.Player","@OData.id":"http://localhost:43539/OData/Players(4)","@OData.editLink":"http://localhost:43539/OData/Players(4)","Id":4,"Name":"Name21","Team":"Team2"
}
]
}

就像上面提到的,我们可以通过在 Action 方法中使用 ODataQueryOptions 参数,来手动的实现询项。ODataQueryParameterBinding 会帮我完成将对象传入到 Action 的操作,这样我们就可以 Action 内部提取 OData 相关的查询项了。

清单 12-11. 在 Action 中使用 ODataQueryOptions

         public IQueryable<Player> GetAllPlayers(ODataQueryOptions queryOptions)

         {

             // 客户端传入的 top 和 skip

             var filtered = db.Players.Skip(queryOptions.Skip.Value);

             if (queryOptions.Top.Value > )

             {

                 filtered = filtered.Take(queryOptions.Top.Value);

             }

             return filtered.AsQueryable();

         }

[水煮 ASP.NET Web API2 方法论](12-3)OData 查询的更多相关文章

  1. [水煮 ASP.NET Web API2 方法论](3-9)空气路由的设置

    阅读导航 问题 解决方案 工作原理 代码演示 在此解释一下,空气路由,是本人臆想出来,觉着更能表达 IgnoreRoute 的意图,如果看着辣眼睛^^,请见谅. 问题 我们在之定义过集中式路由,集中式 ...

  2. [水煮 ASP.NET Web API2 方法论](1-2)在 WebForm 应用程序中添加 ASP.NET Web API

    问题 怎么样将 Asp.Net Web Api 加入到 Asp.Net Web From 应用程序中 解决方案 在 Visual Studio 2013 中,创建新的 Web From,可以直接在&q ...

  3. [水煮 ASP.NET Web API2 方法论](1-5)ASP.NET Web API Scaffolding(模板)

    问题 我们想快速启动一个 ASP.NET Web API 解决方案. 解决方案 APS.NET 模板一开始就支持 ASP.NET Web API.使用模板往我们的项目中添加 Controller,在我 ...

  4. [水煮 ASP.NET Web API2 方法论](1-4)从 MVC Controller 链接到 API Controller 以及反向链接

    问题 想创建一个从 ASP.NET MVC controller 到 ASP.NET Web API controller 的直接链接,或者反向链接. 解决方案 可以使用 System.Web.Htt ...

  5. [水煮 ASP.NET Web API2 方法论](1-1)在MVC 应用程序中添加 ASP.NET Web API

    问题 怎么样将 Asp.Net Web Api 加入到现有的 Asp.Net MVC 项目中 解决方案 在 Visual Studio 2012 中就已经把 Asp.Net Web Api 自动地整合 ...

  6. [水煮 ASP.NET Web API2 方法论](1-3)如何接收 HTML 表单请求

    问题 我们想创建一个能够处理 HTML表单的 ASP.NET Web API 应用程序(使用 application/x-www-form-urlencoded 方式提交数据). 解决方案 我们可以创 ...

  7. [水煮 ASP.NET Web API2 方法论](1-6)Model Validation

    问题 想要 ASP.NET Web API 执行模型验证,同时可以和 ASP.NET MVC 共享一些验证逻辑. 解决方案 ASP.NET Web API 与 ASP.NET MVC 支持一样的验证机 ...

  8. [水煮 ASP.NET Web API2 方法论](1-7)CSRF-Cross-Site Request Forgery

    问题 通过 CSRF(Cross-Site Request Forgery)防护,保护从 MVC 页面提交到ASP.NET Web API 的数据. 解决方案 ASP.NET 已经加入了 CSRF 防 ...

  9. [水煮 ASP.NET Web API2 方法论](1-8)添加 Session 状态

    问题 ASP.NET Web API 构建 Web 应用程序时,要求使用 Session 在服务器存储一些用户特定的信息 解决方案 ASP.NET Web API 不支持 Session,因为 API ...

  10. [水煮 ASP.NET Web API2 方法论](12-1)创建 OData

    问题 怎样用在 Web API 中创建 OData 服务. 解决方案 对于我们来说,在 Web API 中使用 OData最简单的方式就是使用 ASP.NET 模板来创建Odata Controlle ...

随机推荐

  1. jQuery获取元素对象本身的html

    Jquery获取html标签,包含该标签本身 2018年04月01日 20:16:10 清--水 阅读数:829   版权声明:本文为博主原创文章,未经博主允许不得转载. https://blog.c ...

  2. Python图像处理库(PIL)

    官方:(详细)http://pillow.readthedocs.io/en/3.1.x/reference/ImageDraw.html http://pillow.readthedocs.io/e ...

  3. middle中间件

    什么事中间件: http://www.crazyant.net/1001.html dd

  4. DOM基本代码一

    dom学习基本代码第一部分 <!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> < ...

  5. Leetcode 381. O(1) 时间插入、删除和获取随机元素 - 允许重复

    1.题目描述 设计一个支持在平均 时间复杂度 O(1) 下, 执行以下操作的数据结构. 注意: 允许出现重复元素. insert(val):向集合中插入元素 val. remove(val):当 va ...

  6. Codeforces Round #202 (Div. 2) B,C,D,E

    贪心 B. Color the Fence time limit per test 2 seconds memory limit per test 256 megabytes input standa ...

  7. [C#] 类型学习笔记三:自定义值类型

    既前两篇之后,这一篇我们讨论通过struct 关键字自定义值类型. 在第一篇已经讨论过值类型的优势,节省空间,不会触发Gargage Collection等等. 在对性能要求比较高的场景下,通过str ...

  8. Mybatis 使用技巧总结

    9月 11, 2014 | Nix.Huang 目录: 1.区分 #{} 和 ${}的不同应用场景 2.spring环境用mybatis-spring 的接口而不是Mybatis的原生接口 3.返回M ...

  9. 【转载】Java JVM : Xms Xmx PermSize MaxPermSize 区别

     转载自:http://cxh61207.iteye.com/blog/1160663 java JVM虚拟机选项: Xms Xmx PermSize MaxPermSize 区别 Xms 是指设定程 ...

  10. Item 2---遇到构造器具有多个参数时,要考虑用构建器;Builder模式

    问题,面对这种一个构造器具备多个参数的问题,现有的做法是使用重叠构造器的方式,该方式存在的问题: public class NutritionFacts { private final int ser ...