小 A 是某個創業團隊的前端工程師,負責撰寫專案的 JavaScript。這個故事裡的三個困境——全域變數衝突、相依關係混亂、修改難以擴散——正好對應了模組化要解決的核心問題。
憑著經驗,小 A 先把常用功能抽成函式,集中放到一個公用檔案 base.js:
var _ = {
$: function(id) { return document.getElementById(id); },
getCookie: function(key) { ... },
setCookie: function(key, value) { ... }
};
把函式都收在 _ 物件裡,是為了減少全域變數數量、降低衝突機率。他告訴同事:想用這些函式,引入 base.js 就行。
同事小 C 卻來反映:他的頁面引入了一個叫 underscore.js 的類庫,而這個類庫同樣會佔用 _ 這個全域變數,兩邊撞在一起。underscore.js 是第三方類庫不好動,base.js 又已經舖到很多頁面無法更改,最後小 A 只好去改 underscore.js 的命名。
結論很清楚:把函式收進命名空間,只能降低衝突機率,並沒有解決衝突。
隨著業務成長,小 A 又寫了一系列函式庫與 UI 元件,例如標籤切換元件 tabs.js,它需要呼叫 base.js 與 util.js 的函式。
新同事小 D 反映 tabs.js 無法正常運作。小 A 一看就發現問題:小 D 不知道 tabs.js 依賴另外兩個檔案,沒有把它們引入。於是修改如下:
<script src="tabs.js"></script> <script src="base.js"></script> <script src="util.js"></script>
結果還是不行。小 A 這才想到:既然是「依賴」,被依賴方必須放在依賴方之前——小 D 把 base.js 與 util.js 寫在 tabs.js 後面了。
問題在於,作者自己當然清楚相依關係,其他人(尤其新人)無從得知。更麻煩的是後續維護:小 A 為 tabs.js 新增功能,需要多相依一個 ui.js,他就得去所有用到 tabs.js 的頁面補上 ui.js 的引用;幾個月後他優化 tabs.js,移除了對 util.js 的依賴,於是把各頁面的 util.js 引用刪掉,結果測試人員回報有些頁面壞了——原來那些頁面的其他功能也在用 util.js。改相依關係居然會波及無關的功能,這顯然不是健康的結構。
在網路上無意間看到的一種模組化寫法,把小 A 遇到的問題一次解決了。
在模組化方式下,每個檔案都是一個模組,由名為 define 的函式建立。base.js 改造後變成:
define(function(require, exports, module) {
exports.$ = function(id) { return document.getElementById(id); };
exports.getCookie = function(key) { ... };
exports.setCookie = function(key, value) { ... };
});
對外提供的介面全部掛在 exports 上,而 exports 是函式內的區域變數——整個模組沒有佔用任何全域變數,衝突問題自然消失。
要使用其他模組的介面,透過區域函式 require 取得:
define(function(require, exports, module) {
var _ = require('base.js'), util = require('util.js');
var div_tabs = _.$('tabs');
// .... 其他程式碼
});
此時 _ 與 util 都是區域變數,命名完全由開發者決定。不喜歡 _ 這個名字,改叫 base 也可以:
define(function(require, exports, module) {
var base = require('base.js'), util = require('util.js');
var div_tabs = base.$('tabs');
// .... 其他程式碼
});
而相依關係一旦改變,只需要改 tabs.js 這一個檔案:
define(function(require, exports, module) {
var base = require('base.js'), ui = require('ui.js');
var div_tabs = base.$('tabs');
// .... 其他程式碼
});
頁面不必動,其他功能也不受影響。這就是相依聲明與相依實作分離的效果。
由於瀏覽器缺乏原生支援,要用模組化方式撰寫,必須搭配一個稱為載入器(loader)的工具。當時常見的實作有 RequireJS、SeaJS,JRaiser 類庫也有自己的載入器。
這個故事寫於 CommonJS / AMD 盛行的年代,處境放到今天已經改變。ES2015 之後,import / export 成為語言標準,所有現代瀏覽器與 Node.js 都原生支援,不必再引入 RequireJS 或 SeaJS:
// base.js
export function $(id) { return document.getElementById(id); }
export function getCookie(key) { ... }
export function setCookie(key, value) { ... }
// tabs.js
import { $ } from './base.js';
import { util } from './util.js';
const div_tabs = $('tabs');
原生 ES Module 有幾個比 AMD 更強的特性:import 語法靜態可分析,因此打包工具能在編譯期建立完整的相依圖並移除未使用的程式碼(tree shaking);模組本身會被快取,重複 import 只執行一次;每個模組預設處於 strict mode,且擁有自己的作用域,不必再靠 IIFE 包裝。
檔案副檔名要留意:在瀏覽器中直接使用原生模組時,script 標籤需加上 type="module",且基於安全性考量必須透過 http(s) 協定載入,直接用 file:// 開啟會被 CORS 政策擋下。
小 A 的故事到頭來說明了一件不變的事:當程式規模小時,全域變數與手動管理腳本順序勉強可行;一旦專案成長、團隊擴編,缺乏模組機制的成本會以「改一處壞三處」的形式回過頭來收取。