js模塊化編程之徹底弄懂CommonJS和AMD/CMD！

先回答我：為什么模塊很重要？

 

答：因為有了模塊，我們就可以更方便地使用別人的代碼，想要什么功能，就加載什么模塊。
但是，這樣做有一個前提，那就是大家必須以同樣的方式編寫模塊，否則你有你的寫法，我有我的寫法，豈不是亂了套！

於是下面三個模塊規范出來了，這篇文章也出來了（拼出來的 {捂臉笑}）。

 

JS中的模塊規范（CommonJS，AMD，CMD），如果你聽過js模塊化這個東西，那么你就應該聽過或CommonJS或AMD甚至是CMD這些規范咯，我也聽過，但之前也真的是聽聽而已。 現在就看看吧，這些規范到底是啥東西，干嘛的。本文包括這三個規范的來源及對應的產物的原理。

 

一、CommonJS

1.一開始大家都認為JS是辣雞，沒什么用，官方定義的API只能構建基於瀏覽器的應用程序，逗我呢，這太狹隘了吧(用了個高端詞，嘎嘎)，CommonJS就按耐不住了，CommonJS API定義很多普通應用程序（主要指非瀏覽器的應用）使用的API，從而填補了這個空白。它的終極目標是提供一個類似Python，Ruby和Java標准庫。這樣的話，開發者可以使用CommonJS API編寫應用程序，然后這些應用可以運行在不同的JavaScript解釋器和不同的主機環境中。

在兼容CommonJS的系統中，你可以使用JavaScript開發以下程序：

 

(1).服務器端JavaScript應用程序
(2).命令行工具
(3).圖形界面應用程序
(4).混合應用程序（如，Titanium或Adobe AIR）

2009年，美國程序員Ryan Dahl創造了node.js項目，將javascript語言用於服務器端編程。這標志"Javascript模塊化編程"正式誕生。因為老實說，在瀏覽器環境下，沒有模塊也不是特別大的問題，畢竟網頁程序的復雜性有限；但是在服務器端，一定要有模塊，與操作系統和其他應用程序互動，否則根本沒法編程。NodeJS是CommonJS規范的實現，webpack 也是以CommonJS的形式來書寫。

node.js的模塊系統，就是參照CommonJS規范實現的。在CommonJS中，有一個全局性方法require()，用於加載模塊。假定有一個數學模塊math.js，就可以像下面這樣加載。

var math = require('math');

然后，就可以調用模塊提供的方法：

　　var math = require('math');

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

CommonJS定義的模塊分為:{模塊引用(require)} {模塊定義(exports)} {模塊標識(module)}

require()用來引入外部模塊；exports對象用於導出當前模塊的方法或變量，唯一的導出口；module對象就代表模塊本身。

雖說Node遵循CommonJS的規范，但是相比也是做了一些取舍，填了一些新東西的。

不過，說了CommonJS也說了Node，那么我覺得也得先了解下NPM了。NPM作為Node的包管理器，不是為了幫助Node解決依賴包的安裝問題嘛，那它肯定也要遵循CommonJS規范啦，它遵循包規范（還是理論）的。CommonJS WIKI講了它的歷史，還介紹了modules和packages等。

下面講講commonJS的原理以及簡易實現：

1、原理

瀏覽器不兼容CommonJS的根本原因，在於缺少四個Node.js環境的變量。

 

• module
• exports
• require
• global

 

只要能夠提供這四個變量，瀏覽器就能加載 CommonJS 模塊。

 

下面是一個簡單的示例。

 

 var module = { exports: {} }; (function(module, exports) { exports.multiply = function (n) { return n * 1000 }; }(module, module.exports)) var f = module.exports.multiply; f(5) // 5000 

 

上面代碼向一個立即執行函數提供 module 和 exports 兩個外部變量，模塊就放在這個立即執行函數里面。模塊的輸出值放在 module.exports 之中，這樣就實現了模塊的加載。

 

