深入学习SAP UI5框架代码系列之二:UI5 控件的渲染器
这是Jerry 2020年的第79篇文章,也是汪子熙公众号总共第261篇原创文章。
系列目录
(1) UI5 module懒加载机制
(2) UI5 控件渲染机制(本文)
(3) HTML原生事件 VS SAP UI5 Semantic事件
(4) UI5控件元数据实现细节
(5) UI5控件的实例数据实现细节
(6) UI5控件数据绑定的实现原理
(7) UI5控件数据绑定的三种模式:One Way,Two Way和OneTime实现原理比较
(8) UI5控件ID的生成逻辑
(9) UI5控件的多语言(国际化,Internationalization,i18n)支持的实现原理
(10) XML视图里的button控件
(11) button控件和它背后的DOM元素
使用Jerry的文章 一个用于SAP UI5学习的脚手架应用,没有任何后台API的依赖,创建一个只包含一个button控件的SAP UI5应用,用Chrome开发者工具里的Elements工具栏查看该button控件的原生HTML代码:
在Jerry的前一篇文章 深入学习SAP UI5框架代码系列之一:UI5 Module的懒加载机制,我们已经了解到UI5 Button Module之一,ButtonRenderer,专门负责将sap.ui.commons.button的实例数据,渲染成原生的HTML代码。
在ButtonRenderer.render函数里设置断点,然后F5刷新页面,断点触发,就可从调用栈观察到RenderManager是如何调用ButtonRenderer执行渲染工作的。
下图画得有些乱,意图是想表达,最终渲染出的HTML源代码里的button标签的各个属性,分别是由ButtonRenderer哪一行代码实现的。
Jerry刚刚做SAP UI5开发时,了解到Renderer机制后,心里有个疑问,SAP UI5怎么知道button控件的渲染器是ButtonRenderer。换言之,SAP UI5控件和其渲染器之间的一一对应关系是如何维护的?
SAP UI5框架里,每类控件都各自维护了一份Metadata(元数据),其中有个getRenderer方法,返回控件对应的渲染器名称。
关于SAP UI5控件元数据,本系列后续文章会介绍。
从调试器里能观察到button控件元数据里,变量_sRendererName维护了button渲染器的名称:sap.ui.commons.ButtonRenderer. 然而,这个变量在何时赋的值?
从下图第42971行能够看出:控件的渲染器满足命名规范:<控件名称>+ "Renderer", 一个简单的字符串拼接操作。
RenderManager在哪些时刻会开启控件的重绘?
让我们对脚手架应用里的button点击事件处理函数稍作修改:每次点击按钮时,调用setText修改button的text属性:
点击按钮,发现ButtonRenderer.render再次被触发。
原因在于,oButton1.setText最终会调用button原型链上的ManagedObject.setProperty方法,该方法内部有一个显式的invalidate调用。
如果忘记了SAP UI5控件的原型链设计,可以查看Jerry之前的文章:深入学习SAP UI5框架代码系列之一:UI5 Module的懒加载机制。
Control.invalidate内部经过计算,会得出当前页面需要重绘的区域,最终调用RenderManager进行重绘。
我们再来简单了解下Angular里的控件绘制。以SAP Spartacus的产品转盘(Product Carousel)显示控件为例: 最畅销的产品共有12款,分多屏显示在转盘控件里,每屏显示若干个产品。通过控件提供的左右箭头,进行屏与屏之间的切换。转盘底部的小红点,表示当前转盘显示的是第几个屏幕的数据。
SAP UI5也能实现类似的复合控件,官方称呼为Custom Control.
Spartacus产品转盘控件的HTML代码表现形式为标签cx-product-carousel,内部重用了另一个自定义标签cx-carousel:
当前显示在屏幕里的产品信息,通过cx-carousel标签里三个class为item active的div标签显示。
这个自定义产品转盘控件通过Spartacus里的Angular Product Carousel Component实现。
Product Carousel Component的layout实现里,将Component自身的属性items$和title$作为输入,传入另一个Component cx-carousel, 让其将属性值title$作为转盘的标题渲染,而转盘的数据源,来自传入的属性items$.
因为cx-carousel是一个可重用控件,除了显示产品转盘外,还可以用于显示其他同类实体的转盘显示,比如折扣转盘,促销活动转盘等等。因此,除了将items$和title$传入cx-carousel之外,还需要告知后者,在转盘内部,以何种布局逻辑显示转盘的每一个元素。
因此,下图第九行通过<ng-template>标签定义了一个id为#carouselItem的模板,将此id一并传入cx-carousel. 这样,转盘控件在运行时,针对转盘数据源items$内存储的每一个产品数据,就会按照此模板定义的布局,进行绘制。
当初Jerry学习Spartacus这个产品转盘的设计时,觉得很亲切,因为其设计思路和SAP UI5 List Binding(Aggregation Binding)是一致的:
https://sapui5.hana.ondemand.com/#/topic/91f057786f4d1014b6dd926db0e91070.html
SAP UI5官网上讲解List Binding的一个例子:
有一个companies JSON数组:
将companies路径传入List控件,完成了数据源的指定,通知List去绘制companies数组里的数据。具体渲染哪些数据?List不知道,需要items子控件来定义,比如子控件的title属性,显示JSON数组的name字段,description属性,显示JSON数组的city字段。List会根据JSON数组里的company节点的个数,动态创建对应数目的items子控件。
这里的SAP UI5 items子控件,扮演的就是本文之前介绍的Spartacus产品转盘控件页面里,用<ng-template>定义出的id为#carouselItem的模板同样的角色。
感谢阅读,本系列下一篇文章:HTML原生事件 VS SAP UI5 Semantic事件。