SAPUI5 (20) - 在 Component 中封装启动代码

本篇对上篇的代码进行重构。在 SAP Fiori 中 app 并不是通过 index.html 启动的,而是通过 Component 启动,因为 SAP Launchpad 包含多个 app。所以我们学习 OpenUI5 也应该熟悉这种模式。Component 是 OpenUI5 的一种组织代码结构的方式。

第一次重构,代码的项目文件结构如下:

在 Component 中编写启动代码

我们先来看 Component.js 文件的内容:

sap.ui.define([
        "sap/ui/core/UIComponent",
        "sap/ui/model/json/JSONModel"
    ], 
        
    function(UIComponent, JSONModel){
        return UIComponent.extend("webapp.Component", {         
            createContent: function() {
                UIComponent.prototype.createContent.apply(this, arguments);
                
                // load application data
                var oModel = new sap.ui.model.json.JSONModel();
                oModel.loadData("webapp/service/data.json");
                this.setModel(oModel);
                
                // app view(root view)
                var oAppView = sap.ui.view("appView", {
                    type: sap.ui.core.mvc.ViewType.XML,
                    viewName: "webapp.view.App"
                })
                
                oApp = oAppView.byId("app");
                return oAppView;                
            }
        });
    }

);

代码说明

  • Component.js 这个文件名不能更改,但位置可以设定。在Component.js文件中,webapp.Component 类从sap.ui.core.UIComponent 类扩展,并且改写了 createContent 方法。

  • 接下来的代码在之前的项目代码 index.html 中常见,完成加载 Application data,设置 webapp.component 这个组件的 Model:

// load application data
var oModel = new sap.ui.model.json.JSONModel();
oModel.loadData("webapp/service/data.json");
this.setModel(oModel);
  • 定义一个 Root View,或者叫做 Application View:
var oAppView = sap.ui.view("appView", {
    type: sap.ui.core.mvc.ViewType.XML,
    viewName: "webapp.view.App"
})
  • 定义一个全局变量 oApp :
oApp = oAppView.byId("app");
return oAppView;           

之前代码中, oApp 通过创建 new sap.m.App() 对象实例来实现,本次的示例代码把它放在 App View 中进行申明,一会我们再来看 App View 的代码。由于在 App View 中申明 app,所以在这里通过oAppView.byId("app")来获取全局的 Application 对象。

简化 index.html

重构后 sap.m.App 在 App View 中声明,Application Data 和 Root View 的代码移到 Component.js 文件中,所以 index.html 中的代码大大减少,只需要定义一个 sap.ui.core.ComponentContainer 对象,在 ComponentContainer 中包括刚刚定义的 Component 对象。index.html 代码如下:

<!DOCTYPE HTML>
<html>
    <head>
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta http-equiv='Content-Type' content='text/html;charset=UTF-8'/>

        <script src="resources/sap-ui-core.js"
                id="sap-ui-bootstrap"
                data-sap-ui-libs="sap.m"
                data-sap-ui-preload="async"
                data-sap-ui-xx-bindingSyntax="complex"
                data-sap-ui-resourceroots = '{"webapp": "./webapp/"}'
                data-sap-ui-theme="sap_bluecrystal">
        </script>

        <script>
        
            var oApp;
            
            sap.ui.getCore().attachInit(function(){
                sap.ui.require([
                        "sap/ui/core/ComponentContainer",
                        "webapp/Component"
                    ], 
                    
                    function(ComponentContainer, Component){
                        new ComponentContainer({
                            height: "100%",
                            component: new Component({
                                id: "mvcAppComponent"
                            })
                        }).placeAt("content");
                    }
                );
            });
            
        </script>

    </head>
    <body class="sapUiBody" role="application">
        <div id="content" class="sapUiResponsiveMargin"></div>
    </body>
</html>

