AMD、CMD、RequireJS

為什么要使用模塊化?

最主要的目的:

解決命名沖突

依賴管理

其他價值

提高代碼可讀性

代碼解耦,提高復(fù)用性

CMD、AMD、CommonJS 規(guī)范分別指什么?有哪些應(yīng)用

這三個規(guī)范都是為javascript模塊化加載而生的,都是在用到或者預(yù)計要用到某些模塊時候加載該模塊,使得大量的系統(tǒng)巨大的龐雜的代碼得以很好的組織和管理。模塊化使得我們在使用和管理代碼的時候不那么混亂,而且也方便了多人的合作。

CMD規(guī)范

CMD(Common Module Definition)通用模板定義,它是在一個瀏覽器端模塊化的開發(fā)規(guī)范

使用CMD規(guī)范進(jìn)行開發(fā)需要使用SeaJS

Sea.js推薦一個模塊為一個文件

代碼的書寫格式:

define(id?,dependencies?,factory);

id:(可不寫,默認(rèn)文件名),用來定義模塊的標(biāo)識,通用文件名作為模塊ID

dependencies:(可不寫)一個當(dāng)前模塊依賴的模塊名稱數(shù)組(因為CMD推崇依賴就近,因此一般不在此處指定)

factory:

function(require,exports,module)

require(id):require是一個方法,接受模塊標(biāo)識作為唯一參數(shù),用來獲取其他模塊提供的接口

exports是一個對象,用來向外提供模塊接口

module是一個對象,上面儲存了與當(dāng)前模塊相關(guān)聯(lián)的一些屬性和方法

define Function

define是一個全局函數(shù),用來定義模塊

define接受factory參數(shù),factory可以是一個函數(shù),也可以是一個對象或字符串

factory為對象、字符串時,表示模塊的接口就是該對象、字符串。例如定義一個JSON數(shù)據(jù)模塊:

define({ “foo”:“bar” });

factory為函數(shù)時,表示模塊的構(gòu)造方法。執(zhí)行該構(gòu)造方法,可以得到模塊向外提供的接口。factory方法在執(zhí)行時,默認(rèn)傳入三個參數(shù):require、exports、module:

define(function(require,exports,module){})

define define(id?, deps?, factory)

define 也可以接受兩個以上參數(shù)。字符串 id 表示模塊標(biāo)識,數(shù)組 deps 是模塊依賴。比如:

define('hello', ['jquery'],function(require, exports, module){});

id和 deps參數(shù)可以省略。省略時,可以通過構(gòu)建工具自動生成。

注意:帶 id和 deps參數(shù)的 define用法不屬于 CMD 規(guī)范,而屬于Modules/Transport規(guī)范。

define.cmd Object

一個空對象,可用來判定當(dāng)前頁面是否有 CMD 模塊加載器:

