前一篇:JS模塊化工具requirejs教程(一):初識requirejs我們以非常簡單的方式引入了requirejs,這一篇將講述一下requirejs中的一些基本知識,包括API使用方式等 基本API require會定義三個變數:define,require,requirejs,其中requi ...
前一篇:JS模塊化工具requirejs教程(一):初識requirejs我們以非常簡單的方式引入了requirejs,這一篇將講述一下requirejs中的一些基本知識,包括API使用方式等
基本API
require會定義三個變數:define,require,requirejs,其中require === requirejs,一般使用require更簡短
- define 從名字就可以看出這個api是用來定義一個模塊
- require 載入依賴模塊,並執行載入完後的回調函數
前一篇中的a.js:
define(function(){ function fun1(){ alert("it works"); } fun1(); })
通過define函數定義了一個模塊,然後再頁面中使用:
require(["js/a"]);
來載入該模塊(註意require中的依賴是一個數組,即使只有一個依賴,你也必須使用數組來定義),requir API的第二個參數是callback,一個function,是用來處理載入完畢後的邏輯,如:
require(["js/a"],function(){ alert("load finished"); })
載入文件
之前的例子中載入模塊都是本地js,但是大部分情況下網頁需要載入的JS可能來自本地伺服器、其他網站或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函數中發現有
$
參數,這個就是依賴的jquery
模塊的輸出變數,如果你依賴多個模塊,可以依次寫入多個參數來使用:
require(["jquery","underscore"],function($, _){ $(function(){ _.each([1,2,3],alert); }) })
如果某個模塊不輸出變數值,則沒有,所以儘量將輸出的模塊寫在前面,防止位置錯亂引發誤解
全局配置
上面的例子中重覆出現了require.config
配置,如果每個頁面中都加入配置,必然顯得十分不雅,requirejs提供了一種叫"主數據"的功能,我們首先創建一個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"
設定後,我們在使用require(['jquery'])
後(不配置jquery的paths),require會自動載入js/jquery.js這個文件,而不是jquery.js,相當於預設配置了:
require.config({ baseUrl : "js" })
第三方模塊
通過require
載入的模塊一般都需要符合AMD規範即使用define
來申明模塊,但是部分時候需要載入非AMD規範的js,這時候就需要用到另一個功能:shim,shim解釋起來也比較難理解,shim直接翻譯為"墊",其實也是有這層意思的,目前我主要用在兩個地方
1. 非AMD模塊輸出,將非標準的AMD模塊"墊"成可用的模塊,例如:在老版本的jquery中,是沒有繼承AMD規範的,所以不能直接require["jquery"],這時候就需要shim,比如我要是用underscore類庫,但是他並沒有實現AMD規範,那我們可以這樣配置
require.config({ shim: { "underscore" : { exports : "_"; } } })
這樣配置後,我們就可以在其他模塊中引用underscore模塊:
require(["underscore"], function(_){ _.each([1,2,3], alert); })
- 插件形式的非AMD模塊,我們經常會用到jquery插件,而且這些插件基本都不符合AMD規範,比如jquery.form插件,這時候就需要將form插件"墊"到jquery中:
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的基本配置大致就是這麼多,還有一些擴展的功能會在之後的篇幅中提到
文章來源:https://github.com/liuxey/blog/issues/2