這是一篇關於 JavaScript 模塊化 AMD、CMD、CommonJS 的學習總結,既作記錄,也給同樣對三者心存疑惑的同學參考。若有不當或偏差之處,望各位高手不吝指正,不勝感激。本篇默認讀者大致了解 require、seajs 的用法(即 AMD、CMD 用法),故不再贅述語法。
這三個規範都是為 JavaScript 模塊化加載而生,都是在用到或預計要用到某些模塊時加載它,從而使龐大複雜的系統代碼得以良好組織與管理。模塊化讓我們在使用和管理代碼時不再那麼混亂,也便利了多人協作。
(1)CommonJS 是一個致力於構建 JavaScript 生態圈的組織,整個社區致力於提升 JavaScript 程序的可移植性與可交換性,無論在服務端還是瀏覽器端。用他們 wiki 上的話說,就是「a group with a goal of building up the JavaScript ecosystem for web servers, desktop and command line apps and in the browser」——一個旨在為 Web 服務器、桌面與命令行應用、瀏覽器構建 JavaScript 生態系統的組織。
這個組織制定了一些規範(可去官網 https://www.commonjs.org/ 查看),包括 CommonJS Modules/1.0 規範,我們平時所說的「commonjs 規範」指的正是它。正如官網所言:「The CommonJS API will fill that gap by defining APIs that handle many common application needs, ultimately providing a standard library as rich as those of Python, Ruby and Java.」
所以 CommonJS 更偏向服務器端,Node.js 便採用了這一規範。根據 CommonJS 規範,單獨一個文件就是一個模塊;加載模塊用 require 方法,它讀取並執行一個文件,最後返回文件內部的 exports 對象。他們也列出了適用場景:服務端 JS 應用、命令行工具、桌面 GUI 應用、混合應用(Titanium、Adobe AIR)等,可見其明顯偏向服務端(當然也可以用於瀏覽器,這是他們自己說的)。
(2)AMD 規範。CommonJS 解決了模塊化問題,也能用在瀏覽器中,但它是同步加載模塊——用到才現加載現用。這種同步機制到了瀏覽器裡就出了問題(同步加載會帶來性能、可用性、調試和跨域訪問等一系列麻煩)。
鑑於瀏覽器的特殊性,又出現了一個能異步加載依賴模塊、並會提前加載的規範——AMD。AMD 可視作 CommonJS 模塊的一個「中轉版本」,只要 CommonJS 沒有被用來做同步的 require 調用;使用同步 require 的 CommonJS 代碼,可以轉換為使用回調風格的 AMD 模塊(見 https://github.com/amdjs/amdjs-api/wiki/AMD-(%E4%B8%AD%E6%96%87%E7%89%88))。下面是一個把簡單 CommonJS 轉換為 AMD 的模塊定義:
define(function (require, exports, module) {
var a = require('a'),
b = require('b');
exports.action = function () {};
});
可見 AMD 與 CommonJS 是兼容的,只要稍作調整即可。翻看 AMD 規範你會發現,它基本都是先聲明依賴模塊、再預加載這些模塊,這就要求你提前想好並寫好依賴,否則寫代碼途中發現缺依賴,還得倒回頭部去補。
(3)CMD。不知道是針對上述問題,淘寶的玉伯大牛搞了個 seajs,並聲稱遵循 CMD 規範,還給出了規範的鏈接(打開會看到 draft 字樣)。關於這個規範,玉伯在知乎上是這麼說的:「AMD 是 RequireJS 在推廣過程中對模塊定義的規範化產出;CMD 是 SeaJS 在推廣過程中對模塊定義的規範化產出;類似的還有 CommonJS Modules/2.0 規範,是 BravoJS 在推廣過程中對模塊定義的規範化產出……」
可見 CMD 實際上是為推廣 SeaJS 而出台的。那麼看看 SeaJS 是怎麼回事,基本也就懂這個規範了。SeaJS 同樣是預加載依賴 js,這一點與 AMD 相同;明顯不同的是調用方式與聲明依賴的地方。AMD 與 CMD 都用 define 和 require,但 CMD 傾向於「就近聲明依賴」——寫代碼寫到哪兒突然要用另一個模塊,就在當前位置 require 引入即可,規範會幫你搞定預加載,你隨便寫就行;而 AMD 要求你必須提前在頭部的依賴參數裡寫好(沒寫好?倒回去補上咯)。這便是二者最明顯的區別。
由於 CommonJS 是服務器端規範,與另外兩個標準實際並不衝突。
AMD 在國外用得更多,國內也不少。jQuery 從 1.7 版開始使用,Dojo 從 1.6 版開始使用,這已足以證明它的優秀。CMD 當然也有很多人用,但基本集中在國內,SeaJS 官網就展示了一大批知名公司在用(愛奇藝、騰訊微博、支付寶、淘寶等,見 https://seajs.org/docs/),不知名的小公司估計更是數不勝數——畢竟很多公司招聘都要求會 seajs。
所以三個規範目前都發展得挺好(其實也主要是因為 JS 一直沒有自己的模塊加載機制,ES6 出來之後會怎樣還不好說)。當我們寫一個文件需要兼容不同加載規範時,該怎麼辦呢?看看下面的代碼。
(function (root, factory) { if (typeof define === 'function' && define.amd) { // AMD define(['jquery', 'underscore'], factory); } else if (typeof exports === 'object') { // Node, CommonJS之類的 module.exports = factory(require('jquery'), require('underscore')); } else { // 浏覽器全局變量(root 即 window) root.returnExports = factory(root.jQuery, root._); } }(this, function ($, _) { // 方法 function a(){}; // 私有方法,因為它沒被返回 (見下面) function b(){}; // 公共方法,因為被返回了 function c(){}; // 公共方法,因為被返回了 // 暴露公共方法 return { b: b, c: c } }));
這樣寫,就能兼容各種加載規範了。
以下幾點是玉伯在知乎上的說法:
1. 對於依賴的模塊,AMD 是提前執行,CMD 是延遲執行。不過 RequireJS 從 2.0 開始也改成了可以延遲執行(依寫法不同、處理方式不同)。CMD 推崇 as lazy as possible。
2. CMD 推崇依賴就近,AMD 推崇依賴前置。
3. AMD 的 API 默認「一當多用」,CMD 的 API 嚴格區分、推崇職責單一。比如 AMD 裡 require 分全局與局部,都叫 require;CMD 裡沒有全局 require,而是提供 seajs.use 來實現模塊系統的加載啟動,每個 API 都簡單純粹。
4. 還有一些細節差異,具體看規範定義即可(好吧,第四點它沒多說……)。
兩者都有 define 和 require,調用方式上都可以添加依賴參數,也就是都能用「提供依賴參數」的方式實現預加載依賴模塊(但不推薦這麼寫——注意:帶 id 和 deps 參數的 define 用法不屬於 CMD 規範,而屬於 Modules/Transport 規範,見 https://github.com/seajs/seajs/issues/242)。
AMD 也可以在 factory 裡用 require 現加載用到的模塊,只是這樣的模塊不會被預先加載,屬於用到才加載的同步加載:
var a = require('a'); // 加載模塊a
有不妥之處,歡迎斧正。
以上就是「淺析 AMD、CMD、CommonJS 規範」的全部內容,希望能給你一個參考,也希望大家多多支持。