SAP UI5 OData V4 模型的构造方式

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 两种模型的区别，参考这个链接。

有关更多信息，请参阅：使用 OData V4 模型使用 OData V2 服务

创建 OData V4 模型实例时，需要传入一个 map option 参数，该参数必须至少包含属性 serviceUrl 和同步模式。下面是一个例子：

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：

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") 发送批处理请求。

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 模型。

下面是一个例子：

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

下面是给 OData 模型设置 custom HTTP header 的方式：

 "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 模型应该忽略该请求标头。

原文：https://juejin.cn/post/7100006178280701988