OData协议详解,restfull对OData的GET/PUT/POST/DELET

来源：互联网发布：it监控软件排名编辑：程序博客网时间：2024/05/01 22:11

原文来至:http://user.qzone.qq.com/974816077/2

OData定义了对不同格式数据的CRUD操作选项,这些选项基于WEB来实现,可以通过http请求方式操作.每个功能选项都有一个请求体(包括请求头和请求报文体),具体请求参数细节都不同,当选项被响应完成后就向客户端返回xml/json/atom不同格式的响应体(默认返回的是xml格式,如需要返回其他格式就在url后加$format=xml/json/atom 的参数).下面我们来一一做详细的介绍:

一:首先是OData的实体数据模型Entity Data Modle(EDM),在上篇日志我们已经定义了一个实体Department,那它对应的EDM都长啥样呢?在地址栏中输入:http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/$metadata 结果如图:

<edmx:Edmx xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx" Version="1.0">

<edmx:DataServices xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" m:DataServiceVersion="1.0">

<Key>

</Key>

</EntityType>

</EntityContainer>

</Schema>

</edmx:DataServices>

</edmx:Edmx>

在EDM中我们可以拿到所有的实体信息:<EntitySet Name="Departments" EntityType="odata2_jpa2.Department"/>

与其实体属性和类型.在Olingo client 中每次选项请求都要带上一个edm作为参数如源代码:

ODataEntry createdEntry = clienApp.createEntry(edm, serviceUrl, usedFormat, "Departments", data);

(看不懂的,在后面写Olingo Client 的时候再做解释!)

二: OData中的GET选项就是查询功能,将数据暴露出来.在Olingo java库中实现方式是使用CXF将OData的响应结果发布成一个WebService的方式暴露出来.该功能是OData选项最复杂选项,支持某张表的id查询/某些字段匹配查询/所有记录查询/top/分页查询等...下面一一做介绍:
1,查询所有表department中的记录:http://127.0.0.1:8080/odata2-jpa2/SemServiceServlet.svc/Departments //在实体类后面加"s"

2,id查询:http://127.0.0.1:8080/odata2-jpa2/SemServiceServlet.svc/Departments(1) //查询department表id=1的记录,如果是字符串用''单引号
3,过滤查询($fillter):http://127.0.0.1:8080/odata2-jpa2/SemServiceServlet.svc/Departments?$fillter=Id eq 1 //查询department表中id=1的记录.
这里定义了很多运算符:

运算符描述示例

eq 等于 /AccountSet?$filter=Address1_City eq 'Redmond'

ne 不等于 /AccountSet?$filter=Address1_City ne null

gt 大于 /AccountSet?$filter=CreditLimit/Value gt 1000

ge 大于或等于/AccountSet?&$filter=CreditLimit/Value ge 1000

lt 小于 /AccountSet?$filter=CreditLimit/Value lt 1000

le 小于或等于/AccountSet?$filter=CreditLimit/Value le 1000

and 逻辑与 /AccountSet?$filter=CreditLimit/Value ge 1000 and Address1_StateOrProvince eq 'TX'

or 逻辑或 /AccountSet?$filter=AccountCategoryCode/Value eq 2 or AccountRatingCode/Value eq 1

not 逻辑非 /AccountSet?$filter=(AccountCategoryCode/Value ne null) and not (AccountCategoryCode/Value eq 1)

下表列出 Microsoft Dynamics CRM 支持的函数。

作用示例

startswith /AccountSet?$filter=startswith(Name, 'a')

substringof /AccountSet?$filter=substringof('store',Name)

endswith /AccountSet?$filter=endswith(Name, '(sample)')

4, 排序选项($orderby ): 确定使用哪些值对记录集合进行排序。desc降序默认是升序
http://127.0.0.1:8080/odata2-jpa2/SemServiceServlet.svc/Departments?$orderby=Id,Name desc //最多可以指定6个属性排序.

5, 指定要暴露的属性(对应字段):$select //指定要返回的属性的子集$select=Id,Name。如果要返回所有属性 $select=*表示

最多能同时指定12个属性.

6, $skip 设置在集合中检索记录之前要跳过的记录数,和$top选项配合使用可以实现分页

7,   $top 确定要返回的最大记录数.和$skip一起使用可以实现分页查询

