弄懂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){...});
要是沒什麼依賴,就定義簡單的模組,下面這樣就可以啦:
![複製程式碼](https://common.cnblogs.com/images/copycode.gif)
1 define(function(){
2 var exports = {};
3 exports.method = function(){...};
4 return exports;
5 });
![複製程式碼](https://common.cnblogs.com/images/copycode.gif)
咦,這裡有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蠻像的,但區別還是挺明顯的,官方非官方都有闡述和理解,我覺得吧,說的都挺好:
</div>
<div class="clear"></div>
<div class="diggword" id="digg_tips">
</div>