DIV CSS 佈局教程網

JavaScript 模組化程式設計(三):require.js 用法詳解
編輯:JavaScript基礎知識     

系列前兩篇介紹了 JavaScript 模組的寫法與 AMD 規範,本篇要談如何把它落實到實戰,使用的手法是目前相當流行的 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>

這種寫法有兩個嚴重缺點。第一,載入時瀏覽器會停止網頁渲染,檔案越多,無回應的時間越長。第二,檔案之間存在依賴關係,必須嚴格保證順序,依賴最深的模組一定要放最後;當依賴關係變複雜,撰寫與維護都成噩夢。

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 不支援 async 只支援 defer,因此兩者都寫上。

接著載入自己的程式碼,假設進入點是 main.js:

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

data-main 用來指定主模組,require.js 會第一個載入它。由於預設副檔名是 js,main.js 可以簡寫為 main。

三、主模組的寫法

main.js 相當於 C 語言的 main() 函式,是所有程式碼的起點。若不依賴其他模組,直接寫 JavaScript 即可:

// main.js
alert("載入成功!");

但這樣就失去了使用 require.js 的意義。真實情況通常是主模組依賴其他模組,這時要用 AMD 規範的 require() 函式:

// main.js
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC) {
    // 這裡寫主模組的程式碼
});

require() 接受兩個參數:第一個是相依模組組成的陣列,第二個是回呼函式。只有當所有相依模組都載入成功後,回呼才會被執行,模組會以參數形式傳入。如此一來,異步載入不會讓瀏覽器無回應,依賴順序也不需人工維護。

實際例子:主模組依賴 jQuery、underscore 與 backbone。

require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone) {
    // 這裡寫主模組的程式碼
});

四、模組的載入路徑

預設情況下,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"
    }
});

若模組放在 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 要求每個模組獨立成一個檔案,載入多個模組就會發出多次 HTTP 請求。因此它提供了優化工具,部署完成後可把多個模組合併為單一檔案,減少請求數。

五、AMD 模組的寫法

require.js 載入的模組必須依 AMD 規範撰寫,也就是用 define() 定義。若模組不依賴其他模組,可直接寫在 define() 中:

// 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 只能載入以 define() 撰寫的 AMD 模組。實務上,符合 AMD 的函式庫(如 jQuery)終究是少數,多數老舊函式庫並不符合。此時可以先用 require.config() 的 shim 屬性描述它們的特徵:

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

每個模組需要定義 exports(對外輸出的變數名)與 deps(相依模組陣列)。jQuery 外掛也是同樣道理:

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

七、require.js 外掛

domready 外掛可讓回呼在 DOM 就緒後才執行:

require(['domready!'], function (doc) {
    // DOM 就緒後才會呼叫
});

text 與 image 外掛則允許載入文字與圖片檔:

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

同類外掛還有 json 與 mdown,分別用於載入 JSON 與 Markdown 檔。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved