JavaScript不像其他OO语言有public / private关键字,中要实现私有属性或方法,需要一种特殊的代码结构,称为模块。JavaScript继承与模块里已经简单介绍过如何通过模块实现私有属性隐藏,但由于不是主题,因此介绍的比较简单。本篇详细介绍一下。
例如要定义一个array模块,只暴露出inArray和isArray这两个公共方法。
第一步先为模块声明一个命名空间:
X.namespace('utilities.array');
再返回一个全新的对象,内容可以暂时为空:
X.utilities.array = (function() { return {}; // 返回新对象 }());
第二步为这个字面量对象添加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); X.utilities.array.indexOf(2, [1,2,3]); // 1
最终用部署工具将多个文件一合并就行了,新增的indexOf方法和定义在模块中的其他方法并无二致:
总结
回过头再去想想JavaScript的模块究竟是什么?它是一种代码的组织方式,利用闭包来隐藏属性和方法,只对外暴露出公有属性和方法。