在UI5下初始化一个OData Model


Instantiating an OData Model
使用OData model 将控件和源自OData services的数据之间进行绑定。

Context

OData model属于server-side model。数据只存在于server端,client端只保有页面上已知的行和字段。Sorting和filtering 是在server端完成的. Client端必须发送request到server端来完成这些任务。OData model目前支持OData version 2.0.

Note
注意浏览器的Same-Origin-Policy会阻止访问不同域名的地址。

Procedure

1. 初始化一个OData Model:

var oModel = new sap.ui.model.odata.ODataModel("http://services.odata.org/Northwind/Northwind.svc/");

根据控件中定义的data binding,系统会自动向server端获取数据。
构造函数的第一个参数就是service URL。如果你需要访问多个service,就必须创建多个对应的OData model的实例。

2. 为OData model增加额外的参数。
在使用OData services时, 可以使用URL parameters实现不同的配置。
SAPUI5 会根据data binding自动设置大部分需要的URL parameters。
增加自定义的参数有两种形式:

  • 添加URL parameters 跟在service URL之后 (option1)
  • 或者使用bindElement或bindAggregation时候,可以传入a map of parameters (option2)

如果使用在OData service URL后面增加URL parameters的形式,这些参数将会包含在每一次发送到OData server的请求之中。
这种形式适用于类似authentication tokens或者是一些通用配置选项。

var oModel = new sap.ui.model.odata.ODataModel("http://myserver/MyService.svc/?custom1=value1&custom2=value2");

3. 无需每次请求都发送的参数
对于其它一些参数,没有必要每次request都发送。这些参数应该被加入特定的 aggregation 或是element binding。例如:expand 或select
对于这种情况,binding方法可以传入一组参数的映射表, 而后仅在这个特定的binding当中会包含这些参数。目前,ODataModel只支持了expand 和select。

  • 例,使用$expand参数:
oControl.bindElement("/Category(1)", {expand: "Products"}); 

oTable.bindRows({ 
  path: "/Products", 
  parameters: {expand: "Category"}
});

在第一个例子中,一次请求之后,所有属于Category(1)的products会包含在server的response里。
在第二个例子中,每一个product对应的category会被包含在每个product对应的response中输出。

  • 例,使用$select
    该参数使请求的对象只返回指定的properties.
oControl.bindElement("/Category(1)", {expand: "Products", select: "Name,ID,Products"}); 

oTable.bindRows({ 
  path: "/Products", 
  parameters: {select: "Name,Category"}
});

在第一个例子中,返回的是Category(1)的"Name"和“ID”,以及products中所有的properties。
In the first example the properties Name and ID ofCategory(1)
在第二个例子中,返回的是每个product的“Name”和“Category”属性。Category属性会同时包含一个指向对应category entry的链接。

4. 添加自定义的query option
可以在URL后面自定义query option。注意query option不是以$开头:

http://services.odata.org/OData/OData.svc/Products?x=y

当然也可以在aggregation binding时传入参数:

oTable.bindRows({
  path: "/Products", 
  parameters: { 
    custom: { param1: "value1", param2: "value2" }
   },
  template: rowTemplate 
});

或者是bindElement:

oTextField.bindElement("/GetProducts", { custom: { "price" : "500" } });

5. Create virtual entries.
对于某个collection,可以创建空的对象记录进行绑定。你可以调用submitChanges来决定,何时将这些对象保存到后台server端。Application必须显式地调用这个方法。
在数据被持久化到后台之前,所有创建的虚拟记录会被保存在一个request queque当中,仍有机会被删除。Application可以决定创建的对象中包含哪些property,也可以为这些字段设置默认值。否则,字段的值就为空。
必须确保Dataset和property在OData Service上存在并且定义在metadata document里面。

例子:

// create an entry of the Products collection with the specified properties and values 
var oContext = oModel.createEntry("Products",{ID:99,Name:"Product",Description:"new Product",ReleaseDate:new Date(),Price:"10.1",Rating:1}); 
// use the returned context for binding against this entry
oLayout.setBindingContext(oContext); 
oSimpleListBox.addItem(new sap.ui.core.ListItem({text: "Added entry: " + oContext.getPath()})); 
// to delete a created entry from the request queue without persisting it provide the created context to the deleteCreatedEntry function 
oModel.deleteCreatedEntry(oContext);

createEntry方法返回一个context对象,可以用它来绑定新建的entry。

下面的例子是如何将request queque当中的entry写回到后端:

// provide optional success and error functions which are called for each request in the queue oModel.submitChanges(fnSuccess, fnError);

Next Steps

OData model的默认绑定模式是单向(one-way)的。双向(two-way)绑定也是可以实现的。参考 OData Write Support.

API Reference:

In this section:
Binding Path Syntax for OData Models
针对OData model的binding path语法,用于获取特定的entry或者collectio。
OData Write Support
SAPUI5 所支持的一些feature.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容