2、Browserify 的實現

知道了原理，就能做出工具了。Browserify 是目前最常用的 CommonJS 格式轉換的工具。

請看一個例子，main.js 模塊加載 foo.js 模塊。

 

 // foo.js module.exports = function(x) { console.log(x); };  // main.js var foo = require("./foo"); foo("Hi"); 

 

使用下面的命令，就能將main.js轉為瀏覽器可用的格式。

 

 $ browserify main.js > compiled.js 

 

Browserify到底做了什么？安裝一下browser-unpack，就能看清楚了。

 

 $ npm install browser-unpack -g 

 

然后，將前面生成的compile.js解包。

 

 $ browser-unpack < compiled.js [ { "id":1, "source":"module.exports = function(x) {\n console.log(x);\n};", "deps":{} }, { "id":2, "source":"var foo = require(\"./foo\");\nfoo(\"Hi\");", "deps":{"./foo":1}, "entry":true } ] 

 

可以看到，browerify 將所有模塊放入一個數組，id 屬性是模塊的編號，source 屬性是模塊的源碼，deps 屬性是模塊的依賴。

 

因為 main.js 里面加載了 foo.js，所以 deps 屬性就指定 ./foo 對應1號模塊。執行的時候，瀏覽器遇到 require('./foo') 語句，就自動執行1號模塊的 source 屬性，並將執行后的 module.exports 屬性值輸出。

 

3、Tiny Browser Require

雖然 Browserify 很強大，但不能在瀏覽器里操作，有時就很不方便。

 

我根據 mocha 的內部實現，做了一個純瀏覽器的 CommonJS 模塊加載器 tiny-browser-require 。完全不需要命令行，直接放進瀏覽器即可，所有代碼只有30多行。

 

 

它的邏輯非常簡單，就是把模塊讀入數組，加載路徑就是模塊的id。

 

 function require(p){ var path = require.resolve(p); var mod = require.modules[path]; if (!mod) throw new Error('failed to require "' + p + '"'); if (!mod.exports) { mod.exports = {}; mod.call(mod.exports, mod, mod.exports, require.relative(path)); } return mod.exports; } require.modules = {}; require.resolve = function (path){ var orig = path; var reg = path + '.js'; var index = path + '/index.js'; return require.modules[reg] && reg || require.modules[index] && index || orig; }; require.register = function (path, fn){ require.modules[path] = fn; }; require.relative = function (parent) { return function(p){ if ('.' != p.charAt(0)) return require(p); var path = parent.split('/'); var segs = p.split('/'); path.pop(); for (var i = 0; i < segs.length; i++) { var seg = segs[i]; if ('..' == seg) path.pop(); else if ('.' != seg) path.push(seg); } return require(path.join('/')); }; }; 

 

