DIV CSS 佈局教程網

RequireJS 入門指南:用 AMD 馴服 JavaScript 依賴
編輯:JavaScript綜合知識     

這幾年參與的專案,幾乎每一個都用上了 RequireJS,不然就是我主動建議加上它。它已經是前端模組化最常被提到的方案之一。本文說明 RequireJS 是什麼、解決什麼問題,以及三個核心 API 的用法。

先談模組與 AMD

JavaScript 模組,就是遵循單一職責原則、對外暴露一組 API 的程式碼片段。現代專案裡,每個模組通常自成一个檔案,這讓維護變清楚,卻也帶來新問題:你得時時盯著模組之間的依賴關係,並確保它們以正確順序載入,否則執行期就會炸掉。

傳統做法是用 script 標籤。被依賴者必須先載入,依賴者後載入,而 script 標籤預設是同步的。加上 async 或 defer 可以變成非同步,卻可能失去順序保證。另一條路是把所有腳本打包,但打包時你仍然得把順序排對。

AMD(Asynchronous Module Definition,非同步模組定義)就是為了解這個死結而生:讓模組與其依賴能被非同步載入,同時保住正確的執行順序。

CommonJS 則是對通用 JavaScript 模式的標準化嘗試,AMD 屬於其中一支。ECMAScript 6 也正式把 import/export 納入語言規格,而 ES Module 的種子,正是這批模組化實務經驗。

RequireJS 做了什麼

RequireJS 是一套 JavaScript 檔案與模組框架,可從官方網站下載,用 Visual Studio 的話也能透過 NuGet 取得,同時支援瀏覽器與 Node.js 這類伺服器環境。

它的運作方式並不神秘:當你宣告依賴時,RequireJS 以 head.appendChild() 動態插入 script 標籤去抓檔,等檔案都到位後,再依解析出的依賴拓撲決定呼叫順序。也就是說,你只需要指定一個「根」入口,剩下的交給它。前提是所有模組都得依 RequireJS 的 API 撰寫,否則行為會不如預期。

三個核心函式

API 掛在 requirejs 命名空間下,但主要三個都是全域函式:

  • define——定義模組。每個模組有唯一 ID。
  • require——載入依賴,但不建立模組。
  • config——設定 RequireJS 行為。

data-main:程式的起跑線

RequireJS 載入後,第一件事是找 data-main 屬性指定的腳本。這個屬性同時用來設定所有模組的根路徑,RequireJS 會依此去抓其他相關模組。

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

宣告依賴時不需要寫 .js 副檔名,RequireJS 會自行補上。

config:把路徑與相容性安排好

幾個最常用到的設定:

  • baseUrl——載入模組的根路徑。
  • paths——把不在根路徑下的模組對應到實際位置。
  • shim——為那些沒有用 AMD 寫法的舊腳本補上依賴宣告與全域匯出。
  • deps——要預先載入的依賴陣列。

舉例來說,Underscore 與 Backbone 當年都不是 AMD 模組,就得靠 shim 把它們接進來:

require.config({
  baseUrl: 'scripts/app',
  paths: { lib: '../lib' },
  shim: {
    'backbone': {
      deps: ['underscore'],
      exports: 'Backbone'
    }
  }
});

這段設定的意思是:預設從 scripts/app 找模組,但 ID 開頭是 lib 的改到 scripts/lib 底下,而 Backbone 載入前必須先載入 Underscore,載完後把全域的 Backbone 當成模組值匯出。

用 define 定義模組

模組就是對內部實作做了封裝、只暴露必要介面的物件。慣例上,一個檔案只定義一個模組。define 接受「依賴陣列」與「模組定義函式」兩個參數,後者通常會把依賴依序當成參數接收。

define(["logger"], function (logger) {
  return {
    firstName: "John",
    lastName: "Black",
    sayHello: function () { logger.log('hello'); }
  };
});

這裡宣告了對 logger 模組的依賴,函式參數 logger 會被填入該模組的匯出值。模組必須回傳自己的 API,本例有兩個屬性與一個方法。之後任何模組只要用 ID 引用它,就能使用這組介面。

用 require 直接使用模組

require 適合「我只是要拿某個套件來用,不需要封裝成模組」的場合:

require(['jquery'], function ($) {
  // 這裡就可以放心使用 jQuery
});

結語

RequireJS 表面上是個依賴載入器,真正的價值在於它逼你把程式碼寫成模組。模組化帶來的可擴充性與可重用性,往往比省下的幾次網路請求更長遠。如今原生 ES Module 已成為主流,但理解 AMD 的思維——宣告依賴、延遲執行、顯式匯出——仍有助於你讀懂大量存量程式碼,也更明白打包工具背後在做什麼。

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