Javascript模塊化編程(三):require.js的用法

作者:阮一峰

data-main="js/main">

data-main屬性的作用是,指定網(wǎng)頁程序的主模塊。在上例中,就是js目錄下面的main.js,這個(gè)文件會(huì)第一個(gè)被require.js加載。由于require.js默認(rèn)的文件后綴名是js,所以可以把main.js簡(jiǎn)寫成main。

三、主模塊的寫法

上一節(jié)的main.js,我把它稱為"主模塊",意思是整個(gè)網(wǎng)頁的入口代碼。它有點(diǎn)像C語言的main()函數(shù),所有代碼都從這兒開始運(yùn)行。

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

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

// main.js

alert("加載成功!");

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

// main.js

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

// some code here

});

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

require()異步加載moduleA,moduleB和moduleC,瀏覽器不會(huì)失去響應(yīng);它指定的回調(diào)函數(shù),只有前面的模塊都加載成功后,才會(huì)運(yùn)行,解決了依賴性的問題。

下面,我們看一個(gè)實(shí)際的例子。

假定主模塊依賴jquery、underscore和backbone這三個(gè)模塊,main.js就可以這樣寫:

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

// some code here

});

require.js會(huì)先加載jQuery、underscore和backbone,然后再運(yùn)行回調(diào)函數(shù)。主模塊的代碼就寫在回調(diào)函數(shù)中。

四、模塊的加載

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

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

require.config({

paths: {

"jquery": "jquery.min",

"underscore": "underscore.min",

"backbone": "backbone.min"

}

});

上面的代碼給出了三個(gè)模塊的文件名,路徑默認(rèn)與main.js在同一個(gè)目錄(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"

}

});

如果某個(gè)模塊在另一臺(tái)主機(jī)上,也可以直接指定它的網(wǎng)址,比如:

require.config({

paths: {

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

}

});

require.js要求,每個(gè)模塊是一個(gè)單獨(dú)的js文件。這樣的話,如果加載多個(gè)模塊,就會(huì)發(fā)出多次HTTP請(qǐng)求,會(huì)影響網(wǎng)頁的加載速度。因此,require.js提供了一個(gè)優(yōu)化工具,當(dāng)模塊部署完畢以后,可以用這個(gè)工具將多個(gè)模塊合并在一個(gè)文件中,減少HTTP請(qǐng)求數(shù)。

五、AMD模塊的寫法

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

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

假定現(xiàn)在有一個(gè)math.js文件,它定義了一個(gè)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));

});

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

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

function foo(){

myLib.doSomething();

}

return {

foo : foo

};

});

當(dāng)require()函數(shù)加載上面這個(gè)模塊的時(shí)候,就會(huì)先加載myLib.js文件。

六、加載非規(guī)范的模塊

理論上,require.js加載的模塊,必須是按照AMD規(guī)范、用define()函數(shù)定義的模塊。但是實(shí)際上,雖然已經(jīng)有一部分流行的函數(shù)庫(比如jQuery)符合AMD規(guī)范,更多的庫并不符合。那么,require.js是否能夠加載非規(guī)范的模塊呢?

回答是可以的。

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

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

require.config({

shim: {

'underscore':{

exports: '_'

},

'backbone': {

deps: ['underscore', 'jquery'],

exports: 'Backbone'

}

}

});

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

比如,jQuery的插件可以這樣定義:

shim: {

'jquery.scroll': {

deps: ['jquery'],

exports: 'jQuery.fn.scroll'

}

}

七、require.js插件

require.js還提供一系列插件,實(shí)現(xiàn)一些特定的功能。

domready插件,可以讓回調(diào)函數(shù)在頁面DOM結(jié)構(gòu)加載完成后再運(yùn)行。

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文件。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容