上一篇我們用幾行代碼把 RequireJS 跑了起來,這篇來正經聊聊它的常用 API 和配置項。
引入 RequireJS 之後,全局會多出三個變量:define、require、requirejs,其中 require 與 requirejs 完全等價,寫 require 更省事。
define 用來定義一個模塊;require 用來聲明依賴並在加載完成後執行回調。
上一篇文章裡的 a.js:
define(function(){ function fun1(){ alert("it works"); } fun1(); })
頁面中這樣調用:
require(["js/a"]);
注意依賴參數必須是數組,哪怕只有一個依賴也得用數組包起來。require 的第二個參數是 callback,用來處理加載完成後的業務邏輯:
require(["js/a"],function(){ alert("load finished"); })
前面的例子都是本地 JS,但實際項目裡,很多庫來自 CDN 或其他站點,這時候就要用到 require.config。它的作用通俗點說就是給模塊起個好記的短名字:
require.config({ paths : { "jquery" : ["https://libs.baidu.com/jquery/2.0.3/jquery"] } }) require(["jquery","js/a"],function($){ $(function(){ alert("load finished"); }) })
配置之後,require 時只寫 ["jquery"] 就行。本地文件同樣可以這麼配:
require.config({ paths : { "jquery" : ["https://libs.baidu.com/jquery/2.0.3/jquery"], "a" : "js/a" } }) require(["jquery","a"],function($){ $(function(){ alert("load finished"); }) })
paths 還有一個很實用的能力:配置多個候選路徑,形成降級方案。遠程 CDN 掛了,就自動回退到本地:
require.config({ paths : { "jquery" : ["https://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"], "a" : "js/a" } }) require(["jquery","a"],function($){ $(function(){ alert("load finished"); }) })
另外記住兩點:require 引用模塊時不寫 .js 後綴,寫了反而會出問題。
回調函數裡的 $ 參數,就是依賴的 jquery 模塊導出的變量。依賴多個模塊時按順序寫多個參數即可:
require(["jquery","underscore"],function($, _){ $(function(){ _.each([1,2,3],alert); }) })
如果某個模塊並不導出變量,對應位置的參數就沒有值,所以盡量把有輸出的模塊排在前面,避免位置錯位帶來誤解。
每個頁面都重複寫一遍 require.config 顯然不優雅。RequireJS 提供了 data-main 機制。先建一個 main.js:
require.config({ paths : { "jquery" : ["https://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"], "a" : "js/a" } })
然後頁面這樣引入:
<script data-main="js/main" src="js/require.js"></script>
data-main 指向的 JS 會在 require.js 加載完成後執行,把公共配置放在裡面,所有頁面就都能共享。
data-main 還有一個容易忽略的作用:它會被當作默認的根路徑。設定 data-main="js/main" 之後,require(['jquery']) 會去找 js/jquery.js 而不是根目錄下的 jquery.js,等價於隱式配置了:
require.config({ baseUrl : "js" })
RequireJS 加載的模塊通常要符合 AMD 規範,也就是用 define 聲明。但現實中大量老庫並不遵守,這時候就需要 shim。shim 直譯是「墊片」,用處主要有兩個。
第一種是把非標準模塊「墊」成可用模塊。比如某些版本的 underscore 沒有實現 AMD:
require.config({ shim: { "underscore" : { exports : "_"; } } })
配置之後就能正常引用:
require(["underscore"], function(_){ _.each([1,2,3], alert); })
第二種是處理 jQuery 插件這類依賴型模塊。插件通常不遵守 AMD,需要聲明它依賴於 jquery:
require.config({ shim: { "underscore" : { exports : "_"; }, "jquery.form" : { deps : ["jquery"] } } })
也可以簡寫成數組形式:
require.config({ shim: { "underscore" : { exports : "_"; }, "jquery.form" : ["jquery"] } })
這樣配置好之後,加載順序就有保障了:
require.config(["jquery", "jquery.form"], function($){ $(function(){ $("#form").ajaxSubmit({...}); }) })
RequireJS 的基礎配置大致就是這些,還有一些進階用法留到後續篇幅再聊。