SAP UI5 应用元数据文件 manifest.json 的加载和解析原理讲解试读版

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

作者简介

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 框架加载并解析的。