基本API
require會定義三個變量:define,require,requirejs,其中require === requirejs,一般使用require更簡短
define 從名字就可以看出這個api是用來定義一個模塊
require 加載依賴模塊,并執(zhí)行加載完后的回調(diào)函數(shù)
前一篇中的a.js:
define(function(){
function fun1(){
alert("it works");
}
fun1();
})
通過define函數(shù)定義了一個模塊,然后再頁面中使用:
require(["js/a"]);
來加載該模塊(注意require中的依賴是一個數(shù)組,即使只有一個依賴,你也必須使用數(shù)組來定義),requir API的第二個參數(shù)是callback,一個function,是用來處理加載完畢后的邏輯,如:
require(["js/a"],function(){
alert("load finished");
})
加載文件
之前的例子中加載模塊都是本地js,但是大部分情況下網(wǎng)頁需要加載的JS可能來自本地服務(wù)器、其他網(wǎng)站或CDN,這樣就不能通過這種方式來加載了,我們以加載一個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是用來配置模塊加載位置,簡單點說就是給模塊起一個更短更好記的名字,比如將百度的jquery庫地址標記為jquery,這樣在require時只需要寫["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還有一個重要的功能,就是可以配置多個路徑,如果遠程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");
})
})
這樣配置后,當百度的jquery沒有加載成功后,會加載本地js目錄下的jquery
在使用requirejs時,加載模塊時不用寫.js后綴的,當然也是不能寫后綴
上面例子中的callback函數(shù)中發(fā)現(xiàn)有$參數(shù),這個就是依賴的jquery模塊的輸出變量,如果你依賴多個模塊,可以依次寫入多個參數(shù)來使用:
require(["jquery","underscore"],function($, _){
$(function(){
_.each([1,2,3],alert);
})
})
如果某個模塊不輸出變量值,則沒有,所以盡量將輸出的模塊寫在前面,防止位置錯亂引發(fā)誤解
全局配置
上面的例子中重復出現(xiàn)了require.config配置,如果每個頁面中都加入配置,必然顯得十分不雅,requirejs提供了一種叫"主數(shù)據(jù)"的功能,我們首先創(chuàng)建一個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標簽加入了data-main屬性,這個屬性指定的js將在加載完reuqire.js后處理,我們把require.config的配置加入到data-main后,就可以使每一個頁面都使用這個配置,然后頁面中就可以直接使用require來加載所有的短模塊名
data-main還有一個重要的功能,當script標簽指定data-main屬性時,require會默認的將data-main指定的js為根路徑,是什么意思呢?如上面的data-main="js/main"設(shè)定后,我們在使用require(['jquery'])后(不配置jquery的paths),require會自動加載js/jquery.js這個文件,而不是jquery.js,相當于默認配置了:
require.config({
baseUrl : "js"
})
第三方模塊
通過require加載的模塊一般都需要符合AMD規(guī)范即使用define來申明模塊,但是部分時候需要加載非AMD規(guī)范的js,這時候就需要用到另一個功能:shim,shim解釋起來也比較難理解,shim直接翻譯為"墊",其實也是有這層意思的,目前我主要用在兩個地方
1. 非AMD模塊輸出,將非標準的AMD模塊"墊"成可用的模塊,例如:在老版本的jquery中,是沒有繼承AMD規(guī)范的,所以不能直接require["jquery"],這時候就需要shim,比如我要是用underscore類庫,但是他并沒有實現(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插件,這時候就需要將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({...});
})
})
好了,requirejs的基本配置大致就是這么多,還有一些擴展的功能會在之后的篇幅中提到,大家不要錯過呀!