Web Api系列教程第2季(OData篇)(一)——OData简介和一个小应用

王朝学院·作者佚名  2016-05-21
窄屏简体版  字體: 小  |  中  |  大  |  超大  

Web Api系列教程第2季(OData篇)(一)——OData简介和一个小应用第一季的链接以及系列导航:http://www.cnblogs.com/fzrain/p/3490137.html

在这里,首先要感谢Taiseer Joudeh不断的为我们带来最新的技术分享,楼主对web api这种技术可谓是非常的喜欢,同时也得到很多园友的支持,所以继续是必然的。经过上一阶段的学习,我们对于web api应该已经不是很陌生了,从本篇开始将开始介绍OData。我也是刚开始学,因此把学习过程记录下来并分享给大家,期待一起交流进步。

在本次系列中,我们将沿用第一季的项目背景来构建一个OData服务,本文将用一个简单的例子帮大家来认识OData,在介绍例子之前我们先介绍一下OData的定义和约定。

OData简介 Open Data PRotocol (开放数据协议,OData)是用来查询和更新数据的一种Web协议,其提供了把存在于应用程序中的数据暴露出来的方式。OData运用且构建于很多 Web技术之上,比如HTTP、Atom Publishing Protocol(AtomPub)和JSON,提供了从各种应用程序、服务和存储库中访问信息的能力。OData被用来从各种数据源中暴露和访问信息, 这些数据源包括但不限于:关系数据库、文件系统、内容管理系统和传统Web站点。

我们知道,构建符合REST原则的服务应该具备一下特点:

1.每一个资源都由一个唯一的URI来标识。

2.通过HTTP方法(GET, POST, PUT, and DELETE)来实现对资源的CRUD。

3.能根据客户端指定的格式来返回数据:xml,JSON等。

小应用:查询现有的OData服务 在我们开始创建OData服务之前,为了让大家对OData有一个更深入的理解,在这里我们将查询一个已经存在的OData服务(使用的是Northwind数据库),对应的基地址是:http://services.odata.org/Northwind/Northwind.svc。你可以使用任何REST客户端(例如fiddler,PostMan)。当然如果只是做查询操作,你也可以直接使用浏览器。

下表列举了一些常用的Odata操作:

操作

URL

说明

             $filter

http://services.odata.org/Northwind/Northwind.svc/Products?$filter=ProductName eq 'Tofu'

根据表达式的状态返回结果(返回ProductName 等于Tofu的Products)

            $orderby

http://services.odata.org/Northwind/Northwind.svc/Products?$orderby=ProductName

根据结果排序(根据ProductName列排序)

            $skip

http://services.odata.org/Northwind/Northwind.svc/Products?$skip=10

越过结果中的n条数据,常用于分页

            $top

http://services.odata.org/Northwind/Northwind.svc/Products?$top=10

返回结果中的前n条记录,常用于分页

           $select

http://services.odata.org/Northwind/Northwind.svc/Products?$filter=ProductName eq 'Tofu'&$select=ProductName,UnitPrice

选择需要返回的属性

           $expand

http://services.odata.org/Northwind/Northwind.svc/Products?$expand=Supplier

返回Products中包含的导航属性(关联属性)Supplier

          $inlinecount

http://services.odata.org/Northwind/Northwind.svc/Products?$inlinecount=allpages

向服务器获取符合条件的资源总数(分页的total值)

通过上面表格的内容,我们还可以通过组合查询条件来实现复杂的查询(例如:我们想实现服务器端的分页,那么我们就可以使用如下的URI:http://services.odata.org/Northwind/Northwind.svc/Products?$top=10&$skip=0&$orderby=ProductName&$inlinecount=allpages)。在上面的URI中,$skip代表跳过的数据,通常指pageSize*pageIndex,同时$inlinecount返回一个int值代表记录总数。

OData服务支持内容的选择,也就是说客户端可以通过设置请求头Accept header来定制响应数据的格式,每种格式都有各自的优缺点,下表就说明了彼此的不同之处:

 

XML

JSON(详细版)

JSON(轻量版)

            OData版本

版本1,2,3

版本1,2,3

版本3

          元数据及超链接

包含数据和元数据

包含数据和元数据

仅包含数据

          数据大小

28.67 KBs

14.34 KBs, 小了近50%

4.25 KBs, 小了近75%

对于移动客户端消费是否简单

否

是

是

       Accept Header

application/atom+xml

application/json;odata=verbose

application/json

 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
 
© 2005- 王朝網路 版權所有 導航