专栏名称: JavaScript
面向JavaScript爱好人员提供:前端最新资讯、原创内容、JavaScript、HTML5、Ajax、jQuery、Node.js等一系列教程和经验分享。
目录
相关文章推荐
51好读  ›  专栏  ›  JavaScript

Javascript模块化编程:模块的写法和规范使用模块

JavaScript  · 公众号  · Javascript  · 2017-02-21 10:55

正文

转自:www.ruanyifeng.com/blog/2012/10/asynchronous_module_definition.html

随着网站逐渐变成”互联网应用程序”,嵌入网页的Java代码越来越庞大,越来越复杂。 
网页越来越像桌面程序,需要一个团队分工协作、进度管理、单元测试等等……开发者不得不使用软件工程的方法,管理网页的业务逻辑。 
Java模块化编程,已经成为一个迫切的需求。理想情况下,开发者只需要实现核心的业务逻辑,其他都可以加载别人已经写好的模块。 
但是,Java不是一种模块化编程语言,它不支持”类”(class),更遑论”模块”(module)了。(正在制定中的ECMA标准第六版,将正式支持”类”和”模块”,但还需要很长时间才能投入实用。) 
Java社区做了很多努力,在现有的运行环境中,实现”模块”的效果。本文总结了当前"Java模块化编程"的最佳实践,说明如何投入实用。虽然这不是初级教程,但是只要稍稍了解Java的基本语法,就能看懂。 
  
一、原始写法 
模块就是实现特定功能的一组方法。 
只要把不同的函数(以及记录状态的变量)简单地放在一起,就算是一个模块。

function m1(){

  //...

}

function m2(){

  //...

}

上面的函数m1()和m2(),组成一个模块。使用的时候,直接调用就行了。 
这种做法的缺点很明显:”污染”了全局变量,无法保证不与其他模块发生变量名冲突,而且模块成员之间看不出直接关系。 
二、对象写法 
为了解决上面的缺点,可以把模块写成一个对象,所有的模块成员都放到这个对象里面。

var module1 = new Object({

  _count : 0,

  m1 : function (){

    //...

    },

  m2 : function (){

    //...

  }

});

上面的函数m1()和m2(),都封装在module1对象里。使用的时候,就是调用这个对象的属性。

module1.m1();

但是,这样的写法会暴露所有模块成员,内部状态可以被外部改写。比如,外部代码可以直接改变内部计数器的值。

module1._count = 5;

三、立即执行函数写法 
使用”立即执行函数”(Immediately-Invoked Function Expression,IIFE),可以达到不暴露私有成员的目的。

var module1 = (function(){

  var _count = 0;

  var m1 = function(){

    //...

  };

  var m2 = function(){

    //...

  };

  return {

    m1 : m1,

    m2 : m2

  };

})();

使用上面的写法,外部代码无法读取内部的_count变量。

console.info(module1._count); //undefined

module1就是Javascript模块的基本写法。下面,再对这种写法进行加工。 
四、放大模式 
如果一个模块很大,必须分成几个部分,或者一个模块需要继承另一个模块,这时就有必要采用”放大模式”(augmentation)。

var module1 = (function (mod){

  mod.m3 = function () {

    //...

  };

  return mod;

})(module1);

上面的代码为module1模块添加了一个新方法m3(),然后返回新的module1模块。 
五、宽放大模式(Loose augmentation) 
在浏览器环境中,模块的各个部分通常都是从网上获取的,有时无法知道哪个部分会先加载。如果采用上一节的写法,第一个执行的部分有可能加载一个不存在空对象,这时就要采用”宽放大模式”。

var module1 = ( function (mod){

  //...

  return mod;

})(window.module1 || {});

与”放大模式”相比,"宽放大模式"就是”立即执行函数”的参数可以是空对象。 
六、输入全局变量 
独立性是模块的重要特点,模块内部最好不与程序的其他部分直接交互。 
为了在模块内部调用全局变量,必须显式地将其他变量输入模块。

var module1 = (function ($, YAHOO) {

  //...

})(jQuery, YAHOO);

七、模块的规范 
先想一想,为什么模块很重要? 
因为有了模块,我们就可以更方便地使用别人的代码,想要什么功能,就加载什么模块。 
但是,这样做有一个前提,那就是大家必须以同样的方式编写模块,否则你有你的写法,我有我的写法,岂不是乱了套!考虑到Javascript模块现在还没有官方规范,这一点就更重要了。 
目前,通行的Javascript模块规范共有两种:CommonJS和AMD。我主要介绍AMD,但是要先从CommonJS讲起。 
八、CommonJS 
2009年,美国程序员Ryan Dahl创造了node.js项目,将javascript语言用于服务器端编程。 
这标志”Javascript模块化编程”正式诞生。因为老实说,在浏览器环境下,没有模块也不是特别大的问题,毕竟网页程序的复杂性有限;但是在服务器端,一定要有模块,与操作系统和其他应用程序互动,否则根本没法编程。 
node.js的模块系统,就是参照CommonJS规范实现的。在CommonJS中,有一个全局性方法require(),用于加载模块。假定有一个数学模块math.js,就可以像下面这样加载。

var math = require('math');

然后,就可以调用模块提供的方法:

var math = require('math');

math.add(2,3); // 5

因为这个系列主要针对浏览器编程,不涉及node.js,所以对CommonJS就不多做介绍了。我们在这里只要知道,require()用于加载模块就行了。 
九、浏览器环境 
有了服务器端模块以后,很自然地,大家就想要客户端模块。而且最好两者能够兼容,一个模块不用修改,在服务器和浏览器都可以运行。 
但是,由于一个重大的局限,使得CommonJS规范不适用于浏览器环境。还是上一节的代码,如果在浏览器中运行,会有一个很大的问题,你能看出来吗?

var math = require('math');

math.add(2, 3);

第二行math.add(2, 3),在第一行require(‘math’)之后运行,因此必须等math.js加载完成。也就是说,如果加载时间很长,整个应用就会停在那里等。 
这对服务器端不是一个问题,因为所有的模块都存放在本地硬盘,可以同步加载完成,等待时间就是硬盘的读取时间。但是,对于浏览器,这却是一个大问题,因为模块都放在服务器端,等待时间取决于网速的快慢,可能要等很长时间,浏览器处于”假死”状态。 
因此,浏览器端的模块,不能采用”同步加载”(synchronous),只能采用”异步加载”(asynchronous)。这就是AMD规范诞生的背景。 
十、AMD 
AMD是”Asynchronous Module Definition”的缩写,意思就是”异步模块定义”。它采用异步方式加载模块,模块的加载不影响它后面语句的运行。所有依赖这个模块的语句,都定义在一个回调函数中,等到加载完成之后,这个回调函数才会运行。 
AMD也采用require()语句加载模块,但是不同于CommonJS,它要求两个参数:

require([module], callback);

第一个参数[module],是一个数组,里面的成员就是要加载的模块;第二个参数callback,则是加载成功之后的回调函数。如果将前面的代码改写成AMD形式,就是下面这样:

require(['math'], function (math) {

  math.add(2, 3);

});

math.add()与math模块加载不是同步的,浏览器不会发生假死。所以很显然,AMD比较适合浏览器环境。