Javascript模組化編程(三)require.js的用法及功能介紹

這個系列的第一部分和第二部分，介紹了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的載入
使用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()函數。
　　// 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就可以這樣寫： 複製代碼 代碼如下:　　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屬性指定各個模組的載入路徑。 複製代碼 代碼如下:　　require.config({
　　　　paths: {
　　　　　　"jquery": "jquery.min",
　　　　　　"underscore": "underscore.min",
　　　　　　"backbone": "backbone.min"
　　　　}
　　});

上面的代碼給出了三個模組的檔案名稱，路徑預設與main.js在同一個目錄（js子目錄）。如果這些模組在其他目錄，比如js/lib目錄，則有兩種寫法。一種是逐一指定路徑。 複製代碼 代碼如下:　　require.config({
　　　　paths: {
　　　　　　"jquery": "lib/jquery.min",
　　　　　　"underscore": "lib/underscore.min",
　　　　　　"backbone": "lib/backbone.min"
　　　　}
　　});

另一種則是直接改變基目錄（baseUrl）。 複製代碼 代碼如下:　　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提供了一個最佳化工具，當模組部署完畢以後，可以用這個工具將多個模組合并在一個檔案中，減少HTTP請求數。
五、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
　　　　};
　　});

載入方法如下：
　　// 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()函數定義的模組。但是實際上，雖然已經有一部分流行的函數庫（比如jQuery）符合AMD規範，更多的庫並不符合。那麼，require.js是否能夠載入非規範的模組呢？
回答是可以的。
這樣的模組在用require()載入之前，要先用require.config()方法，定義它們的一些特徵。
舉例來說，underscore和backbone這兩個庫，都沒有採用AMD規範編寫。如果要載入它們的話，必須先定義它們的特徵。 複製代碼 代碼如下:　　require.config({
　　　　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外掛程式
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檔案。
（完）