sap.ui.model.odata.v4.ODataModel 是使用 OData V4 服務的模型實現。

SAP Fiori 元素構建塊 (sap.fe.macros) 必須與 SAPUI5 OData V4 模型一起使用，而不是智慧控制元件（sap.ui.comp 庫）或 sap.ui.table.AnalyticalTable（或分析表方案）。不支援 TreeTable 與 SAPUI5 OData V4 模型一起使用。

OData V4 模型主要是為 OData V4 服務設計的。 不過，也可以透過介面卡使用 OData V2 服務。OData V2 和 V4 兩種模型的區別，參考這個[連結](https://sapui5.hana.ondemand.com/sdk/#/topic/abd4d7c7548d4c29ab8364d3904a6d74.html)。

有關更多資訊，請參閱：使用 OData V4 模型使用 OData V2 服務

建立 OData V4 模型例項時，需要傳入一個 `map` option 引數，該引數必須至少包含屬性 serviceUrl 和同步模式。下面是一個例子：

```javascript
sap.ui.define(["sap/ui/model/odata/v4/ODataModel"], function (ODataModel) {
    var oModel = new ODataModel({
        serviceUrl : "/sap/opu/odata4/IWBEP/V4_SAMPLE/default/IWBEP/V4_GW_SAMPLE_BASIC/0001/",
        synchronizationMode : "None"
    });
});
```

也可以指定自定義 query：

```javascript
sap.ui.define(["sap/ui/model/odata/v4/ODataModel"], function (ODataModel) {
    var oModel = new ODataModel({
    	serviceUrl : "/sap/opu/odata4/IWBEP/V4_SAMPLE/default/IWBEP/V4_GW_SAMPLE_BASIC/0001/?customParam=foo", 
    	synchronizationMode : "None"
    });
});
```

OData V4 模型允許開發人員指定是否將請求捆綁並作為批處理請求傳送，以及何時傳送請求。

引數 groupId 指定預設批處理組，預設為“$auto”。 可以使用引數 updateGroupId 為更新請求設定批處理組。 如果不設定此引數，將使用 groupId。

以下程式碼例項化了一個模型，該模型將批處理組 `myAppUpdateGroup` 中的所有更新請求捆綁在一起； 然後可以使用 `oModel.submitBatch("myAppUpdateGroup")` 傳送批處理請求。

```javascript
sap.ui.define(["sap/ui/model/odata/v4/ODataModel"], function (ODataModel) {
    var oModel = new ODataModel({
        serviceUrl : "/sap/opu/odata4/IWBEP/V4_SAMPLE/default/IWBEP/V4_GW_SAMPLE_BASIC/0001/",
        synchronizationMode : "None",
        updateGroupId : "myAppUpdateGroup"
    });
});
```

也可以使用 descriptor 檔案來初始化 OData V4 模型。

下面是一個例子：

![](https://img-blog.csdnimg.cn/img_convert/a93c99026f8c4a26e9fc11a52f1e1bfe.png)

```json
"dataSources": {
			"default": {
				"uri": "https://services.odata.org/TripPinRESTierService/(S(id))/",
				"type": "OData",
				"settings": {
					"odataVersion": "4.0"
				}
			}
		}
```

下面是給 OData 模型設定 custom HTTP header 的方式：

```json
 "sap.ui5" : {
        "models" : {
            "" : {
                "dataSource" : "default",
                "settings" : {
                    "autoExpandSelect" : true,
                    "httpHeaders" : {
                        "custom" : "foo"
                    },
                    "synchronizationMode" : "None",
                     
                }
            }
        }
    }
```

如果服務需要，OData V4 模型會透過“X-CSRF-Token”標頭自動處理安全令牌。 為此，“X-CSRF-Token”標頭以“Fetch”值開頭，並將包含在每個資料請求中。 如果資料響應包含“X-CSRF-Token”標頭，則該新值將被記住並從那時起使用。 如果資料請求失敗，狀態為 403 且“X-CSRF-Token”響應頭值為“required”（不區分大小寫），將獲取新的安全令牌，並自動透明地重複資料請求。

使用“X-CSRF-Token”標頭值“Fetch”透過服務 URL 上的 HEAD 請求獲取新的安全令牌。 如果存在“X-CSRF-Token”的響應頭值，則該響應值被儲存到記憶體中以便下一次使用。

如果服務不需要“X-CSRF-Token”標頭，OData V4 模型應該忽略該請求標頭。

SAP UI5 OData V4 模型的構造方式

相關文章