RequireJS 是一個 JavaScript 文件與模塊加載器。它讓你能把代碼拆分成獨立文件與模塊,同時自動管理模塊之間的依賴關係。它的設計目標是推動代碼模塊化,並用一套有別於傳統 <script> 標籤的加載方式,來提升加載速度與代碼質量。
最早所有 JS 代碼都塞在一個文件裡,加載一次就夠了。後來代碼膨脹,不得不拆成多個文件依次引入,於是常見到這種寫法:
<script src="1.js"></script> <script src="2.js"></script> <script src="3.js"></script> <script src="4.js"></script> <script src="5.js"></script> <script src="6.js"></script>
問題有兩個。其一,加載期間瀏覽器會停止網頁渲染,文件越多,頁面失去響應的時間越長。其二,js 文件之間存在依賴,必須嚴格保證順序(例如 1.js 一定得在 2.js 之前),依賴最深的模塊要放到最後,一旦關係變複雜,編寫和維護都成噩夢。
require.js 正是為了解決這兩件事而出現:實現 js 的異步加載以避免頁面卡死;集中管理模塊依賴以降低維護成本。
第一步是從官網下載最新版本。假設放在 js 子目錄下,引入方式為:
<script src="js/require.js"></script>
你可能會擔心,加載它本身也會阻塞頁面。有兩個解法:放到網頁底部,或寫成:
<script src="js/require.js" defer async="true" ></script>
async 表示異步加載,避免失去響應;IE 不支援該屬性但支援 defer,所以兩個都寫上。
引入之後,下一步是加載自己的代碼。若入口文件是 js 目錄下的 main.js:
<script src="js/require.js" data-main="js/main"></script>
data-main 用來指定主模塊。由於 require.js 默認後綴是 js,main.js 可以簡寫成 main。
main.js 我稱之為「主模塊」,也就是整個網頁的入口代碼,作用有點像 C 語言的 main(),一切從這裡開始。
如果它不依賴任何其他模塊,直接寫 JS 就好:
// main.js alert("加載成功!"); 但這樣的話,就沒必要使用require.js了。真正常見的情況是,主模塊依賴於其他模塊,這時就要使用AMD規范定義的的require()函數。 // main.js require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){ // some code here });
require() 接兩個參數:第一個是依賴模塊組成的數組,這裡表示主模塊依賴 moduleA、moduleB、moduleC;第二個是回調函數,前面指定的模塊全部加載成功後才會被調用,模塊會以參數形式傳入,方便在內部直接使用。
這樣一來,三個模塊是異步加載的,瀏覽器不會失去響應;而回調只在依賴就緒後執行,依賴問題也一併解決。
實際的例子,假設主模塊依賴 jquery、underscore、backbone:
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){ // some code here });
require.js 會先加載這三個庫,再運行回調,主模塊的業務邏輯就寫在回調裡。
默認情況下,require.js 認為這三個模塊與 main.js 同目錄,文件名分別是 jquery.js、underscore.js、backbone.js。想自定義行為,就在主模塊頭部調用 require.config(),用其中的 paths 屬性指定各模塊路徑:
require.config({ paths: { "jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min" } });
此時路徑默認相對於 main.js 所在目錄。如果模塊放在 js/lib 下,可以逐一指定,也可以直接改基目錄:
require.config({ baseUrl: "js/lib", paths: {"jquery": "jquery.min", "underscore": "underscore.min", "backbone": "backbone.min"} });
若模塊在別的主機上,直接寫完整網址即可:
require.config({ paths: { "jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min" } });
要注意,require.js 要求每個模塊對應一個獨立 js 文件。模塊一多,HTTP 請求數就跟著上升,反而拖慢加載。因此官方另外提供了優化工具,部署時可以把多個模塊合併打包,減少請求次數。
require.js 加載的模塊必須遵循 AMD 規範,也就是用 define() 來定義。若模塊不依賴其他模塊,直接寫在 define() 裡即可。以 math.js 為例:
// math.js define(function (){ var add = function (x,y){ return x+y; }; return { add: add }; });
使用方式:
// main.js require(['math'], function (math){ alert(math.add(1,1)); });
若模塊本身還有依賴,define() 的第一個參數必須是依賴數組:
define(['myLib'], function(myLib){ function foo(){ myLib.doSomething(); } return { foo : foo }; });
這樣在 require 該模塊時,會先被加載 myLib.js。
理論上 require.js 只能加載按 AMD 用 define() 定義的模塊,但現實中大量老庫(underscore、backbone 就是典型)並不合規。好消息是仍然可以加載,只需事先用 require.config() 描述它們的特徵:
require.config({ shim: { 'underscore': { exports: '_' }, 'backbone': { deps: ['underscore', 'jquery'], exports: 'Backbone' } } });
配置對象裡的 shim 屬性專門用於此。每個模塊要聲明兩件事:exports(該模塊對外暴露的變量名)與 deps(依賴數組)。比如 jQuery 插件可以這樣寫:
shim: { 'jquery.scroll': { deps: ['jquery'], exports: 'jQuery.fn.scroll' } }
require.js 還提供了一系列插件來滿足特定場景。domready 讓回調等到 DOM 結構就緒後才執行:
require(['domready!'], function (doc) { // called once the DOM is ready });
text 與 image 插件則允許加載文本與圖片資源:
define([ 'text!review.txt', 'image!cat.jpg' ], function (review, cat) { console.log(review); document.body.appendChild(cat); } );
同類的還有 json、mdown,分別用來加載 json 與 markdown 文件。
以上就是本次整理的完整內容,希望對你的學習或工作有所幫助;有疑問歡迎留言交流。