if(typeofdefine ==="function"&& define.cmd) {// 有 Sea.js 等 CMD 模塊加載器存在}

require Function

require是factory函數(shù)的第一個參數(shù)

require是一個方法,接受模塊標(biāo)識作為唯一參數(shù),用來獲取其他模塊提供的接口。

define(function(require, exports){// 獲取模塊 a 的接口vara =require('./a');// 調(diào)用模塊 a 的方法a.doSomething();});

require.async require.async(id, callback?)

require.async 方法用來在模塊內(nèi)部異步加載模塊,并在加載完成后執(zhí)行指定回調(diào)。callback 參數(shù)可選。

define(function(require, exports, module){// 異步加載一個模塊,在加載完成時,執(zhí)行回調(diào)require.async('./b',function(b){? ? b.doSomething();? });// 異步加載多個模塊,在加載完成時,執(zhí)行回調(diào)require.async(['./c','./d'],function(c, d){? ? c.doSomething();? ? d.doSomething();? });});

注意:require 是同步往下執(zhí)行,require.async 則是異步回調(diào)執(zhí)行。require.async 一般用來加載可延遲異步加載的模塊。

require.resolve require.resolve(id)

使用模塊系統(tǒng)內(nèi)部的路徑解析機(jī)制來解析并返回模塊路徑。該函數(shù)不會加載模塊,只返回解析后的絕對路徑。

define(function(require, exports){console.log(require.resolve('./b'));// ==> http://example.com/path/to/b.js});

這可以用來獲取模塊路徑,一般用在插件環(huán)境或需動態(tài)拼接模塊路徑的場景下。

exports Object

exports 是一個對象,用來向外提供模塊接口。

define(function(require, exports){// 對外提供 foo 屬性exports.foo ='bar';// 對外提供 doSomething 方法exports.doSomething =function(){};});

除了給 exports 對象增加成員,還可以使用 return 直接向外提供接口。

define(function(require){// 通過 return 直接提供接口return{foo:'bar',doSomething:function(){}? };});

如果 return 語句是模塊中的唯一代碼,還可簡化為:

define({foo:'bar',? doSomething:function() {}});

上面這種格式特別適合定義 JSONP 模塊。

特別注意:下面這種寫法是錯誤的!

define(function(require, exports){// 錯誤用法??!!exports = {foo:'bar',doSomething:function(){}? };});

正確的寫法是用 return 或者給 module.exports 賦值:

define(function(require, exports, module){// 正確寫法module.exports = {foo:'bar',doSomething:function(){}? };});

提示:exports 僅僅是 module.exports 的一個引用。在 factory 內(nèi)部給 exports 重新賦值時,并不會改變 module.exports 的值。因此給 exports 賦值是無效的,不能用來更改模塊接口。

module Object

module 是一個對象,上面存儲了與當(dāng)前模塊相關(guān)聯(lián)的一些屬性和方法。

module.id String

模塊的唯一標(biāo)識

define('id', [],function(require, exports, module){// 模塊代碼});

上面代碼中,define 的第一個參數(shù)就是模塊標(biāo)識。

module.uri String

根據(jù)模塊系統(tǒng)的路徑解析規(guī)則得到的模塊絕對路徑。

define(function(require, exports, module){console.log(module.uri);// ==> http://example.com/path/to/this/file.js});

一般情況下(沒有在 define 中手寫 id 參數(shù)時),module.id 的值就是 module.uri,兩者完全相同。

module.dependencies Array

dependencies 是一個數(shù)組,表示當(dāng)前模塊的依賴。

module.exports Object

當(dāng)前模塊對外提供的接口。

傳給 factory 構(gòu)造方法的 exports 參數(shù)是 module.exports 對象的一個引用。只通過 exports 參數(shù)來提供接口,有時無法滿足開發(fā)者的所有需求。 比如當(dāng)模塊的接口是某個類的實例時,需要通過 module.exports 來實現(xiàn):

define(function(require,exports,module) {// exports 是 module.exports 的一個引用console.log(module.exports===exports);// true// 重新給 module.exports 賦值module.exports=newSomeClass();// exports 不再等于 module.exportsconsole.log(module.exports===exports);// false});

注意:對 module.exports 的賦值需要同步執(zhí)行,不能放在回調(diào)函數(shù)里。下面這樣是不行的:

// x.jsdefine(function(require, exports, module){// 錯誤用法setTimeout(function(){module.exports = {a:"hello"};? },0); });

在 y.js 里有調(diào)用到上面的 x.js:

// y.jsdefine(function(require, exports, module){varx =require('./x');// 無法立刻得到模塊 x 的屬性 aconsole.log(x.a);// undefined});

小結(jié)

經(jīng)常使用的 API 只有 define, require, require.async, exports, module.exports 這五個。其他 API 有個印象就好。

與 RequireJS 的 AMD 規(guī)范相比,CMD 規(guī)范盡量保持簡單,并與 CommonJS 和 Node.js 的 Modules 規(guī)范保持了很大的兼容性。通過 CMD 規(guī)范書寫的模塊,可以很容易在 Node.js 中運行。

AMD規(guī)范

AMD (Asynchronous Module Definition, 異步模塊定義) 指定一種機(jī)制,在該機(jī)制下模塊和依賴可以異步加載。這對瀏覽器端的異步加載尤其適用。

AMD 是 RequireJS 在推廣過程中對模塊定義的規(guī)范化產(chǎn)出。

使用AMD規(guī)范進(jìn)行開發(fā)需要使用RequireJS

requireJS主要解決兩個問題:

js文件之間的依賴關(guān)系:被依賴的文件需要早于依賴它的文件加載到瀏覽器

js加載的時候瀏覽器會停止頁面渲染,加載文件越多,頁面失去響應(yīng)時間越長

define(id?, dependencies?, factory);

id: 定義中模塊的名字,可選;如果沒有提供該參數(shù),模塊的名字應(yīng)該默認(rèn)為模塊加載器請求的指定腳本的名字。

依賴dependencies:是一個當(dāng)前模塊依賴的,已被模塊定義的模塊標(biāo)識的數(shù)組字面量。 依賴參數(shù)是可選的,如果忽略此參數(shù),它應(yīng)該默認(rèn)為["require", "exports", "module"]。然而,如果工廠方法的長度屬性小于3,加載器會選擇以函數(shù)的長度屬性指定的參數(shù)個數(shù)調(diào)用工廠方法。

工廠方法factory,模塊初始化要執(zhí)行的函數(shù)或?qū)ο?。如果為函?shù),它應(yīng)該只被執(zhí)行一次。如果是對象,此對象應(yīng)該為模塊的輸出值。

AMD模式

define和require這兩個定義模塊、調(diào)用模塊的方法,合稱為AMD模式。它的模塊定義的方法非常清晰,不會污染全局環(huán)境,能夠清楚地顯示依賴關(guān)系。

AMD模式可以用于瀏覽器環(huán)境,并且允許非同步加載模塊,也可以根據(jù)需要動態(tài)加載模塊。

define方法:定義模塊

define方法用于定義模塊,RequireJS要求每個模塊放在一個單獨的文件里。

按照是否依賴其他模塊,可以分成兩種情況討論。第一種情況是定義獨立模塊,即所定義的模塊不依賴其他模塊;第二種情況是定義非獨立模塊,即所定義的模塊依賴于其他模塊。

require方法:調(diào)用模塊

require方法用于調(diào)用模塊。它的參數(shù)與define方法類似。

require(['foo','bar'],function( foo, bar ){? ? ? ? foo.doSomething();});

上面方法表示加載foo和bar兩個模塊,當(dāng)這兩個模塊都加載成功后,執(zhí)行一個回調(diào)函數(shù)。該回調(diào)函數(shù)就用來完成具體的任務(wù)。

require方法的第一個參數(shù),是一個表示依賴關(guān)系的數(shù)組。這個數(shù)組可以寫得很靈活,請看下面的例子。

require( [window.JSON ?undefined:'util/json2'],function( JSON ){JSON=JSON||window.JSON;console.log(JSON.parse('{ "JSON" : "HERE" }') );});

上面代碼加載JSON模塊時,首先判斷瀏覽器是否原生支持JSON對象。如果是的,則將undefined傳入回調(diào)函數(shù),否則加載util目錄下的json2模塊。

require方法也可以用在define方法內(nèi)部。

define(function(require){varotherModule =require('otherModule');});

CommonJS規(guī)范

CommonJS是服務(wù)器端模塊的規(guī)范,Node.js采用了這個規(guī)范。Node.JS首先采用了js模塊化的概念。

1.在一個模塊中,存在一個自由的變量“require”,它是一個函數(shù)。

這個“require”函數(shù)接收一個模塊標(biāo)識符

“require”返回外部模塊所輸出的API

如果出現(xiàn)依賴閉環(huán)(dependency cycle),那么外部模塊在被它的傳遞依賴(transitive dependencies)所require的時候可能并沒有執(zhí)行完成;在這種情況下,”require”返回的對象必須至少包含此外部模塊在調(diào)用require函數(shù)(會進(jìn)入當(dāng)前模塊執(zhí)行環(huán)境)之前就已經(jīng)準(zhǔn)備完畢的輸出。

如果請求的模塊不能返回,那么”require”必須拋出一個錯誤。

2.在一個模塊中,會存在一個名為“exports”的自由變量,它是一個對象,模塊可以在執(zhí)行的時候把自身的API加入到其中。

3.模塊必須使用“exports”對象來做為輸出的唯一表示。

根據(jù)這個規(guī)范,每個文件就是一個模塊,有自己的作用域。在一個文件里面定義的變量、函數(shù)、類,都是私有的,對其他文件不可見。

// example.jsvarx =5;varaddX =function(value){returnvalue + x;};

上面代碼中,變量X和函數(shù)addX,是當(dāng)前文件example.js私有的,其他文件不可見。如果想在多個文件分享變量,必須定義為global對象的屬性。

global.warning =true;

上面代碼的warning變量,可以被所有文件讀取。當(dāng)然,這樣寫法是不推薦的。

CommonJS規(guī)范規(guī)定,每個模塊內(nèi)部,module變量代表當(dāng)前模塊。這個變量是一個對象,它的exports屬性(即module.exports)是對外的接口。加載某個模塊,其實是加載該模塊的module.exports屬性。

varx =5;varaddX =function(value){returnvalue + x;};module.exports.x = x;module.exports.addX = addX;

上面代碼通過module.exports輸出變量x和函數(shù)addX。

require方法用于加載模塊。

varexample =require('./example.js');console.log(example.x);// 5console.log(example.addX(1));// 6

CommonJS模塊的特點:

所有代碼都運行在模塊作用域,不會污染全局作用域。

模塊可以多次加載,但是只會在第一次加載時運行一次,然后運行結(jié)果就被緩存了,以后再加載,就直接讀取緩存結(jié)果。要想讓模塊再次運行,必須清除緩存。

模塊加載的順序,按照其在代碼中出現(xiàn)的順序。

作者:Eazer

鏈接:http://www.itdecent.cn/p/c9177fbbe9aa

來源:簡書

著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請聯(lián)系作者獲得授權(quán),非商業(yè)轉(zhuǎn)載請注明出處。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 為什么要使用模塊化? 最主要的目的:解決命名沖突依賴管理 其他價值提高代碼可讀性代碼解耦,提高復(fù)用性 CMD、AM...
    Eazer閱讀 766評論 3 1
  • 題目1: 為什么要使用模塊化? 網(wǎng)頁愈趨向Web應(yīng)用程序,導(dǎo)致JavaScript的體量愈來愈大,客戶端的代碼模塊...
    cctosuper閱讀 319評論 0 0
  • 題目1: 為什么要使用模塊化? 最主要的目的: 解決命名沖突 依賴管理 其他價值 提高代碼可讀性 代碼解耦,提高復(fù)...
    曾祥輝閱讀 166評論 0 0
  • 文/長安有間鋪子 海底月是天上月,眼前人是心上人。 我想每個女孩子都曾期待過能遇到一個人,幻想著與他的幸福生活會是...
    長安有間鋪子閱讀 615評論 1 3
  • 1、void remove(List a,Integer b) 刪除鏈表a中所有大于b的表項。 2、創(chuàng)建線程的3...
    黃云豐閱讀 289評論 0 0

友情鏈接更多精彩內(nèi)容