javascript 子產品化程式設計 require.js

一、為什麼要用require.js？

最早的時候，所有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>

這段代碼依次加載多個js檔案。

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

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

　　

　　（1）實作js檔案的異步加載，避免網頁失去響應； 　　（2）管理子產品之間的依賴性，便于代碼的編寫和維護。

二、require.js的加載

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

　　<script src="js/require.js"></script>

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

　　<script src="js/require.js" defer async="true" ></script>

async屬性表明這個檔案需要異步加載，避免網頁失去響應。ie不支援這個屬性，隻支援defer，是以把defer也寫上。

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

　　<script src="js/require.js" data-main="js/main"></script>

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

三、主子產品的寫法

上一節的main.js，我把它稱為"主子產品"，意思是整個網頁的入口代碼。它有點像c語言的main()函數，所有代碼都從這兒開始運作。

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

如果我們的代碼不依賴任何其他子產品，那麼可以直接寫入javascript代碼。

　　// main.js 　　alert("加載成功！");

但這樣的話，就沒必要使用require.js了。真正常見的情況是，主子產品依賴于其他子產品，這時就要使用amd規範定義的的require()函數。

　　require(['modulea', 'moduleb', 'modulec'], function (modulea, moduleb, modulec){ 　　　　// some code here 　　});

require()函數接受兩個參數。第一個參數是一個數組，表示所依賴的子產品，上例就是['modulea', 'moduleb', 'modulec']，即主子產品依賴這三個子產品；第二個參數是一個回調函數，目前面指定的子產品都加載成功後，它将被調用。加載的子產品會以參數形式傳入該函數，進而在回調函數内部就可以使用這些子產品。

require()異步加載modulea，moduleb和modulec，浏覽器不會失去響應；它指定的回調函數，隻有前面的子產品都加載成功後，才會運作，解決了依賴性的問題。

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

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

　　require(['jquery', 'underscore', 'backbone'], function ($, _, backbone){

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屬性指定各個子產品的加載路徑。

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

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

　　　　　　"jquery": "lib/jquery.min", 　　　　　　"underscore": "lib/underscore.min", 　　　　　　"backbone": "lib/backbone.min"

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

　　　　baseurl: "js/lib",

如果某個子產品在另一台主機上，也可以直接指定它的網址，比如：

　　　　　　"jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"

五、amd子產品的寫法

require.js加載的子產品，采用amd規範。也就是說，子產品必須按照amd的規定來寫。

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

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

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

加載方法如下：

　　require(['math'], function (math){ 　　　　alert(math.add(1,1));

如果這個子產品還依賴其他子產品，那麼define()函數的第一個參數，必須是一個數組，指明該子產品的依賴性。

　　define(['mylib'], function(mylib){ 　　　　function foo(){ 　　　　　　mylib.dosomething(); 　　　　　　foo : foo

當require()函數加載上面這個子產品的時候，就會先加載mylib.js檔案。

六、加載非規範的子產品

理論上，require.js加載的子產品，必須是按照amd規範、用define()函數定義的子產品。但是實際上，雖然已經有一部分流行的函數庫（比如jquery）符合amd規範，更多的庫并不符合。那麼，require.js是否能夠加載非規範的子產品呢？

回答是可以的。

這樣的子產品在用require()加載之前，要先用require.config()方法，定義它們的一些特征。

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

　　　　shim: { 　　　　　　'underscore':{ 　　　　　　　　exports: '_' 　　　　　　}, 　　　　　　'backbone': { 　　　　　　　　deps: ['underscore', 'jquery'], 　　　　　　　　exports: 'backbone' 　　　　　　}

require.config()接受一個配置對象，這個對象除了有前面說過的paths屬性之外，還有一個shim屬性，專門用來配置不相容的子產品。具體來說，每個子產品要定義（1）exports值（輸出的變量名），表明這個子產品外部調用時的名稱；（2）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插件，則是允許require.js加載文本和圖檔檔案。

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

類似的插件還有json和mdown，用于加載json檔案和markdown檔案。