该文章是直接翻译国外一篇文章,关于JS的Module模式的深度解析(这也是JS设计模式中的一种模式)。
都是基于原文处理的,其他的都是直接进行翻译可能有些生硬,所以为了行文方便,就做了一些简单的本地化处理。
如果想直接根据原文学习,可以忽略此文。
同时该篇文章也算是,前端模块化的番外篇。(这篇文章也在准备当中,敬请期待)
模块模式是一种常用的代码模式。它简单实用,但是也有一些“优雅”的使用方式,没有得到开发者的重视。所以,这篇文章,带大家来重温一下基层的用法,并且介绍一些比较优雅的使用方式。
译者注:
模块模式,其实就是JS实现模块化的最基础的地基。例如AMD,UMD,COMMONJS,还有ES6的module都是基于这个实现方式(构建一个IIFE,{独立作用域})来实现模块化编程
还有一点就是ES6中class
是ES5构造函数的语法糖。ES5在自定义一个类,需要构造函数+构造函数.prototype来实现,但是为什么ES6的class
却可以将prototype中的方法放在class
的代码范围中。(也就是说,class
一次性将构造函数和prototype都构建了。)如果想了解Class如何优雅的进行“糖化”
基础用法
我们来简单回顾一下什么是module pattern
。如果你对基础知识比较熟悉的话,可以跳过这部分,直接翻阅"高级用法"。
匿名作用域(Anonymous Closures)
匿名作用域是实现模块化最基本的结构,也是在JS的语言范畴中,最好的实现方式。我们简单的构建了一个匿名函数,并且立马执行该匿名函数。在该函数中的所有代码都独立的运行在指定作用域中。并且该作用域中定义的私有变量和状态值贯穿项目的所有周期。
(function () {
//在该作用域中的所有变量和函数都挂载在了全局变量上(都是全局变量)
}());
Notice:
在匿名函数外包还有一个
()
。这是必须要的。
因为在JS中如果一个语句是以function
开头,JS引擎会认为这是一个函数声明。而通过()
包裹之后,就变成了函数表达式。
导入全局变量
JS语法中,存在一个很有意思的特性:隐含的全局变量。
当访问一个变量名,JS编译器就会循着作用域链(
scope chain
)去查找是否在指定的结点中存在与之相同的变量名。如果在整条作用域链中都没有发现该变量名,这个变量就会被自动赋给全局变量。
当编译器对一个原本不存在的变量进行赋值,该变量也会自动挂载在全局变量。
针对隐含的全局变量这个特性,在一个匿名作用域中使用/创建一个变量是非常简单的。而这恰恰让代码变的维护性下降。
幸运的是,匿名函数为我们提供了一种解决方案。通过将全局变量作为参数传入到匿名函数中,直接对传入的全局变量赋值和查值。这样就比隐含的全局变量通过作用域链查找和赋值变量的方式更快,更简洁。
(function ($, YAHOO) {
//在该作用域中,就能访问jQuery, YAHOO的实例了
}(jQuery, YAHOO));
模块导出
有些应用场景中,不仅仅是用到全局变量,而且还想声明一个全局变量。我们可以通过在匿名函数中return
一个对象,来实现声明全局变量。
var MODULE = (function () {
var my = {},
privateVariable = 1;
function privateMethod() {
// ...
}
my.moduleProperty = 1;
my.moduleMethod = function () {
// ...
};
return my;
}());
Notice:
我们声明了一个名为
MODULE
的全局模块,该模块拥有两个公共(public)属性:
一个方法(MODULE.moduleMethod
)、一个变量(MODULE.moduleProperty
)
并且该模块通过匿名函数实现了私有的(private)变量和方法。
高级用法
尽管上面的简单用法,能满足我们90%的模块需求,但是我们可以基于普通用法,来构建更加高级的用法
追加属性和方法(Augmentation)
针对上述模块实现而言,存在一个弊端/限制,就是一个文件定义整个模块的实现。 针对大型项目而言,代码的布局的高内聚,低耦合很重要。所以,有些特定的实现是不需要都堆砌在一个文件中的。
而argment modules
这种代码布局方式就应运而生。
- 导入指定模块
- 在指定模块中新增属性
- 导出修饰之后的模块
var MODULE = (function (my) {
//基于MODULE的基础上,新增指定方法/属性
my.anotherMethod = function () {
};
return my;
}(MODULE));
在该匿名函数被执行之后,原先的module
就会新增了一个新的公共方法(MODULE.anotherMethod)。该文件也可以存在自己的私有方法等。
宽松的扩展(Loose Augmentation)
我们上述的例子中,要求我们先构建一个初始模块,然后进行追加操作。其实这种处理方式不是必要的。因为,<script>
标签可以实现异步加载,这样的话,就不存在模块初始化的问题,可能追加的模块先加载。这样就不会存在初始模块这个概念。
所以,我们需要一种定义模块的方式,而这种方式是不关心各个模块的加载顺序。
Talk is cheap ,show you the code:
var MODULE = (function (my) {
// 随意新增属性
return my;
}(MODULE || {}));
Notice:
1.在该中模式下,
var
的声明是必要的。
2. 导入的模块是不需要考虑先前是否存在。也就意味着,使用Loose Augmentation
构建的模块,在调用的时候,可以利用类似于LABjs
的工具库,实现平行加载。
严谨的扩展(Tight Augmentation)
虽然利用loose augmentation
构建的模块很好,但是也对模块新增了一些约束。其中比较重要的就是,1.你无法安全的对模块中的属性和方法进行重写。2.在初始化的时候,是无法使用在另外一个文件中定义的模块的属性。
而Tight augmentation
隐藏了加载顺序。但是允许进行方法和属性的重载(override)
我们将原先实现过的MODULE
作为参数传入到函数中
var MODULE = (function (my) {
var old_moduleMethod = my.moduleMethod;
//进行方法的重新,但是可以通过old_moduleMethod访问原来的方法
my.moduleMethod = function () {
// ...
};
return my;
}(MODULE));
上述代码中,我们即对MODULE.moduleMethod
进行重写,同时保持了对原始方法的引用(如果有必要的话)。
复制和继承(Cloning and Inheritance)
var MODULE_TWO = (function (old) {
var my = {},
key;
for (key in old) {
if (old.hasOwnProperty(key)) {
my[key] = old[key];
}
}
var super_moduleMethod = old.moduleMethod;
my.moduleMethod = function () {
//重新复制之后的方法,通过super_moduleMethod来访问原始方法
};
return my;
}(MODULE));
该实现方式,可能是最灵活的选择。
跨文件的私有变量(Cross-File Private State)
将一个模块分成很多文件组成最大的限制就是:每个文件拥有自己的私有变量,同时这些私有变量无法跨文件访问。这样就无法进行单一模块的拆分处理。
但是,利用loosely augmented module
可以很好的解决这个问题:
var MODULE = (function (my) {
var _private = my._private = my._private || {},
_seal = my._seal = my._seal || function () {
delete my._private;
delete my._seal;
delete my._unseal;
},
_unseal = my._unseal = my._unseal || function () {
my._private = _private;
my._seal = _seal;
my._unseal = _unseal;
};
// permanent access to _private, _seal, and _unseal
return my;
}(MODULE || {}));
任何文件都可以在局部变量(_private
)上设置属性,并且在其他文件中可以立马范围到。
一旦该模块加载完成,程序调用MODULE._seal()
,用于阻止外部文件访问该模块的内部属性(internal _private
)。
如果需要对该模块进行扩展,则在应用程序的生命周期中任何文件下的内部方法中在新模块加载之前调用_unseal()
。在扩展之后,继续调用_seal()
用于私有属性的加密处理。
子模块(Sub-modules)
我们上述介绍的高级模块都很简单。同时也有很多构建一个子模块的方式。
MODULE.sub = (function () {
var my = {};
// ...
return my;
}());
总结
大多数的高级模式都可以互相组合用于构建一个更加方便的模式。如果想要构建一个比较复杂的程序。可以尝试loose augmentation、private state、 和 sub-modules的组合。