Javascript模組化程式設計（三）：require.js的用法

來源：阮一峰的部落格

這個系列的第一部分和第二部分，介紹了Javascript模組原型和理論概念，今天介紹如何將它們用於實戰。

我採用的是一個非常流行的庫require.js。

一、為什麼要用require.js？

最早的時候，所有Javascript程式碼都寫在一個檔案裡面，只要載入這一個檔案就夠了。後來，程式碼越來越多，一個檔案不夠了，必須分成多個檔案，依次載入。下面的網頁程式碼，相信很多人都見過。

JavaScript

<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>

1 2 3 4 5 6

<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檔案。

這樣的寫法有很大的缺點。首先，載入的時候，瀏覽器會停止網頁渲染，載入檔案越多，網頁失去響應的時間就會越長；其次，由於js檔案之間存在依賴關係，因此必須嚴格保證載入順序（比如上例的1.js要在2.js的前面），依賴性最大的模組一定要放到最後載入，當依賴關係很複雜的時候，程式碼的編寫和維護都會變得困難。

require.js的誕生，就是為了解決這兩個問題：

（1）實現js檔案的非同步載入，避免網頁失去響應；

（2）管理模組之間的依賴性，便於程式碼的編寫和維護。

二、require.js的載入

使用require.js的第一步，是先去官方網站下載最新版本。

下載後，假定把它放在js子目錄下面，就可以載入了

有人可能會想到，載入這個檔案，也可能造成網頁失去響應。解決辦法有兩個，一個是把它放在網頁底部載入，另一個是寫成下面這樣：

async屬性表明這個檔案需要非同步載入，避免網頁失去響應。IE不支援這個屬性，只支援defer，所以把defer也寫上。

載入require.js以後，下一步就要載入我們自己的程式碼了。假定我們自己的程式碼檔案是main.js，也放在js目錄下面。那麼，只需要寫成下面這樣就行了：

data-main屬性的作用是，指定網頁程式的主模組。在上例中，就是js目錄下面的main.js，這個檔案會第一個被require.js載入。由於require.js預設的檔案字尾名是js，所以可以把main.js簡寫成main。

三、主模組的寫法

上一節的main.js，我把它稱為”主模組”，意思是整個網頁的入口程式碼。它有點像C語言的main()函式，所有程式碼都從這兒開始執行。

下面就來看，怎麼寫main.js。

如果我們的程式碼不依賴任何其他模組，那麼可以直接寫入javascript程式碼

但這樣的話，就沒必要使用require.js了。真正常見的情況是，主模組依賴於其他模組，這時就要使用AMD規範定義的的require()函式。

JavaScript

　　// main.js 　　require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){ 　　　　// some code here 　　});

1 2 3 4

// main.js 　　require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){ 　　　　// some code here 　　});

require()函式接受兩個引數。第一個引數是一個陣列，表示所依賴的模組，上例就是[‘moduleA’, ‘moduleB’, ‘moduleC’]，即主模組依賴這三個模組；第二個引數是一個回撥函式，當前面指定的模組都載入成功後，它將被呼叫。載入的模組會以引數形式傳入該函式，從而在回撥函式內部就可以使用這些模組。

require()非同步載入moduleA，moduleB和moduleC，瀏覽器不會失去響應；它指定的回撥函式，只有前面的模組都載入成功後，才會執行，解決了依賴性的問題。

下面，我們看一個實際的例子。

假定主模組依賴jquery、underscore和backbone這三個模組，main.js就可以這樣寫：

JavaScript

