关于前端:SAP-UI5-应用元数据文件-manifestjson-的加载和解析原理讲解试读版

一套适宜 SAP UI5 初学者循序渐进的学习教程

本专栏打算的文章数在 300 篇左右，到 2022 年 9 月 22 日 为止，目前曾经更新了 133 篇，专栏完成度为 44.3%.

作者简介

Jerry Wang，2007 年从电子科技大学计算机专业硕士毕业后退出 SAP 成都研究院工作至今。Jerry 是 SAP 社区导师，SAP 中国技术大使。在长达 15 年的 SAP 规范产品开发生涯里，Jerry 已经先后参加 SAP Business ByDesign, SAP CRM, SAP Cloud for Customer, SAP S/4HANA, SAP Commerce Cloud(电商云)等规范产品的研发工作。

Jerry 工作中应用 ABAP, Java, JavaScript 和 TypeScript 进行开发, 对包含 SAP UI5 在内的多款 SAP 自研框架有深刻的钻研。

教程目录

• SAP UI5 本地开发环境的搭建
• SAP UI5 利用开发教程之一：Hello World
• SAP UI5 利用开发教程之二：SAP UI5 的疏导过程 Bootstrap
• SAP UI5 利用开发教程之三：开始接触第一个 SAP UI5 控件
• SAP UI5 利用开发教程之四：XML 视图初探
• SAP UI5 利用开发教程之五：视图控制器初探
• SAP UI5 利用开发教程之六 – 理解 SAP UI5 的模块 (Module) 概念
• SAP UI5 利用开发教程之七 – JSON 模型初探
• SAP UI5 利用开发教程之八 – 多语言的反对
• SAP UI5 利用开发教程之九 – 创立第一个 Component
• SAP UI5 利用开发教程之十 – 什么是 SAP UI5 利用的描述符 Descriptor
• SAP UI5 利用开发教程之十一：SAP UI5 容器类控件 Page 和 Panel
• SAP UI5 利用开发教程之十二 – 应用 CSS 类对 UI 进行进一步丑化
• SAP UI5 利用开发教程之十三 – 如何增加自定义 CSS 类
• SAP UI5 利用开发教程之十四 – 嵌入视图的应用形式
• SAP UI5 利用开发教程之十五 – 对话框和 Fragments 的应用形式
• SAP UI5 利用开发教程之十六 – 图标 icon 的应用
• SAP UI5 利用开发教程之十七 – 聚合绑定在 UI5 复合控件中的应用
• SAP UI5 利用开发教程之十八 – SAP UI5 数据绑定语法里的特殊符号，以及相对绑定和绝对绑定概念详解
• SAP UI5 利用开发教程之十九 – SAP UI5 数据类型和简单的数据绑定
• SAP UI5 利用开发教程之二十 – SAP UI5 的表达式绑定用法解说
• SAP UI5 利用开发教程之二十一 – SAP UI5 的自定义格局器 Custom Formatter
• SAP UI5 利用开发教程之二十二 – 过滤器 filter 的开发和应用
• SAP UI5 利用开发教程之二十三 – 列表控件的排序 Sort 和分组 Group
• SAP UI5 利用开发教程之二十四 – 如何应用 OData 数据模型
• SAP UI5 利用开发教程之二十五 – 应用自开发的代理服务器解决 SAP UI5 利用拜访远端 OData 服务的跨域问题
• SAP UI5 利用开发教程之二十六 – OData 服务配合 Mock 服务器的应用步骤详解
• SAP UI5 利用开发教程之二十七 – SAP UI5 利用的单元测试工具 QUnit 介绍
• SAP UI5 利用开发教程之二十八 – SAP UI5 利用的集成测试工具 OPA 介绍
• SAP UI5 利用开发教程之二十九 – SAP UI5 的路由和导航性能介绍
• SAP UI5 利用开发教程之三十 – SAP UI5 的路由过程中进行参数传递
• SAP UI5 利用开发教程之三十一 – SAP UI5 的路由历史和路由回退(Routing back and history)
• SAP UI5 利用开发教程之三十二 – 如何创立一个自定义 SAP UI5 控件
• SAP UI5 利用开发教程之三十三 – SAP UI5 利用的响应式布局个性(Responsiveness)
• SAP UI5 利用开发教程之三十四 – SAP UI5 利用基于设施类型的页面适配性能(Device Adaptation)
• SAP UI5 利用开发教程之三十五 – 如何把本地开发的 SAP UI5 利用部署到 ABAP 服务器上
• SAP UI5 利用开发教程之三十六 – 应用 Chrome 开发者工具 Elements 标签动静批改 CSS 类
• SAP UI5 利用开发教程之三十七 – 应用 Chrome 开发者工具 Console 面板进行元素审查
• SAP UI5 利用开发教程之三十八 – 应用 Chrome 开发者工具查看程序执行出错时的上下文信息
• SAP UI5 利用开发教程之三十九 – SAP UI5 利用呈现白屏的一些常见谬误和分析方法分享
• SAP UI5 利用开发教程之四十 – 如何制作蕴含了 component-preload.js 在内的 SAP UI5 公布版本
• SAP UI5 利用开发教程之四十一 – Chrome 扩大 UI5 Inspector 的离线装置和应用办法
• SAP UI5 利用开发教程之四十二 – SAP UI5 自带的 Diagnostics 诊断工具应用办法介绍
• SAP UI5 利用开发教程之四十三 – SAP UI5 自带的 Support Assistant 工具应用办法介绍
• SAP UI5 利用开发教程之四十四 – Label 和 Input 控件文本没有程度对齐的起因剖析和解决方案
• SAP UI5 利用开发教程之四十五 – 如何在 SAP UI5 利用里应用 jQuery 和原生的 DOM API
• SAP UI5 利用开发教程之四十六 – 应用 Message Manager 实现开箱即用的验证 (Validation) 信息抛出
• SAP UI5 利用开发教程之四十七 – 如何自定义 SAP UI5 字符串类型输出字段的校验逻辑
• SAP UI5 利用开发教程之四十八 – 如何在 SAP UI5 利用里开发条形码扫描性能
• SAP UI5 利用开发教程之四十九 – 如何在桌面电脑端调试运行在手机上的 SAP UI5 利用
• SAP UI5 利用开发教程之五十 – 如何应用 Cordova 将 SAP UI5 利用生成一个能在 Android 手机上安装的混合利用
• SAP UI5 利用开发教程之五十一 – 如何应用 Chrome 调试运行在手机上的 SAP UI5 Cordova 混合利用
• SAP UI5 利用开发教程之五十二 – 如何应用 SAP UI5 的规范控件联合 Cordova 插件调用手机摄像头进行条形码扫描
• SAP UI5 利用开发教程之五十三 – 如何自定义 SAP UI5 数据类型(Data Type)
• SAP UI5 利用开发教程之五十四 – 如何将本地 SAP UI5 利用配置到本地 Fiori Launchpad 中
• SAP UI5 利用开发教程之五十五 – 如何将本地 SAP UI5 利用通过 Node.js Express 部署到公网上
• SAP UI5 利用开发教程之五十六 – SAP UI5 树控件 (tree) 的开发
• SAP UI5 利用开发教程之五十七 – 基于 OData 注解的 Smart Field 应用办法学习
• SAP UI5 利用开发教程之五十八 – 应用工厂办法在运行时动态创建不同类型的列表行我的项目控件
• SAP UI5 利用开发教程之五十九 – 如何在 SAP UI5 利用里显示世界地图
• SAP UI5 利用开发教程之六十 – SAP UI5 地图控件的一些高级用法
• SAP UI5 利用开发教程之六十一 – 在 SAP UI5 利用里绘制甘特图 Gantt Chart
• SAP UI5 利用开发教程之六十二 – 基于 OData V4 的 SAP UI5 表格控件应用办法介绍
• SAP UI5 利用开发教程之六十三 – 基于 OData V4 的本地 Mock Server 实现的深刻介绍
• SAP UI5 利用开发教程之六十四 – 基于 OData V4 的 SAP UI5 表格控件如何实现 filter(过滤) 和 sort(排序)性能
• SAP UI5 利用开发教程之六十五 – 基于 OData V4 的 SAP UI5 表格控件如何实现创立，编辑和保留性能
• SAP UI5 利用开发教程之六十六 – 基于 OData V4 的 SAP UI5 表格控件如何实现删除性能
• SAP UI5 利用开发教程之六十七 – 基于 OData V4 的 SAP UI5 List-Detail(列表 - 明细)布局的实现形式
• SAP UI5 利用开发教程之六十八 – 如何实现 SAP UI5 路由失败时显示自定义的 NOT Found 页面
• SAP UI5 利用开发教程之六十九 – 如何从 SAP UI5 Not Found 页面跳转回到失常的利用页面
• SAP UI5 利用开发教程之七十 – 如何应用按钮控件触发页面路由跳转
• SAP UI5 利用开发教程之七十一 – SAP UI5 页面的嵌套路由
• SAP UI5 利用开发教程之七十二 – SAP UI5 页面路由的动画成果设置
• SAP UI5 利用开发教程之七十三 – 应用自定义 Query 实现 SAP UI5 页面路由的书签性能
• SAP UI5 利用开发教程之七十四 – SAP UI5 利用应用 OData V4 显示 Table 表格数据的一个陷阱
• SAP UI5 利用开发教程之七十五 – 如何采纳 SAP UI5 主从表格的联动技术显示简单表格内容
• SAP UI5 利用开发教程之七十六 – 如何实现 SAP UI5 的 Lazy Loading(提早加载，懒加载)
• SAP UI5 利用开发教程之七十七 – SAP UI5 动静页面路由的高级用法：路由记录 routes 和 target 的一对多关系
• SAP UI5 利用开发教程之七十八 – 如何通过 url 放弃 SAP UI5 搜寻的状态，让其反对书签性能
• SAP UI5 利用开发教程之七十九 – 采纳测试驱动开发理念 (Test Driven Development) 进行 SAP UI5 利用的性能开发(一)
• SAP UI5 利用开发教程之八十 – 采纳测试驱动开发理念 (Test Driven Development) 进行 SAP UI5 利用的性能开发(二)
• SAP UI5 利用开发教程之八十一 – 采纳 OPA5 进行 SAP UI5 集成测试 (Integration Test) 的一个例子
• SAP UI5 利用开发教程之八十二 – 采纳 OPA5 开发反对页面跳转的 SAP UI5 集成测试用例
• SAP UI5 利用开发教程之八十三 – SAP UI5 的自动化测试套件页面的开发步骤介绍
• SAP UI5 利用开发教程之八十四 – 如何指定 SAP UI5 应用程序基于某个特定的版本运行
• SAP UI5 利用开发教程之八十五 – 如何用 OPA5 编写测试用例来测试用户输出文本的性能
• SAP UI5 利用开发教程之八十六 – 入手开发一个最简略的本地 Mock 数据服务器
• SAP UI5 利用开发教程之八十七 – 如何让 SAP UI5 Mock 服务器反对自定义 url 参数
• SAP UI5 利用开发教程之八十八 – SAP UI5 Mock 服务器如何实现自定义 Function Import
• SAP UI5 利用开发教程之八十九 – 如何给 SAP UI5 列表控件削减多个图形界面的过滤器
• SAP UI5 利用开发教程之九十 – 基于 OData V2 的 SAP UI5 List-Detail(列表 - 明细)布局的实现形式
• SAP UI5 利用开发教程之九十一 – 如何应用客户端 JSON 模型构建一个 Master-Detail-Detail 布局中的列表页面
• SAP UI5 利用开发教程之九十二 – 基于 SAP UI5 JSONModel 客户端模型的列表分页显示 (Table Pagination) 前提
• SAP UI5 利用开发教程之九十三 – 基于 JSONModel 数据模型的列表控件显示数据的深刻探讨
• SAP UI5 利用开发教程之九十四 – 基于 JSONModel 数据模型的 SAP UI5 列表控件分页显示数据的残缺解决方案
• SAP UI5 利用开发教程之九十五 – SAP UI5 下拉菜单(Select) 控件的应用形式
• SAP UI5 利用开发教程之九十六 – SAP UI5 列表控件分页显示数据时，如何自定义分页大小
• SAP UI5 利用开发教程之九十七 – 如何应用客户端 JSON 模型构建一个 Master-Detail-Detail 布局中的明细页面
• SAP UI5 利用开发教程之九十八 – 从 viewId 这个属性谈起，聊聊 SAP UI5 的 HTML 源代码生成机制
• SAP UI5 利用开发教程之九十九 – 深入探讨 SAP UI5 本地开发环境里的 package.json 和 ui5.yaml
• SAP UI5 利用开发教程之一百 – 如何批改 SAP UI5 框架的源代码实现，以及应用本地部署的 SAP UI5 SDK
• SAP UI5 利用开发教程之一百零一 – SAP UI5 利用的 Locale 决定机制
• SAP UI5 利用开发教程之一百零二 – SAP UI5 利用的打印 (Print) 性能实现详解
• SAP UI5 利用开发教程之一百零三 – 如何在 SAP UI5 利用中生产第三方库
• SAP UI5 利用开发教程之一百零四 – SAP UI5 表格控件的反对复选 (Multi-Select) 以及如何用代码一次选中多个表格行我的项目
• SAP UI5 利用开发教程之一百零五 – SAP UI5 Master-Detail 布局模式的联动成果实现明细介绍
• SAP UI5 利用开发教程之一百零六 – 如何进步 SAP UI5 利用路由 url 的可读性
• SAP UI5 利用开发教程之一百零七 – SAP UI5 OverflowToolbar 容器控件以及 resize 事件处理的一些细节介绍
• SAP UI5 利用开发教程之一百零八 – SAP UI5 图片显示控件 Avatar 的应用形式介绍
• SAP UI5 利用开发教程之一百零九 – 应用 SAP UI5 FileUploader 控件上传本地文件
• SAP UI5 利用开发教程之一百一十 – SAP UI5 FileUploader 控件深刻介绍 – 为什么须要一个暗藏的 iframe
• SAP UI5 利用开发教程之一百一十一 – SAP UI5 FileUploader 控件实现本地文件上传，接管服务器端的响应时遇到跨域拜访谬误
• SAP UI5 利用开发教程之一百一十二 – 应用自开发的代理服务器解决 SAP UI5 FileUploader 上传文件时遇到的跨域拜访谬误
• SAP UI5 利用开发教程之一百一十三 – 授人以渔 – 如何自行查问任意 SAP UI5 控件属性的文档和技术实现细节
• SAP UI5 利用开发教程之一百一十四 – 如何通过单步调试的形式找到引起 Fiori Launchpad 路由谬误的起因
• SAP UI5 利用开发教程之一百一十五 – 对于将本地 SAP UI5 利用配置到本地 Fiori Launchpad 的技术实现深刻解说
• SAP UI5 利用开发教程之一百一十六 – 在 SAPGUI 里应用 ABAP 报表上传 SAP UI5 利用到 ABAP 服务器
• SAP UI5 利用开发教程之一百一十七 – 本地开发好的 SAP UI5 利用部署到 ABAP 服务器时，中文字符变成乱码的起因剖析和解决方案
• SAP UI5 利用开发教程之一百一十八 – 如何剖析因为 SAP UI5 版本差别带来的问题
• SAP UI5 利用开发教程之一百一十九 – 对于 SAP UI5 Container 控件 aggregation 的深入分析
• SAP UI5 利用开发教程之一百二十 – 如何依据 SAP UI5 框架代码抛出的谬误音讯，反查出是哪一行代码引起的谬误音讯
• SAP UI5 利用开发教程之一百二十一 – 一键部署开箱即用的代理服务器，解决 SAP UI5 利用开发过程中拜访远端 OData 服务的跨域问题
• SAP UI5 利用开发教程之一百二十二 – 在 SAP UI5 利用中应用浏览器原生的 Fetch API 发动网络申请
• SAP UI5 利用开发教程之一百二十三 – 应用 Busy Dialog 动画阻止 SAP UI5 利用按钮短时间内疾速被点击
• SAP UI5 利用开发教程之一百二十四 – 应用函数节流思维防止 SAP UI5 利用里按钮短时间内被高频反复点击
• SAP UI5 利用开发教程之一百二十五 – SAP UI5 进阶 – XML 视图里定义的 UI 控件，运行时实例化的技术细节分析
• SAP UI5 利用开发教程之一百二十六 – SAP UI5 进阶 – JSON 模型字段里的值，显示在最终 UI5 界面上的神秘剖析
• SAP UI5 利用开发教程之一百二十七 – SAP UI5 利用的全局配置(Global Configuration) 的设计和应用
• SAP UI5 利用开发教程之一百二十八 – SAP UI5 智能控件 Smart Controls 的初步意识
• SAP UI5 利用开发教程之一百二十九 – 如何给 SAP UI5 SmartField 增加 Value Help 性能
• SAP UI5 利用开发教程之一百三十 – 如何使 SAP UI5 SmartField 在运行时渲染成超链接的模式并反对跳转
• SAP UI5 利用开发教程之一百三十一 – SAP UI5 Cross Application Navigation (跨利用间跳转)的本地模仿实现
• SAP UI5 利用开发教程之一百三十二 – SAP UI5 Simple Form 控件的应用办法介绍
• SAP UI5 利用开发教程之一百三十三 – SAP UI5 利用元数据文件 manifest.json 的加载和解析原理解说
• SAP UI5 利用开发教程之一百三十四 – 正在写作中 ……

