什麼是模塊化開發?
前端開發早期,只要在 script 標籤裡嵌入幾十上百行程式碼就能做出基本互動。隨著 jQuery、Ajax、Node.js、MVC、MVVM 等技術的興起,前端項目越來越龐大,然而JavaScript本身卻沒有為組織程式碼提供太多幫助——它甚至沒有原生的類與模塊概念。那麼,什麼是模塊呢?
簡單說,一個模塊就是實現某項特定功能的檔案。有了模塊,我們便能方便地複用別人的程式碼,需要什麼功能就載入什麼模塊。當然,模塊化必須遵循一定的規範,否則只會天下大亂。目前通行的JavaScript模塊規範主要有兩種:CommonJS 與 AMD。

AMD 即 Asynchronous Module Definition(異步模塊定義),是瀏覽器端的模塊化規範,對應的服務器端規範則是 CommonJS。在 AMD 下,模塊會被異步載入,載入過程不阻塞後續語句,所有依賴某模塊的語句都放在回調函數裡。AMD 是 RequireJS 在推廣過程中對模塊定義的規範化產出。
define() 函數是 AMD 唯一定義的全域函數:
define(id?, dependencies?, factory);
參數說明:
["require", "exports", "module"]。模塊名的格式:以正斜槓分隔的有意義單詞串成,單詞採駝峰式或 .、..;不允許帶副檔名如 .js;可分為「相對的」(首字元為 . 或 ..)與「頂級的」兩種。
使用 require 和 exports:
define("alpha", ["require", "exports", "beta"], function (require, exports, beta) {
exports.verb = function() {
return beta.verb();
// 或:return require("beta").verb();
};
});
目前實作 AMD 的庫有 RequireJS、curl、Dojo、Nodules 等。
CommonJS 是服務器端的模塊規範,Node.js 採用的正是它。根據 CommonJS,一個檔案就是一個模塊,每個模塊都是獨立作用域,內部定義的變數無法被其他模塊讀取,除非掛到 global 對象上。輸出模塊變數最好用 module.exports:
var i = 1;
var max = 30;
module.exports = function () {
for (i -= 1; i++ < max; ) {
console.log(i);
}
max *= 1.1;
};
載入模塊則用 require,它會讀取並執行檔案,最後回傳內部的 module.exports 對象。
RequireJS 由 James Burke 創建,他也是 AMD 規範的創始人。RequireJS 與 Sea.js 都是模塊載入器,核心價值在於讓JavaScript模塊化開發變得簡單自然。兩者最大的差別在於:SeaJS 對模塊的態度是「懶執行」,而 RequireJS 是「預執行」。
為什麼要用 RequireJS?想像一個網頁有大量JS檔,瀏覽器會先載入它們、從而中斷頁面渲染,檔案越多越容易失去響應;再者,要確保依賴關係正確、依賴最深的模塊得最後載入,一旦關係複雜,維護就成了噩夢。RequireJS 正是為了解決這兩點而生:一是異步載入JS、避免失去響應;二是管理模塊間的依賴,便於編寫與維護。
CMD(Common Module Definition,通用模塊定義)是在國內發展起來的規範,由 SeaJS 推廣。兩者的核心差異是:AMD 依賴前置、提前執行;CMD 依賴就近、按需(延遲)執行。
// CMD
define(function(require, exports, module) {
var a = require('./a');
a.doSomething();
// 此處略去 100 行
var b = require('./b'); // 依賴可就近書寫
b.doSomething();
});
// AMD
define(['./a', './b'], function(a, b) {
a.doSomething();
// 此處略去 100 行
b.doSomething();
});
另一個差別是 API 設計:AMD 的 API 依使用範圍有別但共用同一組接口,CMD 則要求每個 API 職責單一。AMD 的優點是異步並行載入不會出錯,而 CMD 這種機制在並行載入時可能出錯,除非把模塊內容形式正規化。
值得注意的是,jQuery 1.7 以上版本已自動模塊化、支援 AMD 模式(主要透過 define 函數),因此 jQuery 本身已具備模塊化能力:
seajs.config({
'base': '/',
'alias': {
'jquery': 'jquery.js' // 定義 jQuery 檔案
}
});
html:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>鼠標拖拽的模塊化開發實踐</title>
<style type="text/css">
#div1{ width:200px; height:200px; background:black; position:absolute; display:none;}
#div2{ width:30px; height:30px; background:yellow; position:absolute; bottom:0; right:0;}
#div3{ width:100px; height:100px; background:blue; position:absolute; right:0; top:0;}
</style>
<script type="text/javascript" src="./sea.js"></script>
<script type="text/javascript">
seajs.use('./main.js');
</script>
</head>
<body>
<input type="button" value="確定" id="input1" />
<div id="div1"><div id="div2"></div></div>
<div id="div3"></div>
</body>
</html>
main.js:
define(function (require, exports, module) {
var oInput = document.getElementById('input1');
var oDiv1 = document.getElementById('div1');
var oDiv2 = document.getElementById('div2');
var oDiv3 = document.getElementById('div3');
require('./drag.js').drag(oDiv3);
oInput.onclick = function () {
oDiv1.style.display = 'block';
require('./scale.js').scale(oDiv1, oDiv2);
require.async('./scale.js', function (ex) {
ex.scale(oDiv1, oDiv2);
});
};
});
drag.js:
define(function(require, exports, module){
function drag(obj){
var disX = 0, disY = 0;
obj.onmousedown = function(ev){
var ev = ev || window.event;
disX = ev.clientX - obj.offsetLeft;
disY = ev.clientY - obj.offsetTop;
document.onmousemove = function(ev){
var ev = ev || window.event;
var L = require('./range.js').range(ev.clientX - disX, document.documentElement.clientWidth - obj.offsetWidth, 0);
var T = require('./range.js').range(ev.clientY - disY, document.documentElement.clientHeight - obj.offsetHeight, 0);
obj.style.left = L + 'px';
obj.style.top = T + 'px';
};
document.onmouseup = function(){
document.onmousemove = null;
document.onmouseup = null;
};
return false;
};
}
exports.drag = drag;
});
scale.js:
define(function(require, exports, module){
function scale(obj1, obj2){
var disX = 0, disY = 0, disW = 0, disH = 0;
obj2.onmousedown = function(ev){
var ev = ev || window.event;
disX = ev.clientX; disY = ev.clientY;
disW = obj1.offsetWidth; disH = obj1.offsetHeight;
document.onmousemove = function(ev){
var ev = ev || window.event;
var W = require('./range.js').range(ev.clientX - disX + disW, 500, 100);
var H = require('./range.js').range(ev.clientY - disY + disH, 500, 100);
obj1.style.width = W + 'px';
obj1.style.height = H + 'px';
};
document.onmouseup = function(){
document.onmousemove = null;
document.onmouseup = null;
};
return false;
};
}
exports.scale = scale;
});
range.js:
define(function(require, exports, module){
function range(iNum, iMax, iMin){
if (iNum > iMax) { return iMax; }
else if (iNum < iMin) { return iMin; }
else { return iNum; }
}
exports.range = range;
});

require.config 用來定義別名,在 paths 屬性下配置,然後用 requirejs(參數一, 參數二):參數一是需要引用模塊名的陣列,參數二是回調函數,其傳入的變數代表剛引入的模塊。
// main.js
requirejs.config({
paths: {
jquery: 'jquery.min' // 可省略 .js
}
});
requirejs(['jquery'], function ($) {
$('body').css('background-color', 'red');
});
define 模塊
define(['jquery'], function ($) {
return {
add: function(x, y){
return x + y;
}
};
});
將其存為 math.js 後,在 main.js 引入:
require(['jquery', 'math'], function ($, math) {
console.log(math.add(10, 100)); // 110
});
沒有依賴時,可以簡化為:
define(function () {
return { name: "trigkit4", age: "21" };
});
總的來說,AMD 推薦透過回傳一個對象作為模塊,而 CommonJS 風格則是透過對 module.exports 或 exports 賦值來暴露模塊。