8, $inlinecount=allpages/none 统计记录条数返回实例:<m:count>12</m:count> allpages显示记录条数 none不显示记录条数,相   当于没有$inlinecount选项的查询

9,   自定义查询:是为了OData特殊的查询而定义,开始没有使用"$",可以是任意key=任意value 如:http://127.0.0.1:8080/odata2-   jpa2/SemServiceServlet.svc/Departments?key=value (占时不详解如使用自定义查询,如想了解更多Olingo使用:http://olingo.apache.org/doc/odata2/index.html)

三:POST 创建实体对象并实久化,该选项的请求必须包含有body信息,所以浏览器客户端就显得无能为力了,我这里使用java写的restclient客户端,下面我们演示创建一个Department实体,body中的参数:

<?xml version='1.0' encoding='utf-8'?>

<entry xmlns="http://www.w3.org/2005/Atom"

xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"

xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

xml:base="http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/">

<id>http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/Departments(4)</id>

<title type="text">Departments</title>

<m:properties>

<d:Id>5</d:Id>

<d:Name>游戏开发部门</d:Name>

</m:properties>

</content>

</entry>

<m:properties>...</m:properties> 包含的就是要创建的实体参数 Id 和 Name(这是OData POST选项定义的请求协议),请求url:http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/Departments 请求方式选择POST 如图:

请求成功后返回statu:201 message:Created 说明已经创建成功.下面我们使用GET来验证是否真实创建成功,url: http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/Departments(5) 根据Id=5查询如图:

statu:200 返回message:OK 查询成功,说明前面的POST已经成功创建了一个Department实体了.

四: PUT 更新实体信息.同样请求报文中必须包含一个合法的OData PUT body,参数其实很简单,指定要更新某条记录的id,和更新后该记录的新数据实体,报文body如图:

<?xml version='1.0' encoding='utf-8'?>

<entry xmlns="http://www.w3.org/2005/Atom"

xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"

xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"

xml:base="Departments">

<id>http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/Departments(5)</id>

<title type="text">Departments</title>

<m:properties>

<d:Id>5</d:Id>

<d:Name>城管部门</d:Name>

</m:properties>

</content>

</entry>

该请求报文就是我们要将id=5的Department中的Name属性更新成"城管部门"(不做游戏开发部门了,没前途!摧毁多少栋梁之才).请求url:http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/Departments(5) 选择PUT方式如图:

执行成功后,同样是一GET 来验证是否更新成功? url:http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/Departments(5) 请求方式是GET (注意GET为查询请求,没有请求body参数)

我们已经是城管部门了,以后要好好改造啊!

五: 最后是删除 DELETE 选项,删除很简单,不需要请求body参数,只需要向OData服务发送要删除的记录的Id即可 url:http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/Departments(5) 请求方式选项DELETE 如图:

返回204 说明OData 删除实体成功,我们还是使用GET来验证是否真的删除了? url:http://localhost:8080/odata2-jpa2/SemServiceServlet.svc/Departments(5) 请求方式是GET 如图:

返回404 Not Found 无法找到实体数据,说明DELETE成功了!

实际上OData就是定义了资源请求规范,数据返回规范罢了,具体实现每种语言都可以去实现,java库就是由Olingo serve来实现,将CRUD都封装在起来,响应OData定义的每个选项的请求规范,按照OData定义的response规范去发布webService,整个后台代码我们需要做的就是手动数据建模(其实这样也还是有麻烦的,如果数据库中有几百张表,那么我们也就要建模几百次了,貌似现在微软也在提出自动建模的概念,只要获取到数据库中的表信息就能在后台自动建模,要实现估计得还一段时间,每种数据库的实现方式都不同).
OData让我们减少了很多代码,但也还是有它自己笨的地方,比如在DELETE选项中我们只能删除某条记录,不能同时删除多条或者删除整个表中的记录,如果要实现只能自定义代码去实现了,或者循环执行多次DELETE请求(汗吧!).

再次OData的请求头和请求body很麻烦,每次做POST或者PUT操作都要拼接复杂的body,一旦格式稍有不对请求都会失败.不过Olingo已经考虑到了这个问题,在Olingo Client中就对请求协议做了封装.具体如何应用下篇再写吧.

0 0