阐明

Jerry 从 2014 年退出 SAP 成都研究院 CRM Fiori 开发团队之后开始接触 SAP UI5，已经在 SAP 社区和 汪子熙 微信公众号上发表过多篇对于 SAP UI5 工作原理和源码解析的文章。

在 Jerry 这篇文章 对 SAP UI5 无所不知的老手，从哪些资料开始学习比拟好？已经提到，Jerry 也是从 SAP UI5 菜鸟一路走过去，深知只有 ABAP 开发背景的开发者，向 SAP UI5 开发畛域转型的不易，因而我在业余时间设计了这份适宜 SAP UI5 不同程度 的学习者的学习教程，把开发一个残缺的 SAP UI5 利用的流程，拆分成若干个步骤，力求每个步骤里，把波及到的知识点都涵盖到。

这些知识点可能不像我的 UI5 源码剖析系列文章那么深刻，但力求做到深入浅出，重要的知识点都配上具体的截图来辅助文字的介绍，便于教程学习者的了解。

本教程每一个步骤的源代码，都寄存在我的 Github 上，别离用文件夹 01，02，03 等等来标识，例如步骤 1 的源代码在这里。

每一个步骤均是前一步骤的根底上，增加了若干新个性。倡议零根底或者对 SAP UI5 知之甚少的 SAP UI5 初学者，依照程序从第一个步骤开始循序渐进地学习，把这些代码下载到本地，配合教程的文字解说，本人入手，以加深了解。