使用的時候，先將上面的代碼放入頁面。然后，將模塊放在如下的立即執行函數里面，就可以調用了。

 

 <script src="require.js" /> <script> require.register("moduleId", function(module, exports, require){ // Module code goes here }); var result = require("moduleId"); </script> 

 

還是以前面的 main.js 加載 foo.js 為例。

 

 require.register("./foo.js", function(module, exports, require){ module.exports = function(x) { console.log(x); }; }); var foo = require("./foo.js"); foo("Hi"); 

 

注意，這個庫只模擬了 require 、module 、exports 三個變量，如果模塊還用到了 global 或者其他 Node 專有變量（比如 process），就通過立即執行函數提供即可。

二、AMD

基於commonJS規范的nodeJS出來以后，服務端的模塊概念已經形成，很自然地，大家就想要客戶端模塊。而且最好兩者能夠兼容，一個模塊不用修改，在服務器和瀏覽器都可以運行。但是，由於一個重大的局限，使得CommonJS規范不適用於瀏覽器環境。還是上面的代碼，如果在瀏覽器中運行，會有一個很大的問題，你能看出來嗎？

 

　　var math = require('math');

　　math.add(2, 3);

 

第二行math.add(2, 3)，在第一行require('math')之后運行，因此必須等math.js加載完成。也就是說，如果加載時間很長，整個應用就會停在那里等。您會注意到 require 是同步的。

這對服務器端不是一個問題，因為所有的模塊都存放在本地硬盤，可以同步加載完成，等待時間就是硬盤的讀取時間。但是，對於瀏覽器，這卻是一個大問題，因為模塊都放在服務器端，等待時間取決於網速的快慢，可能要等很長時間，瀏覽器處於"假死"狀態。

 

因此，瀏覽器端的模塊，不能采用"同步加載"（synchronous），只能采用"異步加載"（asynchronous）。這就是AMD規范誕生的背景。

 

CommonJS是主要為了JS在后端的表現制定的，他是不適合前端的，AMD(異步模塊定義)出現了，它就主要為前端JS的表現制定規范。

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比較適合瀏覽器環境。目前，主要有兩個Javascript庫實現了AMD規范：require.js和curl.js。

RequireJS就是實現了AMD規范的呢。

詳細概括：下面以RequireJS為例說明AMD規范

一、為什么要用require.js？

最早的時候，所有Javascript代碼都寫在一個文件里面，只要加載這一個文件就夠了。后來，代碼越來越多，一個文件不夠了，必須分成多個文件，依次加載。下面的網頁代碼，相信很多人都見過。

 

　　<script src="1.js"></script>
　　<script src="2.js"></script>
　　<script src="3.js"></script>
　　<script src="4.js"></script>
　　<script src="5.js"></script>
　　<script src="6.js"></script>

 

這段代碼依次加載多個js文件。

 

這樣的寫法有很大的缺點。首先，加載的時候，瀏覽器會停止網頁渲染，加載文件越多，網頁失去響應的時間就會越長；其次，由於js文件之間存在依賴關系，因此必須嚴格保證加載順序（比如上例的1.js要在2.js的前面），依賴性最大的模塊一定要放到最后加載，當依賴關系很復雜的時候，代碼的編寫和維護都會變得困難。

 

require.js的誕生，就是為了解決這兩個問題：

 

　　

　　（1）實現js文件的異步加載，避免網頁失去響應；

　　（2）管理模塊之間的依賴性，便於代碼的編寫和維護。

 

二、require.js的加載

 

使用require.js的第一步，是先去官方網站下載最新版本。

 

下載后，假定把它放在js子目錄下面，就可以加載了。

 

　　<script src="js/require.js"></script>

 

有人可能會想到，加載這個文件，也可能造成網頁失去響應。解決辦法有兩個，一個是把它放在網頁底部加載，另一個是寫成下面這樣：

 

　　<script src="js/require.js" defer async="true" ></script>

 

async屬性表明這個文件需要異步加載，避免網頁失去響應。IE不支持這個屬性，只支持defer，所以把defer也寫上。

 

加載require.js以后，下一步就要加載我們自己的代碼了。假定我們自己的代碼文件是main.js，也放在js目錄下面。那么，只需要寫成下面這樣就行了：

 

　　<script src="js/require.js" data-main="js/main"></script>

 

data-main屬性的作用是，指定網頁程序的主模塊。在上例中，就是js目錄下面的main.js，這個文件會第一個被require.js加載。由於require.js默認的文件后綴名是js，所以可以把main.js簡寫成main。

 

三、主模塊的寫法

 

上一節的main.js，我把它稱為"主模塊"，意思是整個網頁的入口代碼。它有點像C語言的main()函數，所有代碼都從這兒開始運行。

 

下面就來看，怎么寫main.js。

 

如果我們的代碼不依賴任何其他模塊，那么可以直接寫入javascript代碼。

 

　　// main.js

　　alert("加載成功！");

 

但這樣的話，就沒必要使用require.js了。真正常見的情況是，主模塊依賴於其他模塊，這時就要使用AMD規范定義的的require()函數。

 

　　// main.js

　　require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){

　　　　// some code here

　　});

 

