requirejs是一個JavaScript文件和模塊加載器。requireJS允許你把你的javascript代碼獨立成文件和模塊耕姊,同時管理每個模塊間的依賴關(guān)系。
RequireJS的目標是鼓勵代碼的模塊化,它使用了不同于傳統(tǒng)"script"標簽的腳本加載步驟昙沦。使用RequireJS加載模塊化腳本將提高代碼的加載速度和質(zhì)量辖众。
官網(wǎng):http://requirejs.org/
一卓起、為什么要用require.js?
最早的時候凹炸,所有Javascript代碼都寫在一個文件里面戏阅,只要加載這一個文件就夠了。后來啤它,代碼越來越多奕筐,一個文件不夠了舱痘,必須分成多個文件,依次加載离赫。下面的網(wǎng)頁代碼芭逝,相信很多人都見過:
<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文件。
-
這樣的寫法有很大的缺點渊胸。
- 首先旬盯,加載的時候,瀏覽器會停止網(wǎng)頁渲染翎猛,加載文件越多胖翰,網(wǎng)頁失去響應(yīng)的時間就會越長
- 由于js文件之間存在依賴關(guān)系,因此必須嚴格保證加載順序(比如上例的1.js要在2.js的前面)切厘,依賴性最大的模塊一定要放到最后加載萨咳,當(dāng)依賴關(guān)系很復(fù)雜的時候,代碼的編寫和維護都會變得困難迂卢。
-
require.js的誕生某弦,就是為了解決這兩個問題:
- 實現(xiàn)js文件的異步加載,避免網(wǎng)頁失去響應(yīng)而克;
- 管理模塊之間的依賴性靶壮,便于代碼的編寫和維護。
二员萍、require.js的加載
使用require.js的第一步腾降,是先去官方網(wǎng)站下載最新版本。
下載后碎绎,假定把它放在js子目錄下面螃壤,就可以加載了。
<script src="js/require.js"></script>-
有人可能會想到筋帖,加載這個文件奸晴,也可能造成網(wǎng)頁失去響應(yīng)。解決辦法有兩個:
- 一個是把它放在網(wǎng)頁底部加載日麸,另一個是寫成下面這樣:
<script src="js/require.js" defer async="true" ></script>
async屬性表明這個文件需要異步加載寄啼,避免網(wǎng)頁失去響應(yīng)。IE不支持這個屬性代箭,只支持defer墩划,所以把defer也寫上。
- 加載require.js以后嗡综,下一步就要加載我們自己的代碼了乙帮。假定我們自己的代碼文件是main.js,也放在js目錄下面极景。那么察净,只需要寫成下面這樣就行了:
<script src="js/require.js" data-main="js/main"></script>
data-main屬性的作用是驾茴,指定網(wǎng)頁程序的主模塊。
在上例中氢卡,就是js目錄下面的main.js沟涨,這個文件會第一個被require.js加載。由于require.js默認的文件后綴名是js异吻,所以可以把main.js簡寫成main。
- 一個是把它放在網(wǎng)頁底部加載日麸,另一個是寫成下面這樣:
三喜庞、主模塊的寫法
上一節(jié)的main.js诀浪,我把它稱為"主模塊",意思是整個網(wǎng)頁的入口代碼延都。它有點像C語言的main()函數(shù)雷猪,所有代碼都從這兒開始運行。
下面就來看晰房,怎么寫main.js求摇。
- 如果我們的代碼不依賴任何其他模塊,那么可以直接寫入javascript代碼殊者。
// main.js
alert("加載成功与境!");
但這樣的話,就沒必要使用require.js了猖吴。真正常見的情況是摔刁,主模塊依賴于其他模塊,這時就要使用AMD規(guī)范定義的的require()函數(shù)海蔽。
// main.js
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
// some code here
});
> require()函數(shù)接受兩個參數(shù)共屈。第一個參數(shù):
- 一個數(shù)組,表示所依賴的模塊党窜,上例就是['moduleA', 'moduleB', 'moduleC']拗引,即主模塊依賴這三個模塊;
- 一個回調(diào)函數(shù)幌衣,當(dāng)前面指定的模塊都加載成功后矾削,它將被調(diào)用。加載的模塊會以參數(shù)形式傳入該函數(shù)泼掠,從而在回調(diào)函數(shù)內(nèi)部就可以使用這些模塊怔软。
require()異步加載moduleA,moduleB和moduleC择镇,瀏覽器不會失去響應(yīng)挡逼;它指定的回調(diào)函數(shù),只有前面的模塊都加載成功后腻豌,才會運行家坎,解決了依賴性的問題嘱能。
下面,我們看一個實際的例子虱疏。
-
假定主模塊依賴jquery惹骂、underscore和backbone這三個模塊,main.js就可以這樣寫:
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
// some code here
});require.js會先加載jQuery做瞪、underscore和backbone对粪,然后再運行回調(diào)函數(shù)。主模塊的代碼就寫在回調(diào)函數(shù)中装蓬。
四著拭、模塊的加載
上一節(jié)最后的示例中,主模塊的依賴模塊是['jquery', 'underscore', 'backbone']牍帚。默認情況下儡遮,require.js假定這三個模塊與main.js在同一個目錄,文件名分別為jquery.js暗赶,underscore.js和backbone.js鄙币,然后自動加載。
-
使用require.config()方法蹂随,我們可以對模塊的加載行為進行自定義十嘿。require.config()就寫在主模塊(main.js)的頭部垦巴。參數(shù)就是一個對象婿牍,這個對象的paths屬性指定各個模塊的加載路徑。
require.config({
paths: {
"jquery": "jquery.min",
"underscore": "underscore.min",
"backbone": "backbone.min"
}
});上面的代碼給出了三個模塊的文件名恢共,路徑默認與main.js在同一個目錄(js子目錄)浸锨。如果這些模塊在其他目錄唇聘,比如js/lib目錄,則有兩種寫法柱搜。
一種是逐一指定路徑迟郎。
require.config({
baseUrl: "js/lib",
paths: {"jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min"}
});-
另一種則是直接改變基目錄(baseUrl)。
require.config({ baseUrl: "js/lib", paths: { "jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min" } });
如果某個模塊在另一臺主機上聪蘸,也可以直接指定它的網(wǎng)址宪肖,比如:
require.config({
paths: {
"jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"
}
});-
require.js要求:
每個模塊是一個單獨的js文件。這樣的話健爬,如果加載多個模塊控乾,就會發(fā)出多次HTTP請求,會影響網(wǎng)頁的加載速度娜遵。因此蜕衡,require.js提供了一個優(yōu)化工具,當(dāng)模塊部署完畢以后设拟,可以用這個工具將多個模塊合并在一個文件中慨仿,減少HTTP請求數(shù)久脯。
五、AMD模塊的寫法
require.js加載的模塊镰吆,采用AMD規(guī)范帘撰。也就是說,模塊必須按照AMD的規(guī)定來寫万皿。
具體來說摧找,就是模塊必須采用特定的define()函數(shù)來定義。如果一個模塊不依賴其他模塊牢硅,那么可以直接定義在define()函數(shù)之中慰于。
-
假定現(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()函數(shù)的第一個參數(shù)佳励,必須是一個數(shù)組,指明該模塊的依賴性蛆挫。
define(['myLib'], function(myLib){
function foo(){
myLib.doSomething();
}
return {
foo : foo
};
});當(dāng)require()函數(shù)加載上面這個模塊的時候赃承,就會先加載myLib.js文件。
六悴侵、加載非規(guī)范的模塊
理論上瞧剖,require.js加載的模塊,必須是按照AMD規(guī)范可免、用define()函數(shù)定義的模塊抓于。但是實際上,雖然已經(jīng)有一部分流行的函數(shù)庫(比如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值(輸出的變量名),表明這個模塊外部調(diào)用時的名稱筐摘;(2)deps數(shù)組卒茬,表明該模塊的依賴性。
比如咖熟,jQuery的插件可以這樣定義:shim: { 'jquery.scroll': { deps: ['jquery'], exports: 'jQuery.fn.scroll' } }
七圃酵、require.js插件
require.js還提供一系列插件,實現(xiàn)一些特定的功能:
-
domready插件馍管,可以讓回調(diào)函數(shù)在頁面DOM結(jié)構(gòu)加載完成后再運行郭赐。
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文件。