JS中的模塊規(guī)范(CommonJS,AMD形纺,CMD)丘侠,如果你聽過js模塊化這個東西,那么你就應該聽過或CommonJS或AMD甚至是CMD這些規(guī)范咯逐样,我也聽過蜗字,但之前也真的是聽聽而已。 現(xiàn)在就看看吧脂新,這些規(guī)范到底是啥東西挪捕,干嘛的。本文包括這三個規(guī)范的來源及對應的產物的原理争便。
一级零、CommonJS
1.一開始大家都認為JS是辣雞,沒什么用滞乙,官方定義的API只能構建基于瀏覽器的應用程序奏纪,逗我呢,這太狹隘了吧(用了個高端詞斩启,嘎嘎)序调,CommonJS就按耐不住了,CommonJS API定義很多普通應用程序(主要指非瀏覽器的應用)使用的API兔簇,從而填補了這個空白发绢。它的終極目標是提供一個類似Python,Ruby和Java標準庫垄琐。這樣的話边酒,開發(fā)者可以使用CommonJS API編寫應用程序,然后這些應用可以運行在不同的JavaScript解釋器和不同的主機環(huán)境中此虑。
在兼容CommonJS的系統(tǒng)中甚纲,你可以使用JavaScript開發(fā)以下程序:
(1).服務器端JavaScript應用程序(2).命令行工具(3).圖形界面應用程序(4).混合應用程序(如,Titanium或Adobe AIR)
2009年朦前,美國程序員Ryan Dahl創(chuàng)造了node.js項目介杆,將javascript語言用于服務器端編程鹃操。這標志"Javascript模塊化編程"正式誕生。因為老實說春哨,在瀏覽器環(huán)境下荆隘,沒有模塊也不是特別大的問題,畢竟網頁程序的復雜性有限赴背;但是在服務器端椰拒,一定要有模塊,與操作系統(tǒng)和其他應用程序互動凰荚,否則根本沒法編程燃观。NodeJS是CommonJS規(guī)范的實現(xiàn),webpack 也是以CommonJS的形式來書寫便瑟。
node.js的模塊系統(tǒng)缆毁,就是參照CommonJS規(guī)范實現(xiàn)的。在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的規(guī)范虎锚,但是相比也是做了一些取舍,填了一些新東西的衩婚。
不過,說了CommonJS也說了Node效斑,那么我覺得也得先了解下NPM了非春。NPM作為Node的包管理器,不是為了幫助Node解決依賴包的安裝問題嘛缓屠,那它肯定也要遵循CommonJS規(guī)范啦奇昙,它遵循包規(guī)范(還是理論)的。CommonJS WIKI講了它的歷史敌完,還介紹了modules和packages等储耐。
下面講講commonJS的原理以及簡易實現(xiàn):
1、原理
瀏覽器不兼容CommonJS的根本原因滨溉,在于缺少四個Node.js環(huán)境的變量什湘。
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
上面代碼向一個立即執(zhí)行函數提供 module 和 exports 兩個外部變量得哆,模塊就放在這個立即執(zhí)行函數里面。模塊的輸出值放在 module.exports 之中哟旗,這樣就實現(xiàn)了模塊的加載贩据。
2、Browserify 的實現(xiàn)
知道了原理闸餐,就能做出工具了饱亮。Browserify 是目前最常用的 CommonJS 格式轉換的工具。
請看一個例子舍沙,main.js 模塊加載 foo.js 模塊近上。
// foo.jsmodule.exports = function(x) { console.log(x);};// main.jsvar 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號模塊硬梁。執(zhí)行的時候前硫,瀏覽器遇到 require('./foo') 語句,就自動執(zhí)行1號模塊的 source 屬性荧止,并將執(zhí)行后的 module.exports 屬性值輸出屹电。
3、Tiny Browser Require
雖然 Browserify 很強大跃巡,但不能在瀏覽器里操作危号,有時就很不方便。
我根據 mocha 的內部實現(xiàn)素邪,做了一個純?yōu)g覽器的 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('/'));
};
};
使用的時候俐填,先將上面的代碼放入頁面。然后翔忽,將模塊放在如下的立即執(zhí)行函數里面英融,就可以調用了。
<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),就通過立即執(zhí)行函數提供即可龙巨。
二笼呆、AMD
基于commonJS規(guī)范的nodeJS出來以后,服務端的模塊概念已經形成旨别,很自然地诗赌,大家就想要客戶端模塊。而且最好兩者能夠兼容秸弛,一個模塊不用修改铭若,在服務器和瀏覽器都可以運行。但是递览,由于一個重大的局限叼屠,使得CommonJS規(guī)范不適用于瀏覽器環(huán)境。還是上面的代碼绞铃,如果在瀏覽器中運行镜雨,會有一個很大的問題,你能看出來嗎儿捧?
var math = require('math');
math.add(2, 3);
第二行math.add(2, 3)冷离,在第一行require('math')之后運行,因此必須等math.js加載完成纯命。也就是說,如果加載時間很長痹栖,整個應用就會停在那里等亿汞。您會注意到 require
是同步的。
這對服務器端不是一個問題揪阿,因為所有的模塊都存放在本地硬盤疗我,可以同步加載完成咆畏,等待時間就是硬盤的讀取時間。但是吴裤,對于瀏覽器旧找,這卻是一個大問題,因為模塊都放在服務器端麦牺,等待時間取決于網速的快慢钮蛛,可能要等很長時間,瀏覽器處于"假死"狀態(tài)剖膳。
因此魏颓,瀏覽器端的模塊,不能采用"同步加載"(synchronous)吱晒,只能采用"異步加載"(asynchronous)甸饱。這就是AMD規(guī)范誕生的背景念颈。
CommonJS是主要為了JS在后端的表現(xiàn)制定的晦溪,他是不適合前端的涯捻,AMD(異步模塊定義)出現(xiàn)了皇忿,它就主要為前端JS的表現(xiàn)制定規(guī)范哈误。
AMD是"Asynchronous Module Definition"的縮寫戴尸,意思就是"異步模塊定義"罚拟。它采用異步方式加載模塊廉嚼,模塊的加載不影響它后面語句的運行矗烛。所有依賴這個模塊的語句辅柴,都定義在一個回調函數中,等到加載完成之后瞭吃,這個回調函數才會運行碌嘀。
AMD也采用require()語句加載模塊,但是不同于CommonJS歪架,它要求兩個參數:
require([module], callback);
第一個參數[module]股冗,是一個數組,里面的成員就是要加載的模塊和蚪;第二個參數callback止状,則是加載成功之后的回調函數。如果將前面的代碼改寫成AMD形式攒霹,就是下面這樣:
require(['math'], function (math) {
math.add(2, 3);
});
math.add()與math模塊加載不是同步的怯疤,瀏覽器不會發(fā)生假死。所以很顯然催束,AMD比較適合瀏覽器環(huán)境集峦。目前,主要有兩個Javascript庫實現(xiàn)了AMD規(guī)范:require.js和curl.js。
RequireJS就是實現(xiàn)了AMD規(guī)范的呢塔淤。
詳細概括:下面以RequireJS為例說明AMD規(guī)范
一摘昌、為什么要用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)實現(xiàn)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。
三淑际、主模塊的寫法
上一節(jié)的main.js畏纲,我把它稱為"主模塊",意思是整個網頁的入口代碼春缕。它有點像C語言的main()函數盗胀,所有代碼都從這兒開始運行。
下面就來看淡溯,怎么寫main.js读整。
如果我們的代碼不依賴任何其他模塊,那么可以直接寫入javascript代碼咱娶。
// main.js
alert("加載成功米间!");
但這樣的話,就沒必要使用require.js了膘侮。真正常見的情況是屈糊,主模塊依賴于其他模塊,這時就要使用AMD規(guī)范定義的的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扇单,然后再運行回調函數。主模塊的代碼就寫在回調函數中奠旺。
四蜘澜、模塊的加載
上一節(jié)最后的示例中,主模塊的依賴模塊是['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文件。這樣的話狐粱,如果加載多個模塊,就會發(fā)出多次HTTP請求胆数,會影響網頁的加載速度肌蜻。因此,require.js提供了一個優(yōu)化工具必尼,當模塊部署完畢以后蒋搜,可以用這個工具將多個模塊合并在一個文件中,減少HTTP請求數判莉。
五豆挽、AMD模塊的寫法
require.js加載的模塊,采用AMD規(guī)范券盅。也就是說帮哈,模塊必須按照AMD的規(guī)定來寫。
具體來說锰镀,就是模塊必須采用特定的define()函數來定義娘侍。如果一個模塊不依賴其他模塊,那么可以直接定義在define()函數之中泳炉。
假定現(xiàn)在有一個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文件之景。
六斤富、加載非規(guī)范的模塊
理論上,require.js加載的模塊锻狗,必須是按照AMD規(guī)范满力、用define()函數定義的模塊焕参。但是實際上,雖然已經有一部分流行的函數庫(比如jQuery)符合AMD規(guī)范油额,更多的庫并不符合叠纷。那么,require.js是否能夠加載非規(guī)范的模塊呢潦嘶?
回答是可以的涩嚣。
這樣的模塊在用require()加載之前,要先用require.config()方法掂僵,定義它們的一些特征航厚。
舉例來說,underscore和backbone這兩個庫锰蓬,都沒有采用AMD規(guī)范編寫幔睬。如果要加載它們的話,必須先定義它們的特征芹扭。
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還提供一系列插件蝴簇,實現(xiàn)一些特定的功能杯活。
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){...});
要是沒什么依賴寄猩,就定義簡單的模塊,下面這樣就可以啦:
define(function(){
var exports = {};
exports.method = function(){...};
return exports;
});
咦骑疆,這里有define田篇,把東西包裝起來啦替废,那Node實現(xiàn)中怎么沒看到有define關鍵字呢,它也要把東西包裝起來呀泊柬,其實吧椎镣,只是Node隱式包裝了而已.....
這有AMD的WIKI中文版,講了很多蠻詳細的東西兽赁,用到的時候可以查看:AMD的WIKI中文版