require()函數接受兩個參數。第一個參數是一個數組，表示所依賴的模塊，上例就是['moduleA', 'moduleB', 'moduleC']，即主模塊依賴這三個模塊；第二個參數是一個回調函數，當前面指定的模塊都加載成功后，它將被調用。加載的模塊會以參數形式傳入該函數，從而在回調函數內部就可以使用這些模塊。

 

require()異步加載moduleA，moduleB和moduleC，瀏覽器不會失去響應；它指定的回調函數，只有前面的模塊都加載成功后，才會運行，解決了依賴性的問題。

 

下面，我們看一個實際的例子。

 

假定主模塊依賴jquery、underscore和backbone這三個模塊，main.js就可以這樣寫：

 

　　require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){

　　　　// some code here

　　});

 

require.js會先加載jQuery、underscore和backbone，然后再運行回調函數。主模塊的代碼就寫在回調函數中。

 

四、模塊的加載

 

上一節最后的示例中，主模塊的依賴模塊是['jquery', 'underscore', 'backbone']。默認情況下，require.js假定這三個模塊與main.js在同一個目錄，文件名分別為jquery.js，underscore.js和backbone.js，然后自動加載。

 

使用require.config()方法，我們可以對模塊的加載行為進行自定義。require.config()就寫在主模塊（main.js）的頭部。參數就是一個對象，這個對象的paths屬性指定各個模塊的加載路徑。

 

　　require.config({

　　　　paths: {

　　　　　　"jquery": "jquery.min",
　　　　　　"underscore": "underscore.min",
　　　　　　"backbone": "backbone.min"

　　　　}

　　});

 

上面的代碼給出了三個模塊的文件名，路徑默認與main.js在同一個目錄（js子目錄）。如果這些模塊在其他目錄，比如js/lib目錄，則有兩種寫法。一種是逐一指定路徑。

 

　　require.config({

　　　　paths: {

　　　　　　"jquery": "lib/jquery.min",
　　　　　　"underscore": "lib/underscore.min",
　　　　　　"backbone": "lib/backbone.min"

　　　　}

　　});

 

另一種則是直接改變基目錄（baseUrl）。

 

　　require.config({

　　　　baseUrl: "js/lib",

　　　　paths: {

　　　　　　"jquery": "jquery.min",
　　　　　　"underscore": "underscore.min",
　　　　　　"backbone": "backbone.min"

　　　　}

　　});

 

如果某個模塊在另一台主機上，也可以直接指定它的網址，比如：

 

　　require.config({

　　　　paths: {

　　　　　　"jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"

　　　　}

　　});

 

require.js要求，每個模塊是一個單獨的js文件。這樣的話，如果加載多個模塊，就會發出多次HTTP請求，會影響網頁的加載速度。因此，require.js提供了一個優化工具，當模塊部署完畢以后，可以用這個工具將多個模塊合並在一個文件中，減少HTTP請求數。

 

五、AMD模塊的寫法

 

require.js加載的模塊，采用AMD規范。也就是說，模塊必須按照AMD的規定來寫。

 

具體來說，就是模塊必須采用特定的define()函數來定義。如果一個模塊不依賴其他模塊，那么可以直接定義在define()函數之中。

 

假定現在有一個math.js文件，它定義了一個math模塊。那么，math.js就要這樣寫：

 

　　// math.js

　　define(function (){

　　　　var add = function (x,y){

　　　　　　return x+y;

　　　　};

　　　　return {

　　　　　　add: add
　　　　};

　　});

 

加載方法如下：

 

　　// main.js

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

　　　　alert(math.add(1,1));

　　});

 

如果這個模塊還依賴其他模塊，那么define()函數的第一個參數，必須是一個數組，指明該模塊的依賴性。

 

