SAPUI5 (09) - 模块化

OpenUI5 的模块化

JavaScript 并没有对模块提供内在支持,下一代版本 (ECMAScript 2015) 将提供,ECMAScript 2015 可能还需要相当长的一段时间才能普及。目前第三方的解决方案主要有两种:

  • CommonJS 模块:比如 node.js 的实现,主要用于服务器端,被设计为同步加载;
  • Asynchronous module definition:异步模块定义,简称 AMD。和 CommonJS 不同,主要被设计为异步加载,比如流行的 requireJS。所谓异步,就是这些模块按需加载,从而提高程序的性能。

而 OpenUI5 对 module(模块)提供内在的支持。在 OpenUI5 中,模块指的是可以在浏览器 (browser) 中加载和执行的 JavaScript 文件。如何将代码组织成不同的模块,并没有一个统一的规则,取决于开发人员的想法。当然,一般来说,同一个模块的内容应该有着共同的主题,而不是随意将代码分割成不同的文件。

如何加载模块

  • jQuery.sap.declare() 声明一个模块,作用是确保模块存在
  • jQuery.sap.require() 同步加载代码的依赖模块
  • sap.ui.define() 定义 JavaScript 模块,异步加载依赖 (dependancies) 的模块, sap.ui.define() 定义的模块具有全局命名空间 (global namespace)。
  • sap.ui.require() 异步加载依赖的模块,不具有全局命名空间。

jQuery.sap.declare

语法:

jQuery.sap.declare(sModuleName, bCreateNamespace?) : void

说明:声明一个模块,以确保模块存在。这个语句必须出现在模块代码(也就是代码文件)的第一句。官方文档已标记为从 v1.52 版本后过时 (depreciated)。

示例一示例代码来源)

// A module declaration, ensures that sap.ui.sample exists
jQuery.sap.declare("sap.ui.sample.MyClass");

// now it is safe to use that namespace object and assign a new member 'MyClass'
// to it
// Note that jQuery.sap.declare does not create the MyClass object.
// So the developer can decide whether it should be a function, an object,
// or an instance of a specific type
sap.ui.sample.MyClass = { key1 : 'value1' };

// the following line guarantees that <code>sap.ui.sample.subspace</code>
// is a valid object
sap.ui.namespace("sap.ui.sample.subspace");

// now one can use this namespace as well
sap.ui.sample.subspace.member1 = 42;
sap.ui.sample.subspace.member2 = 3.141;

示例二

本示例代码说明如何使用jQuery.sap.declarejQuery.sap.require 创建 controller 模块。

    jQuery.sap.declare("example.MyController");
    jQuery.sap.require("sap.ui.core.mvc.Controller");

    "use strict";

    sap.ui.core.mvc.Controller.extend("example.MyController", {
        onInit: function () {
        }
   });

jQuery.sap.require

语法:

 jQuery.sap.require(vModuleName)

确保当前代码继续之前,所指定的模块被加载和执行。如果所需要的模块没有被加载,将会被同步加载和执行,如果已经加载,就忽略。原文

Ensures that the given module is loaded and executed before execution of the current script continues.
By issuing a call to this method, the caller declares a dependency to the listed modules.
Any required and not yet loaded script will be loaded and execute synchronously. Already loaded modules will be skipped.

sap.ui.define()

语法:

sap.ui.define(sModuleName?, aDependencies?, vFactory, bExport?)

定义一个 module,并指定其依赖的模块,所定义的 module 具有全局命名空间 (global namespace)。global namespace 的意思是 module 中的对象在整个 Application 中可见。

函数有四个参数,一般只需要参数 aDependencies 和参数 vFactory

  • aDependencies: 指定依赖的模块
  • vFactory: 定义一个工厂函数。

sap.ui.define() 函数被广泛用于定义 controller。一般建议省略参数 sModuleName,也就是说不要对模块名称进行硬编码,这样对模块的访问较方便。

sap.ui.require()

用于解决 (resolve) 代码的依赖模块。和 jQuery.sap.require() 不同,sap.ui.require() 是异步加载。

使用 sap.ui.define() 定义 controller

刚才介绍了 sap.ui.define() 的语法,下面介绍如何使用 sap.ui.define() 定义controller。我们以上一篇的代码为例,对 controller 的代码进行改写。

改写之前的代码:

sap.ui.controller("suppliers.supplieroverview", {
    onInit: function() {        
        var oModel = sap.ui.model.json.JSONModel('models/suppliers.json');          
        this.getView().setModel(oModel);
    }
}); 

改写之后的代码:

sap.ui.define(["sap/ui/core/mvc/Controller"], 
    function(Controller){
        "use strict";
        
        return Controller.extend("suppliers.supplieroverview", {
            onInit: function() {
                var oModel = sap.ui.model.json.JSONModel();
                oModel.loadData('models/suppliers.json');
                this.getView().setModel(oModel);
            }
        });
    }
);

这个代码可以看作模式化固定固定代码,我们一般只需要基于这个代码片段作三个方面的变更:

  • 增加依赖的模块,放到参数 aDependencies (数据类型为数组)中:sap.ui.define(["sap/ui/core/mvc/Controller", "<other_modules>"],...);

  • 变更 Controler.extend() 第一个参数的模块名

  • Controler.extend() 的第二个参数中编写自己的函数,函数之间用逗号分开。

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

推荐阅读更多精彩内容