对于曾经 有肯定根底 的 SAP UI5 开发人员，能够通过本文的目录，跳过后面一部分比拟根底的章节，间接筛选对本人工作我的项目无关，或者蕴含某些知识点本人尚未把握的章节来有针对性地学习。

大家如果对教程的每个步骤有任何疑难，欢送在教程对应的步骤文章里给我评论，进行留言。我尽管平时开发工作很忙，然而保障会定期查看大家给我留下的评论，对于外面波及到的技术疑难，我肯定会 抽时间做出解答。

本教程第 9 个步骤，咱们学习了 SAP UI5 里 Component 的用法，其中提到，Component.js 的 metadata 区域即下图第 8 行开始，用于定义这个 Component 的元数据，比方 rootView，指定了该 Component 被加载之后，第一个须要被加载并渲染的 XML 视图名称，在下图例子里的名称为 sap.ui5.walkthrough.view.App.

• SAP UI5 利用开发教程之九 – 创立第一个 Component

这个名称里的 sap.ui5.walkthrough 是本教程始终应用的开发 SAP UI5 利用的命名空间，view.App 的意思是我的项目文件夹里有一个名叫 view 的文件夹，外面有一个 App.view.xml 文件，如下图所示：

这种形式将 Component 的元数据同其业务逻辑，比方 init 等钩子函数的实现搁置在同一处，从设计层面上说没有遵循繁多职责 (Single Responsibility) 和关注点拆散 (Seperation of Concerns) 的准则。从情理上讲，定义 Component rootView，包含本教程后续要介绍的 SAP UI5 路由规定等申明，这些都算是 动态配置，因而能够独自抽取进去，放到一个专门用于保护元数据的 JSON 文件里。

在 SAP UI5 理论我的项目开发中，咱们采取一个名为 manifest.json 的 JSON 文件来保护 SAP UI5 Component 元数据。本教程从步骤 10 开始，也采取了这种正式的实现办法。

如下图所示，之前保护在 Component.js metadata 字段里的元数据，比方 rootView 的定义，现在曾经抽取进去放在 manifest.json 文件里独自定义了。

本步骤余下步骤介绍这个 manifest.json 文件运行时是如何被 SAP UI5 框架加载并解析的。