　　require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){ 　　　　// some code here 　　});

1 2 3

require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){ 　　　　// some code here 　　});

require.js會先載入jQuery、underscore和backbone，然後再執行回撥函式。主模組的程式碼就寫在回撥函式中。

四、模組的載入

上一節最後的示例中，主模組的依賴模組是[‘jquery’, ‘underscore’, ‘backbone’]。預設情況下，require.js假定這三個模組與main.js在同一個目錄，檔名分別為jquery.js，underscore.js和backbone.js，然後自動載入。

使用require.config()方法，我們可以對模組的載入行為進行自定義。require.config()就寫在主模組（main.js）的頭部。引數就是一個物件，這個物件的paths屬性指定各個模組的載入路徑。

JavaScript

　　require.config({ 　　　　paths: { 　　　　　　"jquery": "jquery.min.js", 　　　　　　"underscore": "underscore.min.js", 　　　　　　"backbone": "backbone.min.js" 　　　　} 　　});

1 2 3 4 5 6 7

require.config({ 　　　　paths: { 　　　　　　"jquery": "jquery.min.js", 　　　　　　"underscore": "underscore.min.js", 　　　　　　"backbone": "backbone.min.js" 　　　　} 　　});

上面的程式碼給出了三個模組的檔名，路徑預設與main.js在同一個目錄（js子目錄）。如果這些模組在其他目錄，比如js/lib目錄，則有兩種寫法。一種是逐一指定路徑。

JavaScript

　　require.config({ 　　　　paths: { 　　　　　　"jquery": "<strong>lib/</strong>jquery.min.js", 　　　　　　"underscore": "<strong>lib/</strong>underscore.min.js", 　　　　　　"backbone": "<strong>lib/</strong>backbone.min.js" 　　　　} 　　});

1 2 3 4 5 6 7

require.config({ 　　　　paths: { 　　　　　　"jquery": "<strong>lib/</strong>jquery.min.js", 　　　　　　"underscore": "<strong>lib/</strong>underscore.min.js", 　　　　　　"backbone": "<strong>lib/</strong>backbone.min.js" 　　　　} 　　});

另一種則是直接改變基目錄（baseUrl）。

JavaScript

　　require.config({ 　　　　<strong>baseUrl: "js/lib",</strong> 　　　　paths: { 　　　　　　"jquery": "jquery.min.js", 　　　　　　"underscore": "underscore.min.js", 　　　　　　"backbone": "backbone.min.js" 　　　　} 　　});

1 2 3 4 5 6 7 8

require.config({ 　　　　<strong>baseUrl: "js/lib",</strong> 　　　　paths: { 　　　　　　"jquery": "jquery.min.js", 　　　　　　"underscore": "underscore.min.js", 　　　　　　"backbone": "backbone.min.js" 　　　　} 　　});

如果某個模組在另一臺主機上，也可以直接指定它的網址，比如：

JavaScript

　　require.config({ 　　　　paths: { 　　　　　　"jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min" 　　　　} 　　});

1 2 3 4 5

require.config({ 　　　　paths: { 　　　　　　"jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min" 　　　　} 　　});

require.js要求，每個模組是一個單獨的js檔案。這樣的話，如果載入多個模組，就會發出多次HTTP請求，會影響網頁的載入速度。因此，require.js提供了一個優化工具，當模組部署完畢以後，可以用這個工具將多個模組合併在一個檔案中，減少HTTP請求數。

五、AMD模組的寫法

require.js載入的模組，採用AMD規範。也就是說，模組必須按照AMD的規定來寫。

具體來說，就是模組必須採用特定的define()函式來定義。如果一個模組不依賴其他模組，那麼可以直接定義在define()函式之中。

假定現在有一個math.js檔案，它定義了一個math模組。那麼，math.js就要這樣寫：

JavaScript

　　// math.js 　　define(function (){ 　　　　var add = function (x,y){ 　　　　　　return x+y; 　　　　}; 　　　　return { 　　　　　　add: add 　　　　}; 　　});

1 2 3 4 5 6 7 8 9

// math.js 　　define(function (){ 　　　　var add = function (x,y){ 　　　　　　return x+y; 　　　　}; 　　　　return { 　　　　　　add: add 　　　　}; 　　});

載入方法如下：

JavaScript

　　// main.js 　　require(['math'], function (math){ 　　　　alert(math.add(1,1)); 　　});

1 2 3 4

// main.js 　　require(['math'], function (math){ 　　　　alert(math.add(1,1)); 　　});

如果這個模組還依賴其他模組，那麼define()函式的第一個引數，必須是一個陣列，指明該模組的依賴性。

JavaScript

　　define(['myLib'], function(myLib){ 　　　　function foo(){ 　　　　　　myLib.doSomething(); 　　　　} 　　　　return { 　　　　　　foo : foo 　　　　}; 　　});

1 2 3 4 5 6 7 8

define(['myLib'], function(myLib){ 　　　　function foo(){ 　　　　　　myLib.doSomething(); 　　　　} 　　　　return { 　　　　　　foo : foo 　　　　}; 　　});

當require()函式載入上面這個模組的時候，就會先載入myLib.js檔案。

六、載入非規範的模組

理論上，require.js載入的模組，必須是按照AMD規範、用define()函式定義的模組。但是實際上，雖然已經有一部分流行的函式庫（比如jQuery）符合AMD規範，更多的庫並不符合。那麼，require.js是否能夠載入非規範的模組呢？

回答是可以的。

這樣的模組在用require()載入之前，要先用require.config()方法，定義它們的一些特徵。

舉例來說，underscore和backbone這兩個庫，都沒有采用AMD規範編寫。如果要載入它們的話，必須先定義它們的特徵。

JavaScript

　　require.config({ 　　　　shim: { 　　　　　　'underscore':{ 　　　　　　　　exports: '_' 　　　　　　}, 　　　　　　'backbone': { 　　　　　　　　deps: ['underscore', 'jquery'], 　　　　　　　　exports: 'Backbone' 　　　　　　} 　　　　} 　　});

1 2 3 4 5 6 7 8 9 10 11 12

require.config({ 　　　　shim: {   　　　　　　'underscore':{ 　　　　　　　　exports: '_' 　　　　　　}, 　　　　　　'backbone': { 　　　　　　　　deps: ['underscore', 'jquery'], 　　　　　　　　exports: 'Backbone' 　　　　　　} 　　　　} 　　});

require.config()接受一個配置物件，這個物件除了有前面說過的paths屬性之外，還有一個shim屬性，專門用來配置不相容的模組。具體來說，每個模組要定義（1）exports值（輸出的變數名），表明這個模組外部呼叫時的名稱；（2）deps陣列，表明該模組的依賴性。

比如，jQuery的外掛可以這樣定義：

JavaScript

　　shim: { 　　　　'jquery.scroll': { 　　　　　　deps: ['jquery'], 　　　　　　exports: 'jQuery.fn.scroll' 　　　　} 　　}

1 2 3 4 5 6

shim: { 　　　　'jquery.scroll': { 　　　　　　deps: ['jquery'], 　　　　　　exports: 'jQuery.fn.scroll' 　　　　} 　　}

七、require.js外掛

require.js還提供一系列外掛，實現一些特定的功能。

domready外掛，可以讓回撥函式在頁面DOM結構載入完成後再執行。

JavaScript

　　require(['domready!'], function (doc){ 　　　　// called once the DOM is ready 　　});

1 2 3

require(['domready!'], function (doc){ 　　　　// called once the DOM is ready 　　});

text和image外掛，則是允許require.js載入文字和圖片檔案。

JavaScript

　　define([ 　　　　'text!review.txt', 　　　　'image!cat.jpg' 　　　　], 　　　　function(review,cat){ 　　　　　　console.log(review); 　　　　　　document.body.appendChild(cat); 　　　　} 　　);

1 2 3 4 5 6 7 8 9 10

define([ 　　　　'text!review.txt', 　　　　'image!cat.jpg' 　　　　],   　　　　function(review,cat){ 　　　　　　console.log(review); 　　　　　　document.body.appendChild(cat); 　　　　} 　　);

類似的外掛還有json和mdown，用於載入json檔案和markdown檔案。