SAP UI5 本地注解文件词汇表内容引用的详细讲解

简介: SAP UI5 本地注解文件词汇表内容引用的详细讲解

本文解释 SAP UI5 本地注解 xml 文件里下列这个片段的语义:


<edmx:Reference Uri="../../catalogservice;v=2/Vocabularies(TechnicalName='%2FIWBEP%2FVOC_UI',Version='0001',SAP__Origin='LOCAL')/$value">
    <edmx:Include Namespace="com.sap.vocabularies.UI.v1" Alias="UI"/>
  </edmx:Reference>

这段代码是 SAP UI5 项目中的一个 XML 片段,它涉及到 OData 元数据文档的引用和命名空间包含。在详细解释这段代码的作用之前,我们需要了解一下 SAP UI5、OData 和元数据的相关概念。


SAP UI5 是一种基于 JavaScript 和 HTML5 的用户界面技术,用于构建企业级应用程序。它提供了丰富的 UI 控件库和强大的 MVC 架构,以支持开发人员创建响应式、易于维护的 Web 应用程序。SAP UI5 项目通常采用 XML 视图 (视图层)、JavaScript 控制器 (控制层) 和 OData 服务 (模型层) 的结构。


OData(Open Data Protocol)是一种开放的、基于 RESTful 的数据访问协议,允许用户从各种数据源(如 SAP、Microsoft、IBM 等)查询和操作数据。OData 使用一组标准 HTTP 动词(如 GET、POST、PUT、DELETE)和特定的 URL 模式来表示资源的操作,同时支持 JSON 和 XML 格式的数据交换。


元数据是描述数据的数据。在 OData 中,元数据用于定义服务模型的结构、实体类型、关联、函数和操作等信息。元数据通常以 XML 格式表示,并通过 $metadata 终结点提供。客户端应用程序通过解析元数据来理解服务的结构和功能,从而实现动态地与服务交互。


现在我们来解释这段代码的作用。这个 XML 片段定义了一个 OData 元数据文档的引用,用于在 SAP UI5 项目中引入一个外部的词汇表(Vocabulary)。词汇表是一种元数据扩展机制,允许开发人员为 OData 服务添加语义标注,以提供额外的信息和功能。


这段代码的结构如下:


  1. <edmx:Reference> 元素定义了一个 OData 元数据文档的引用。它包含一个 Uri 属性,指向外部词汇表的元数据文件。这个 URL 由三部分组成:


  • ../../catalogservice;v=2: 一个相对路径,指向 OData 服务的根 URL。v=2 表示服务的版本。


  • /Vocabularies: 一个终结点,表示 OData 服务中的词汇表集合。


  • (TechnicalName='%2FIWBEP%2FVOC_UI',Version='0001',SAP__Origin='LOCAL')/$value: 一个过滤表达式,用于指定词汇表的技术名称、版本和来源。$value 表示返回元数据文件的内容。


首先,该片段以 <edmx:Reference> 标签开始,指示它是一个引用的元数据片段。<edmx:Reference> 标签的 Uri 属性定义了要引用的元数据的位置和详细信息。


在这个例子中,Uri 属性的值是 ../../catalogservice;v=2/Vocabularies(TechnicalName='%2FIWBEP%2FVOC_UI',Version='0001',SAP__Origin='LOCAL')/$value让我们对这个值进行分解和解释。


  • ../../catalogservice;v=2:这部分表示引用的目标 OData 服务的位置。../.. 表示返回到上一级目录两次,然后进入名为 catalogservice 的文件夹(或服务)../../catalogservice;v=2:这部分表示引用的目标 OData 服务的位置。../.. 表示返回到上一级目录两次,然后进入名为 catalogservice 的文件夹(或服务)


  • Vocabularies(TechnicalName='%2FIWBEP%2FVOC_UI',Version='0001',SAP__Origin='LOCAL'):这部分指定了要引用的元数据词汇表的详细信息。Vocabularies 表示引用的是词汇表。TechnicalName='%2FIWBEP%2FVOC_UI' 表示词汇表的技术名称为 %2FIWBEP%2FVOC_UI%2F 是 URL 编码中斜杠字符的编码表示。Version='0001' 表示词汇表的版本号为 0001SAP__Origin='LOCAL' 表示词汇表的来源为本地(LOCAL)。


  • /$value:这部分指定要引用的元数据的具体内容,而不是仅仅引用元数据的引用。$value 表示引用元数据内容而不是引用元数据本身。


接下来,<edmx:Reference> 标签的内部包含了一个或多个 <edmx:Include> 标签。在这个例子中,只有一个 <edmx:Include> 标签。


<edmx:Include> 标签用于指定引用的元数据的命名空间和别名。在这个例子中,<edmx:Include> 标签的 Namespace 属性值为 com.sap.vocabularies.UI.v1,表示引用的元数据属于 com.sap.vocabularies.UI.v1 命名空间。Alias 属性值为 UI,表示为该命名空间定义了别名 UI,以便在后续的代码中使用别名来引用该命名空间。


总结一下,这个 XML 片段的作用是引用一个 OData 服务的元数据和词汇表。它通过指定元数据的位置、版本号以及词汇表的技术名称、版本号和来源来定位和获取正确的元数据和词汇表内容。通过为元数据的命名空间定义别名,它还方便了在后续的代码中引用这些命名空间。


相关文章
|
5月前
|
前端开发 搜索推荐 开发者
SAP UI5 sap.m.Column 控件的 minScreenWidth 属性介绍
SAP UI5 sap.m.Column 控件的 minScreenWidth 属性介绍
|
5月前
|
JavaScript 前端开发 开发者
SAP UI5 控件 sap.m.ListBase 的 inset 属性的作用介绍
SAP UI5 控件 sap.m.ListBase 的 inset 属性的作用介绍
|
5月前
|
Web App开发 数据采集 前端开发
纯技术讨论:如何让 SAP UI5 应用无法被别人在浏览器里调试 - 这种做法不推荐试读版
纯技术讨论:如何让 SAP UI5 应用无法被别人在浏览器里调试 - 这种做法不推荐试读版
|
5月前
|
XML 存储 数据格式
SAP UI5 控件 customData 属性的应用介绍
SAP UI5 控件 customData 属性的应用介绍
|
5月前
|
前端开发 JavaScript API
SAP UI5 sap.ui.require.toUrl 的作用介绍
SAP UI5 sap.ui.require.toUrl 的作用介绍
|
5月前
|
搜索推荐
如何让 SAP UI5 Smart Table 支持多项选择(Multiple-Selection)试读版
如何让 SAP UI5 Smart Table 支持多项选择(Multiple-Selection)试读版
使用 SAP UI5 Event Bus 机制,修复 SAP UI5 分页显示数据的一个 bug 试读版
使用 SAP UI5 Event Bus 机制,修复 SAP UI5 分页显示数据的一个 bug 试读版
|
5月前
|
Web App开发 前端开发 JavaScript
乱花渐欲迷人眼 - 让 SAP UI5 应用的日志输出不再素面朝天
乱花渐欲迷人眼 - 让 SAP UI5 应用的日志输出不再素面朝天
|
5月前
|
Web App开发 JSON JavaScript
SAP UI5 应用程序小技巧 - 一键将 JSON 对象导出成本地 json 文件
SAP UI5 应用程序小技巧 - 一键将 JSON 对象导出成本地 json 文件
|
5月前
|
XML 数据处理 数据格式
什么是 SAP UI5 XML Templating 技术
什么是 SAP UI5 XML Templating 技术
下一篇
无影云桌面