　　define(['myLib'], function(myLib){

　　　　function foo(){

　　　　　　myLib.doSomething();

　　　　}

　　　　return {

　　　　　　foo : foo

　　　　};

　　});

 

當require()函數加載上面這個模塊的時候，就會先加載myLib.js文件。

 

六、加載非規范的模塊

 

理論上，require.js加載的模塊，必須是按照AMD規范、用define()函數定義的模塊。但是實際上，雖然已經有一部分流行的函數庫（比如jQuery）符合AMD規范，更多的庫並不符合。那么，require.js是否能夠加載非規范的模塊呢？

 

回答是可以的。

 

這樣的模塊在用require()加載之前，要先用require.config()方法，定義它們的一些特征。

 

舉例來說，underscore和backbone這兩個庫，都沒有采用AMD規范編寫。如果要加載它們的話，必須先定義它們的特征。

 

　　require.config({

　　　　shim: {

　　　　　　'underscore':{
　　　　　　　　exports: '_'
　　　　　　},

　　　　　　'backbone': {
　　　　　　　　deps: ['underscore', 'jquery'],
　　　　　　　　exports: 'Backbone'
　　　　　　}

　　　　}

　　});

 

require.config()接受一個配置對象，這個對象除了有前面說過的paths屬性之外，還有一個shim屬性，專門用來配置不兼容的模塊。具體來說，每個模塊要定義（1）exports值（輸出的變量名），表明這個模塊外部調用時的名稱；（2）deps數組，表明該模塊的依賴性。

 

比如，jQuery的插件可以這樣定義：

 

　　shim: {

　　　　'jquery.scroll': {

　　　　　　deps: ['jquery'],

　　　　　　exports: 'jQuery.fn.scroll'

　　　　}

　　}

 

七、require.js插件

 

require.js還提供一系列插件，實現一些特定的功能。

 

domready插件，可以讓回調函數在頁面DOM結構加載完成后再運行。

 

　　require(['domready!'], function (doc){

　　　　// called once the DOM is ready

　　});

 

text和image插件，則是允許require.js加載文本和圖片文件。

 

　　define([

　　　　'text!review.txt',

　　　　'image!cat.jpg'

　　　　],

　　　　function(review,cat){

　　　　　　console.log(review);

　　　　　　document.body.appendChild(cat);

　　　　}

　　);

 

類似的插件還有json和mdown，用於加載json文件和markdown文件。（完）

 

另一個人的概括(有點簡單)：

AMD就只有一個接口：define(id?,dependencies?,factory);

 

它要在聲明模塊的時候制定所有的依賴(dep)，並且還要當做形參傳到factory中，像這樣：

 

1 define(['dep1','dep2'],function(dep1,dep2){...});

 

要是沒什么依賴，就定義簡單的模塊，下面這樣就可以啦：

 

1 define(function(){
2     var exports = {};
3     exports.method = function(){...};
4     return exports;
5 });

 

咦，這里有define，把東西包裝起來啦，那Node實現中怎么沒看到有define關鍵字呢，它也要把東西包裝起來呀，其實吧，只是Node隱式包裝了而已.....

這有AMD的WIKI中文版，講了很多蠻詳細的東西，用到的時候可以查看：AMD的WIKI中文版

三、CMD

大名遠揚的玉伯寫了seajs，就是遵循他提出的CMD規范，與AMD蠻相近的，不過用起來感覺更加方便些，最重要的是中文版，應有盡有：seajs官方doc

1 define(function(require,exports,module){...});

用過seajs吧，這個不陌生吧，對吧。

前面說AMD，說RequireJS實現了AMD，CMD看起來與AMD好像呀，那RequireJS與SeaJS像不像呢？

雖然CMD與AMD蠻像的，但區別還是挺明顯的，官方非官方都有闡述和理解，我覺得吧，說的都挺好：

官方闡述SeaJS與RequireJS異同

SeaJS與RequireJS的最大異同（這個說的也挺好）