ComponentContainer 实例化的 component 参数指定容器所包含的 Component ,也可也使用 name 参数,name 根据文件的相对位置来指定所包含的 Component 对象。比如:name: "webapp",index.html` 中

data-sap-ui-resourceroots = '{"webapp": "./webapp/"}

指定 webapp 为当前文件夹下的 webapp 文件夹,OpenUI5 就在这个文件夹下查找 Component.js 文件。

App view 内嵌 Master View 和 Detail View

之前是在 index.html 中实例化 Master View 和 Detail View,并且将 View 包含在 app 的 pages 中。代码模式如下:

var masterView = sap.ui.xmlview("masterView", {...});
var detailView= sap.ui.xmlview("detailView", {...});

现在变为 Master View 和 Detail View 在 App.view.xml文件中申明:

<core:View xmlns:core="sap.ui.core" 
           xmlns:mvc="sap.ui.core.mvc" xmlns="sap.m"
        xmlns:html="http://www.w3.org/1999/xhtml">
        
    <App id="app">
        <pages>
            <mvc:XMLView id="masterView" viewName="webapp.view.Master" />
            <mvc:XMLView id="detailView" viewName="webapp.view.Detail" />
        </pages>
    </App>
    
</core:View>

这种 View 中内嵌其它 View ,对后面通过代码获取 View 的 id 有影响,OpenUI5 在View 的 id 前自动加上父 View 的 id。比如 Master View 的id变成appView--masterView,Detail View 的 id 变为 appView--detailViewappView是 在 Component 中定义Root View时指定的 id。在 Controller 中根据 View 的 id 导航的时候,需要用到这些 id。

Master Controller 和 Detail Controller 的代码重构

Master View 和 Detail View 的代码没有变化,Detail Controller 的代码也没有变化。Master Controller 因为需要能从 Master View 跳转到 Detail View,并且在跳转的时候用到 View 的 id,所以代码中 pageId 的代码有变化:

sap.ui.define([
        "sap/ui/core/mvc/Controller"
    ],      
        
    function(Controller){
        "use strict";
        
         return Controller.extend("webapp.controller.Master", {
            onListPress: function(oEvent){
                // 跳转到detail view
                var sPageId = oApp.getPages()[1].getId();
                oApp.to(sPageId);
                
                // 设置detail page的bindingContext
                var oContext = oEvent.getSource().getBindingContext();
                var oDetailPage = oApp.getPage(sPageId);
                oDetailPage.setBindingContext(oContext);
            }
         });    
    }
);

我们使用相对引用的方式,getPages() 获取 app 的页面,然后通过oApp.getPages()[1].getId()获取 Detail Page的 id 。

在 Component 中实现相关配置

很多参数都可以配置在 Component 中,我们将 Root View 和 Service URL 配置在 Component 的 metadata 中。metadata 也可以放到专门的配置文件中, 这个配置 OpenUI5 叫 Application descriptor。

sap.ui.define([
        "sap/ui/core/UIComponent",
        "sap/ui/model/json/JSONModel"
    ], 
        
    function(UIComponent, JSONModel){
        return UIComponent.extend("webapp.Component", { 
            // meta-data
            metadata: {
                "rootView": "webapp.view.App",
                "config": {
                    "serviceUrl": "webapp/service/data.json"
                }
            },
            
            createContent: function() {
                // application data
                var oModel = new JSONModel(this.getMetadata().getConfig().serviceUrl);
                this.setModel(oModel);
                
                // root view
                var oRootView = UIComponent.prototype.createContent.apply(this, arguments);
                
                // application
                oApp = oRootView.byId("app");
                
                return oRootView;               
            }
        });
    }

);

代码说明:

  • Component metadata 配置部分的 rootView,表示程序启动时的第一个View。代码中使用下面的语句获取。
var oRootView = UIComponent.prototype.createContent.apply(this, arguments);
  • json 数据在 metadata 配置的 config->serviceUrl 中,然后代码中使用下面的语句获取:
var oModel = new JSONModel(this.getMetadata().getConfig().serviceUrl);

index.html 添加 Shell 组件

为了更加美观,一般 OpenUI5 的 App 都是放置在sap.m.Shell中,这样,页面两边都有预留空间,App 位于中间,类似一个信封。不错,OpenUI5 就是将有 Shell 的页面叫 letterboxing - 信封。

<!DOCTYPE HTML>
<html>
    <head>
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta http-equiv='Content-Type' content='text/html;charset=UTF-8'/>

        <script src="resources/sap-ui-core.js"
                id="sap-ui-bootstrap"
                data-sap-ui-libs="sap.m"
                data-sap-ui-preload="async"
                data-sap-ui-xx-bindingSyntax="complex"
                data-sap-ui-resourceroots = '{"webapp": "./webapp/"}'
                data-sap-ui-theme="sap_bluecrystal">
        </script>

        <script>
        
            var oApp;
            
            sap.ui.getCore().attachInit(function(){
                sap.ui.require([
                        "sap/m/Shell",
                        "sap/ui/core/ComponentContainer",
                        "webapp/Component"
                    ], 
                    
                    function(Shell, ComponentContainer, Component){
                        new Shell({
                            app: new ComponentContainer({
                                    height: "100%",
                                    component: new Component({
                                        id: "mvcAppComponent"
                                    })
                                })
                        }).placeAt("content");
                    }
                );
            });
            
        </script>

    </head>
    <body class="sapUiBody" role="application">
        <div id="content" class="sapUiResponsiveMargin"></div>
    </body>
</html>

页面效果:

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,902评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,037评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,978评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,867评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,763评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,104评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,565评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,236评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,379评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,313评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,363评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,034评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,637评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,719评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,952评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,371评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,948评论 2 341

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,277评论 25 707
  • 前面我们实现了基于组件的多页面程序,这个程序还有两个主要的缺点: 1)存在全局变量oApp (sap.m.App)...
    Stone0823阅读 3,215评论 0 8
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,566评论 18 139
  • 白澍,你知道吗……你的粉丝都是傻树芽,她们用尽了所有力气来爱你,用尽所有力量把你留在我们的世界里。就那么几百号人...
    白澍阅读 312评论 0 3
  • 1 第一次进咱班教室时在班门口愣了几秒,因为报道比较晚,班里已经挤满人而且同学们都找到了各自的座位,班...
    心禾酱阅读 146评论 0 0