RequireJS是一個(gè)非常小巧的JavaScript模塊載入框架章鲤,是AMD規(guī)范最好的實(shí)現(xiàn)者之一。最新版本的RequireJS壓縮后只有14K咆贬,堪稱非常輕量败徊。它還同時(shí)可以和其他的框架協(xié)同工作,使用RequireJS必將使您的前端代碼質(zhì)量得以提升素征。
requirejs的基本功能"模塊化加載"集嵌。
requirejs具有防止js加載阻塞頁面渲染優(yōu)點(diǎn)。
基本API
require會定義三個(gè)變量:define,require,requirejs
其中require === requirejs御毅,一般使用require更簡短
define 從名字就可以看出這個(gè)api是用來定義一個(gè)模塊
require 加載依賴模塊根欧,并執(zhí)行加載完后的回調(diào)函數(shù)
通過define函數(shù)定義了一個(gè)模塊a.js:
define(function(){
function fun1(){
alert("it works");
}
fun1();
})
然后再頁面中使用:
require(["js/a"]);
來加載該模塊(注意require中的依賴是一個(gè)數(shù)組,即使只有一個(gè)依賴端蛆,你也必須使用數(shù)組來定義)凤粗,requir API的第二個(gè)參數(shù)是callback,一個(gè)function今豆,是用來處理加載完畢后的邏輯嫌拣,如:
require(["js/a"],function(){
alert("load finished");
})
加載文件
之前的例子中加載模塊都是本地js,但是大部分情況下網(wǎng)頁需要加載的JS可能來自本地服務(wù)器呆躲、其他網(wǎng)站或CDN异逐,這樣就不能通過這種方式來加載了,我們以加載一個(gè)jquery庫為例:
require.config({
paths : {
"jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"]
}
})
require(["jquery","js/a"],function($){
$(function(){
alert("load finished");
})
})
這邊涉及了require.config插掂,require.config是用來配置模塊加載位置灰瞻,簡單點(diǎn)說就是給模塊起一個(gè)更短更好記的名字,比如將百度的jquery庫地址標(biāo)記為jquery辅甥,這樣在require時(shí)只需要寫["jquery"]就可以加載該js酝润,本地的js我們也可以這樣配置:
require.config({
paths : {
"jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"],
"a" : "js/a"
}
})
require(["jquery","a"],function($){
$(function(){
alert("load finished");
})
})
通過paths的配置會使我們的模塊名字更精煉,paths還有一個(gè)重要的功能璃弄,就是可以配置多個(gè)路徑要销,如果遠(yuǎn)程cdn庫沒有加載成功,可以加載本地的庫夏块,如:
require.config({
paths : {
"jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
"a" : "js/a"
}
})
require(["jquery","a"],function($){
$(function(){
alert("load finished");
})
})
這樣配置后疏咐,當(dāng)百度的jquery沒有加載成功后,會加載本地js目錄下的jquery
- 在使用requirejs時(shí)脐供,加載模塊時(shí)不用寫.js后綴的凳鬓,當(dāng)然也是不能寫后綴
- 上面例子中的callback函數(shù)中發(fā)現(xiàn)有$參數(shù),這個(gè)就是依賴的jquery模塊的輸出變量患民,如果你依賴多個(gè)模塊,可以依次寫入多個(gè)參數(shù)來使用:
require(["jquery","underscore"],function($, _){
$(function(){
_.each([1,2,3],alert);
})
})
如果某個(gè)模塊不輸出變量值垦梆,則沒有匹颤,所以盡量將輸出的模塊寫在前面仅孩,防止位置錯(cuò)亂引發(fā)誤解
全局配置
上面的例子中重復(fù)出現(xiàn)了require.config配置,如果每個(gè)頁面中都加入配置印蓖,必然顯得十分不雅辽慕,requirejs提供了一種叫"主數(shù)據(jù)"的功能,我們首先創(chuàng)建一個(gè)main.js:
require.config({
paths : {
"jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
"a" : "js/a"
}
})
然后再頁面中使用下面的方式來使用requirejs:
<script data-main="js/main" src="js/require.js"></script>
加載requirejs腳本的script標(biāo)簽加入了data-main屬性赦肃,這個(gè)屬性指定的js將在加載完reuqire.js后處理溅蛉,我們把require.config的配置加入到data-main后,就可以使每一個(gè)頁面都使用這個(gè)配置他宛,然后頁面中就可以直接使用require來加載所有的短模塊名
data-main還有一個(gè)重要的功能船侧,當(dāng)script標(biāo)簽指定data-main屬性時(shí),require會默認(rèn)的將data-main指定的js為根路徑厅各,是什么意思呢镜撩?如上面的data-main="js/main"設(shè)定后,我們在使用require(['jquery'])后(不配置jquery的paths)队塘,require會自動(dòng)加載js/jquery.js這個(gè)文件袁梗,而不是jquery.js,相當(dāng)于默認(rèn)配置了:
require.config({
baseUrl : "js"
})
第三方模塊
通過require加載的模塊一般都需要符合AMD規(guī)范即使用define來申明模塊憔古,但是部分時(shí)候需要加載非AMD規(guī)范的js遮怜,這時(shí)候就需要用到另一個(gè)功能:shim,shim直接翻譯為"墊"鸿市,其實(shí)也是有這層意思的锯梁,目前我主要用在兩個(gè)地方
- 非AMD模塊輸出,將非標(biāo)準(zhǔn)的AMD模塊"墊"成可用的模塊灸芳,例如:在老版本的jquery中涝桅,是沒有繼承AMD規(guī)范的,所以不能直接require["jquery"],這時(shí)候就需要shim烙样,比如我要是用underscore類庫冯遂,但是他并沒有實(shí)現(xiàn)AMD規(guī)范,那我們可以這樣配置
require.config({
shim: {
"underscore" : {
exports : "_";
}
}
})
這樣配置后谒获,我們就可以在其他模塊中引用underscore模塊:
require(["underscore"], function(_){
_.each([1,2,3], alert);
})
插件形式的非AMD模塊蛤肌,我們經(jīng)常會用到j(luò)query插件,而且這些插件基本都不符合AMD規(guī)范批狱,比如jquery.form插件裸准,這時(shí)候就需要將form插件"墊"到j(luò)query中:
require.config({
shim: {
"underscore" : {
exports : "_";
},
"jquery.form" : {
deps : ["jquery"]
}
}
})
也可以簡寫為:
require.config({
shim: {
"underscore" : {
exports : "_";
},
"jquery.form" : ["jquery"]
}
})
這樣配置之后我們就可以使用加載插件后的jquery了
require.config(["jquery", "jquery.form"], function($){
$(function(){
$("#form").ajaxSubmit({...});
})
})