轉自:http://www.w3cschool.cc/w3cnote/requirejs-tutorial-1.html, http://www.w3cschool.cc/w3cnote/requirejs-tutorial-2.html
隨着網站功能逐漸豐富,網頁中的js也變得越來越復雜和臃腫,原有通過script標簽來導入一個個的js文件這種方式已經不能滿足現在互聯網開發模式,我們需要團隊協作、模塊復用、單元測試等等一系列復雜的需求。
RequireJS是一個非常小巧的JavaScript模塊載入框架,是AMD規范最好的實現者之一。最新版本的RequireJS壓縮后只有14K,堪稱非常輕量。它還同時可以和其他的框架協同工作,使用RequireJS必將使您的前端代碼質量得以提升。
requirejs能帶來什么好處
官方對requirejs的描述:
RequireJS is a JavaScript file and module loader. It is optimized for in-browser use, but it can be used in other JavaScript environments, like Rhino and Node. Using a modular script loader like RequireJS will improve the speed and quality of your code.
大致意思:
在瀏覽器中可以作為js文件的模塊加載器,也可以用在Node和Rhino環境,balabala...。這段話描述了requirejs的基本功能"模塊化加載",什么是模塊化加載?我們要從之后的篇幅中一一解釋
先來看一段常見的場景,通過示例講解如何運用requirejs
正常編寫方式
index.html:
<!DOCTYPE html> <html> <head> <script type="text/javascript" src="a.js"></script> </head> <body> <span>body</span> </body> </html>
a.js:
function fun1(){ alert("it works"); } fun1();
可能你更喜歡這樣寫
(function(){ function fun1(){ alert("it works"); } fun1(); })()
第二種方法使用了塊作用域來申明function防止污染全局變量,本質還是一樣的,當運行上面兩種例子時不知道你是否注意到,alert執行的時候,html內容是一片空白的,即<span>body</span>
並未被顯示,當點擊確定后,才出現,這就是JS阻塞瀏覽器渲染導致的結果。
requirejs寫法
當然首先要到requirejs的網站去下載js -> requirejs.rog
index.html:
<!DOCTYPE html> <html> <head> <script type="text/javascript" src="require.js"></script> <script type="text/javascript"> require(["a"]); </script> </head> <body> <span>body</span> </body> </html>
a.js:
define(function(){ function fun1(){ alert("it works"); } fun1(); })
瀏覽器提示了"it works",說明運行正確,但是有一點不一樣,這次瀏覽器並不是一片空白,body已經出現在頁面中,目前為止可以知道requirejs具有如下優點:
- 防止js加載阻塞頁面渲染
- 使用程序調用的方式加載js,防出現如下丑陋的場景
<script type="text/javascript" src="a.js"></script> <script type="text/javascript" src="b.js"></script> <script type="text/javascript" src="c.js"></script> <script type="text/javascript" src="d.js"></script> <script type="text/javascript" src="e.js"></script> <script type="text/javascript" src="f.js"></script> <script type="text/javascript" src="g.js"></script> <script type="text/javascript" src="h.js"></script> <script type="text/javascript" src="i.js"></script> <script type="text/javascript" src="j.js"></script>
前一篇: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