JavaScript模块

JavaScript不像其他OO语言有public / private关键字,小应用中无所谓,但大工程里,如果所有属性或方法均为公有,即无必要,也维护困难。JavaScript中要实现私有属性或方法的封装,需要一种特殊的代码结构,称为模块。

之前的JavaScript继承里已经蜻蜓点水般介绍过如何通过模块实现私有属性隐藏,但由于不是主题,因此介绍的比较简单。下面详细介绍一下。

例如要定义一个array模块,只暴露出inArray和isArray这两个公共方法。

第一步先为模块声明一个命名空间

X.namespace('utilities.array');

再返回一个字面量对象,内容可以暂时为空:

X.utilities.array = (function() {
  return {
    //todo...
  };
}());

第二步为这个字面量对象添加inArray和isArray这两个公共方法,并用()包起来立即执行:

X.utilities.array = (function () {
  return {
    inArray: function () { },
    isArray: function () { }
  };
}());

立即执行的目的是让每个模块都有各自独立的作用域,每个模块文件内的全局变量,都会变成了匿名函数内部的局部变量。这样就完全不必操心是否有变量,函数等是否重名的问题,实现了模块的隔离。每个模块都可以独立开发了。

第三步为函数添加私有属性和方法,并实现字面量对象里的公共方法:

X.utilities.array = (function () {
    //如果依赖其他模块,也可以添加一下
    var uobj = X.utilities.object,
        ulang = X.utilities.lang,

        //私有属性
        array_string = "[object Array]",
        ops = Object.prototype.toString;

        //私有方法
        //...

    //公共API 
    return {
        inArray: function (needle, haystack) {
            for (var i=0, max=haystack.length; i<max; i+=1) {
                if (haystack[i] === needle) {
                    return true;
                }
            }
        },
        isArray: function (a) {
            return ops.call(a) === array_string;
        }
    };
}());

console.log(X.utilities.array.array_string);        //undefined,外部无法访问
console.log(X.utilities.array.isArray([1,2,3]));    //true
console.log(X.utilities.array.isArray(1));          //false

由于函数是立即执行函数,所以能封装私有属性和方法。定义在X.utilities.array模块的return语句外的属性和方法都是私有的,外部是无法访问的。需要被暴露给外部的属性和方法,统一被加到了对象字面量里,最后return出这个对象字面量。

上面这种组织代码的方式就是模块的雏形,被广泛使用。你可以用这种方式组织自己的代码,实现封装。

因为上面return语句里集中了大量代码,看起来比较吃力。因此还有一个变种,将大段代码放入私有方法内,return语句只做映射:

X.utilities.array = (function () {      
    //私有属性
    var array_string = "[object Array]",
        ops = Object.prototype.toString,

        //私有方法
        inArray = function (needle, haystack) {
            for (var i=0, max=haystack.length; i<max; i+=1) {
                if (haystack[i] === needle) {
                    return true;
                }
            }
        },
        isArray = function (a) {
            return ops.call(a) === array_string;
        };

    //公共对象
    return {
        inArray: inArray,
        isArray: isArray
    };
}());

console.log(X.utilities.array.array_string);         //undefined
console.log(X.utilities.array.inArray(2, [1,2,3]));  //true
console.log(X.utilities.array.isArray([1,2,3]));     //true

这样该模块究竟提供了哪些公共属性和方法,看一眼return语句就一目了然了。两种代码的组织方式并没有什么本质上的区别,你可以随自己的需求来选用。

你还可以给模块传递任意参数,通常参数都是全局变量,导入的全局变量会成为模块的局部变量,加速内部对全局符号的解析速度。例如X.utilities.array模块内部如果需要用到jQuery库和YUI库,可以这样:

X.utilities.array = (function ($, Y) {
  ...
}(jQuery, YAHOO));

这样一个X.utilities.array模块就定义好了。当然实际项目中array没必要也不推荐自定义,直接用原生的Array即可,这里只是举个例子而已。重要的是了解模块的这种代码组织方式。

实际项目中一个模块可能就是一个文件,但如果模块比较大时,为了开发的方便,也常会拆分成几个小文件。例如上面的X.utilities.array写在一个文件里,现在想在新文件里为该模块新增一个indexOf公有方法,你可以:

X.utilities.array = (function (mod){
  mod.indexOf = function (needle, haystack) {
    for (var i=0, max=haystack.length; i<max; i+=1) {
      if (haystack[i] === needle) {
        return i;
      }
    }
    return -1;
  };
  return mod;
})(X.utilities.array);

console.log(X.utilities.array.indexOf(2, [1,2,3]));  //1

最终用部署工具将多个文件一合并就行了,新增的indexOf方法和定义在模块中的其他方法并无二致:


总结

回过头再去想想JavaScript的模块究竟是什么?它是一种代码的组织方式,用函数和闭包来构造模块。模块隐藏了私有的属性和方法,对外暴露出公有属性和方法。

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

推荐阅读更多精彩内容