js模块化
先回答我:為什么模塊很重要?
答:因?yàn)橛辛四K,我們就可以更方便地使用別人的代碼,想要什么功能,就加載什么模塊。
但是,這樣做有一個(gè)前提,那就是大家必須以同樣的方式編寫模塊,否則你有你的寫法,我有我的寫法,豈不是亂了套!
于是下面三個(gè)模塊規(guī)范出來了,這篇文章也出來了(拼出來的 {捂臉笑})。
JS中的模塊規(guī)范(CommonJS,AMD,CMD),如果你聽過js模塊化這個(gè)東西,那么你就應(yīng)該聽過或CommonJS或AMD甚至是CMD這些規(guī)范咯,我也聽過,但之前也真的是聽聽而已。現(xiàn)在就看看吧,這些規(guī)范到底是啥東西,干嘛的。本文包括這三個(gè)規(guī)范的來源及對(duì)應(yīng)的產(chǎn)物的原理。
一、CommonJS
1.一開始大家都認(rèn)為JS是辣雞,沒什么用,官方定義的API只能構(gòu)建基于瀏覽器的應(yīng)用程序,逗我呢,這太狹隘了吧(用了個(gè)高端詞,嘎嘎),CommonJS就按耐不住了,CommonJS API定義很多普通應(yīng)用程序(主要指非瀏覽器的應(yīng)用)使用的API,從而填補(bǔ)了這個(gè)空白。它的終極目標(biāo)是提供一個(gè)類似Python,Ruby和Java標(biāo)準(zhǔn)庫(kù)。這樣的話,開發(fā)者可以使用CommonJS API編寫應(yīng)用程序,然后這些應(yīng)用可以運(yùn)行在不同的JavaScript解釋器和不同的主機(jī)環(huán)境中。
在兼容CommonJS的系統(tǒng)中,你可以使用JavaScript開發(fā)以下程序:
(1).服務(wù)器端JavaScript應(yīng)用程序
(2).命令行工具
(3).圖形界面應(yīng)用程序
(4).混合應(yīng)用程序(如,Titanium或Adobe AIR)
2009年,美國(guó)程序員Ryan Dahl創(chuàng)造了node.js項(xiàng)目,將javascript語言用于服務(wù)器端編程。這標(biāo)志"Javascript模塊化編程"正式誕生。因?yàn)槔蠈?shí)說,在瀏覽器環(huán)境下,沒有模塊也不是特別大的問題,畢竟網(wǎng)頁(yè)程序的復(fù)雜性有限;但是在服務(wù)器端,一定要有模塊,與操作系統(tǒng)和其他應(yīng)用程序互動(dòng),否則根本沒法編程。NodeJS是CommonJS規(guī)范的實(shí)現(xiàn),webpack 也是以CommonJS的形式來書寫。
node.js的模塊系統(tǒng),就是參照CommonJS規(guī)范實(shí)現(xiàn)的。在CommonJS中,有一個(gè)全局性方法require(),用于加載模塊。假定有一個(gè)數(shù)學(xué)模塊math.js,就可以像下面這樣加載。
var math = require('math');
然后,就可以調(diào)用模塊提供的方法:
var math = require('math');
math.add(2,3); // 5
CommonJS定義的模塊分為:{模塊引用(require)} {模塊定義(exports)} {模塊標(biāo)識(shí)(module)}
require()用來引入外部模塊;exports對(duì)象用于導(dǎo)出當(dāng)前模塊的方法或變量,唯一的導(dǎo)出口;module對(duì)象就代表模塊本身。
雖說Node遵循CommonJS的規(guī)范,但是相比也是做了一些取舍,填了一些新東西的。
不過,說了CommonJS也說了Node,那么我覺得也得先了解下NPM了。NPM作為Node的包管理器,不是為了幫助Node解決依賴包的安裝問題嘛,那它肯定也要遵循CommonJS規(guī)范啦,它遵循包規(guī)范(還是理論)的。CommonJS WIKI講了它的歷史,還介紹了modules和packages等。
下面講講commonJS的原理以及簡(jiǎn)易實(shí)現(xiàn):
1、原理
瀏覽器不兼容CommonJS的根本原因,在于缺少四個(gè)Node.js環(huán)境的變量。
module
exports
require
global
只要能夠提供這四個(gè)變量,瀏覽器就能加載 CommonJS 模塊。
下面是一個(gè)簡(jiǎn)單的示例。
var module = { exports: {} }; (function(module, exports) { exports.multiply = function (n) { return n * 1000 }; }(module, module.exports)) var f = module.exports.multiply; f(5) // 5000
上面代碼向一個(gè)立即執(zhí)行函數(shù)提供 module 和 exports 兩個(gè)外部變量,模塊就放在這個(gè)立即執(zhí)行函數(shù)里面。模塊的輸出值放在 module.exports 之中,這樣就實(shí)現(xiàn)了模塊的加載。
2、Browserify 的實(shí)現(xiàn)
知道了原理,就能做出工具了。Browserify是目前最常用的 CommonJS 格式轉(zhuǎn)換的工具。
請(qǐng)看一個(gè)例子,main.js 模塊加載 foo.js 模塊。
// foo.js module.exports = function(x) { console.log(x); }; // main.js var foo = require("./foo"); foo("Hi");
使用下面的命令,就能將main.js轉(zhuǎn)為瀏覽器可用的格式。
$ browserify main.js > compiled.js
Browserify到底做了什么?安裝一下browser-unpack,就能看清楚了。
$ npm install browser-unpack -g
然后,將前面生成的compile.js解包。
$ browser-unpack < compiled.js [ { "id":1, "source":"module.exports = function(x) { console.log(x); };", "deps":{} }, { "id":2, "source":"var foo = require("./foo"); foo("Hi");", "deps":{"./foo":1}, "entry":true } ]
可以看到,browerify 將所有模塊放入一個(gè)數(shù)組,id 屬性是模塊的編號(hào),source 屬性是模塊的源碼,deps 屬性是模塊的依賴。
因?yàn)?main.js 里面加載了 foo.js,所以 deps 屬性就指定 ./foo 對(duì)應(yīng)1號(hào)模塊。執(zhí)行的時(shí)候,瀏覽器遇到 require('./foo') 語句,就自動(dòng)執(zhí)行1號(hào)模塊的 source 屬性,并將執(zhí)行后的 module.exports 屬性值輸出。
3、Tiny Browser Require
雖然 Browserify 很強(qiáng)大,但不能在瀏覽器里操作,有時(shí)就很不方便。
我根據(jù)mocha的內(nèi)部實(shí)現(xiàn),做了一個(gè)純?yōu)g覽器的 CommonJS 模塊加載器tiny-browser-require。完全不需要命令行,直接放進(jìn)瀏覽器即可,所有代碼只有30多行。
它的邏輯非常簡(jiǎn)單,就是把模塊讀入數(shù)組,加載路徑就是模塊的id。
function require(p){ var path = require.resolve(p); var mod = require.modules[path]; if (!mod) throw new Error('failed to require "' + p + '"'); if (!mod.exports) { mod.exports = {}; mod.call(mod.exports, mod, mod.exports, require.relative(path)); } return mod.exports; } require.modules = {}; require.resolve = function (path){ var orig = path; var reg = path + '.js'; var index = path + '/index.js'; return require.modules[reg] && reg || require.modules[index] && index || orig; }; require.register = function (path, fn){ require.modules[path] = fn; }; require.relative = function (parent) { return function(p){ if ('.' != p.charAt(0)) return require(p); var path = parent.split('/'); var segs = p.split('/'); path.pop(); for (var i = 0; i < segs.length; i++) { var seg = segs[i]; if ('..' == seg) path.pop(); else if ('.' != seg) path.push(seg); } return require(path.join('/')); }; };
使用的時(shí)候,先將上面的代碼放入頁(yè)面。然后,將模塊放在如下的立即執(zhí)行函數(shù)里面,就可以調(diào)用了。
<script src="require.js" /> <script> require.register("moduleId", function(module, exports, require){ // Module code goes here }); var result = require("moduleId"); </script>
還是以前面的 main.js 加載 foo.js 為例。
require.register("./foo.js", function(module, exports, require){ module.exports = function(x) { console.log(x); }; }); var foo = require("./foo.js"); foo("Hi");
注意,這個(gè)庫(kù)只模擬了 require 、module 、exports 三個(gè)變量,如果模塊還用到了 global 或者其他 Node 專有變量(比如 process),就通過立即執(zhí)行函數(shù)提供即可。
二、AMD
基于commonJS規(guī)范的nodeJS出來以后,服務(wù)端的模塊概念已經(jīng)形成,很自然地,大家就想要客戶端模塊。而且最好兩者能夠兼容,一個(gè)模塊不用修改,在服務(wù)器和瀏覽器都可以運(yùn)行。但是,由于一個(gè)重大的局限,使得CommonJS規(guī)范不適用于瀏覽器環(huán)境。還是上面的代碼,如果在瀏覽器中運(yùn)行,會(huì)有一個(gè)很大的問題,你能看出來嗎?
var math = require('math');
math.add(2, 3);
第二行math.add(2, 3),在第一行require('math')之后運(yùn)行,因此必須等math.js加載完成。也就是說,如果加載時(shí)間很長(zhǎng),整個(gè)應(yīng)用就會(huì)停在那里等。您會(huì)注意到require是同步的。
這對(duì)服務(wù)器端不是一個(gè)問題,因?yàn)樗械哪K都存放在本地硬盤,可以同步加載完成,等待時(shí)間就是硬盤的讀取時(shí)間。但是,對(duì)于瀏覽器,這卻是一個(gè)大問題,因?yàn)槟K都放在服務(wù)器端,等待時(shí)間取決于網(wǎng)速的快慢,可能要等很長(zhǎng)時(shí)間,瀏覽器處于"假死"狀態(tài)。
因此,瀏覽器端的模塊,不能采用"同步加載"(synchronous),只能采用"異步加載"(asynchronous)。這就是AMD規(guī)范誕生的背景。
CommonJS是主要為了JS在后端的表現(xiàn)制定的,他是不適合前端的,AMD(異步模塊定義)出現(xiàn)了,它就主要為前端JS的表現(xiàn)制定規(guī)范。
AMD是"Asynchronous Module Definition"的縮寫,意思就是"異步模塊定義"。它采用異步方式加載模塊,模塊的加載不影響它后面語句的運(yùn)行。所有依賴這個(gè)模塊的語句,都定義在一個(gè)回調(diào)函數(shù)中,等到加載完成之后,這個(gè)回調(diào)函數(shù)才會(huì)運(yùn)行。
AMD也采用require()語句加載模塊,但是不同于CommonJS,它要求兩個(gè)參數(shù):
require([module], callback);
第一個(gè)參數(shù)[module],是一個(gè)數(shù)組,里面的成員就是要加載的模塊;第二個(gè)參數(shù)callback,則是加載成功之后的回調(diào)函數(shù)。如果將前面的代碼改寫成AMD形式,就是下面這樣:
require(['math'], function (math) {
math.add(2, 3);
});
math.add()與math模塊加載不是同步的,瀏覽器不會(huì)發(fā)生假死。所以很顯然,AMD比較適合瀏覽器環(huán)境。目前,主要有兩個(gè)Javascript庫(kù)實(shí)現(xiàn)了AMD規(guī)范:require.js和curl.js。
RequireJS就是實(shí)現(xiàn)了AMD規(guī)范的呢。
詳細(xì)概括:下面以RequireJS為例說明AMD規(guī)范
一、為什么要用require.js?
最早的時(shí)候,所有Javascript代碼都寫在一個(gè)文件里面,只要加載這一個(gè)文件就夠了。后來,代碼越來越多,一個(gè)文件不夠了,必須分成多個(gè)文件,依次加載。下面的網(wǎng)頁(yè)代碼,相信很多人都見過。
<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>
這段代碼依次加載多個(gè)js文件。
這樣的寫法有很大的缺點(diǎn)。首先,加載的時(shí)候,瀏覽器會(huì)停止網(wǎng)頁(yè)渲染,加載文件越多,網(wǎng)頁(yè)失去響應(yīng)的時(shí)間就會(huì)越長(zhǎng);其次,由于js文件之間存在依賴關(guān)系,因此必須嚴(yán)格保證加載順序(比如上例的1.js要在2.js的前面),依賴性最大的模塊一定要放到最后加載,當(dāng)依賴關(guān)系很復(fù)雜的時(shí)候,代碼的編寫和維護(hù)都會(huì)變得困難。
require.js的誕生,就是為了解決這兩個(gè)問題:
(1)實(shí)現(xiàn)js文件的異步加載,避免網(wǎng)頁(yè)失去響應(yīng);
(2)管理模塊之間的依賴性,便于代碼的編寫和維護(hù)。
二、require.js的加載
使用require.js的第一步,是先去官方網(wǎng)站下載最新版本。
下載后,假定把它放在js子目錄下面,就可以加載了。
<script src="js/require.js"></script>
有人可能會(huì)想到,加載這個(gè)文件,也可能造成網(wǎng)頁(yè)失去響應(yīng)。解決辦法有兩個(gè),一個(gè)是把它放在網(wǎng)頁(yè)底部加載,另一個(gè)是寫成下面這樣:
<script src="js/require.js"defer async="true"></script>
async屬性表明這個(gè)文件需要異步加載,避免網(wǎng)頁(yè)失去響應(yīng)。IE不支持這個(gè)屬性,只支持defer,所以把defer也寫上。
加載require.js以后,下一步就要加載我們自己的代碼了。假定我們自己的代碼文件是main.js,也放在js目錄下面。那么,只需要寫成下面這樣就行了:
<script src="js/require.js"data-main="js/main"></script>
data-main屬性的作用是,指定網(wǎng)頁(yè)程序的主模塊。在上例中,就是js目錄下面的main.js,這個(gè)文件會(huì)第一個(gè)被require.js加載。由于require.js默認(rèn)的文件后綴名是js,所以可以把main.js簡(jiǎn)寫成main。
三、主模塊的寫法
上一節(jié)的main.js,我把它稱為"主模塊",意思是整個(gè)網(wǎng)頁(yè)的入口代碼。它有點(diǎn)像C語言的main()函數(shù),所有代碼都從這兒開始運(yùn)行。
下面就來看,怎么寫main.js。
如果我們的代碼不依賴任何其他模塊,那么可以直接寫入javascript代碼。
// main.js
alert("加載成功!");
但這樣的話,就沒必要使用require.js了。真正常見的情況是,主模塊依賴于其他模塊,這時(shí)就要使用AMD規(guī)范定義的的require()函數(shù)。
// main.js
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
// some code here
});
require()函數(shù)接受兩個(gè)參數(shù)。第一個(gè)參數(shù)是一個(gè)數(shù)組,表示所依賴的模塊,上例就是['moduleA', 'moduleB', 'moduleC'],即主模塊依賴這三個(gè)模塊;第二個(gè)參數(shù)是一個(gè)回調(diào)函數(shù),當(dāng)前面指定的模塊都加載成功后,它將被調(diào)用。加載的模塊會(huì)以參數(shù)形式傳入該函數(shù),從而在回調(diào)函數(shù)內(nèi)部就可以使用這些模塊。
require()異步加載moduleA,moduleB和moduleC,瀏覽器不會(huì)失去響應(yīng);它指定的回調(diào)函數(shù),只有前面的模塊都加載成功后,才會(huì)運(yùn)行,解決了依賴性的問題。
下面,我們看一個(gè)實(shí)際的例子。
假定主模塊依賴jquery、underscore和backbone這三個(gè)模塊,main.js就可以這樣寫:
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
// some code here
});
require.js會(huì)先加載jQuery、underscore和backbone,然后再運(yùn)行回調(diào)函數(shù)。主模塊的代碼就寫在回調(diào)函數(shù)中。
四、模塊的加載
上一節(jié)最后的示例中,主模塊的依賴模塊是['jquery', 'underscore', 'backbone']。默認(rèn)情況下,require.js假定這三個(gè)模塊與main.js在同一個(gè)目錄,文件名分別為jquery.js,underscore.js和backbone.js,然后自動(dòng)加載。
使用require.config()方法,我們可以對(duì)模塊的加載行為進(jìn)行自定義。require.config()就寫在主模塊(main.js)的頭部。參數(shù)就是一個(gè)對(duì)象,這個(gè)對(duì)象的paths屬性指定各個(gè)模塊的加載路徑。
require.config({
paths: {
"jquery": "jquery.min",
"underscore": "underscore.min",
"backbone": "backbone.min"}
});
上面的代碼給出了三個(gè)模塊的文件名,路徑默認(rèn)與main.js在同一個(gè)目錄(js子目錄)。如果這些模塊在其他目錄,比如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"}
});
如果某個(gè)模塊在另一臺(tái)主機(jī)上,也可以直接指定它的網(wǎng)址,比如:
require.config({
paths: {
"jquery": "https://ajax.lug.ustc.edu.cn/ajax/libs/jquery/1.7.2/jquery.min"
}
});
require.js要求,每個(gè)模塊是一個(gè)單獨(dú)的js文件。這樣的話,如果加載多個(gè)模塊,就會(huì)發(fā)出多次HTTP請(qǐng)求,會(huì)影響網(wǎng)頁(yè)的加載速度。因此,require.js提供了一個(gè)優(yōu)化工具,當(dāng)模塊部署完畢以后,可以用這個(gè)工具將多個(gè)模塊合并在一個(gè)文件中,減少HTTP請(qǐng)求數(shù)。
五、AMD模塊的寫法
require.js加載的模塊,采用AMD規(guī)范。也就是說,模塊必須按照AMD的規(guī)定來寫。
具體來說,就是模塊必須采用特定的define()函數(shù)來定義。如果一個(gè)模塊不依賴其他模塊,那么可以直接定義在define()函數(shù)之中。
假定現(xiàn)在有一個(gè)math.js文件,它定義了一個(gè)math模塊。那么,math.js就要這樣寫:
// 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));
});
如果這個(gè)模塊還依賴其他模塊,那么define()函數(shù)的第一個(gè)參數(shù),必須是一個(gè)數(shù)組,指明該模塊的依賴性。
define(['myLib'], function(myLib){
function foo(){
myLib.doSomething();
}
return {
foo : foo
};
});
當(dāng)require()函數(shù)加載上面這個(gè)模塊的時(shí)候,就會(huì)先加載myLib.js文件。
六、加載非規(guī)范的模塊
理論上,require.js加載的模塊,必須是按照AMD規(guī)范、用define()函數(shù)定義的模塊。但是實(shí)際上,雖然已經(jīng)有一部分流行的函數(shù)庫(kù)(比如jQuery)符合AMD規(guī)范,更多的庫(kù)并不符合。那么,require.js是否能夠加載非規(guī)范的模塊呢?
回答是可以的。
這樣的模塊在用require()加載之前,要先用require.config()方法,定義它們的一些特征。
舉例來說,underscore和backbone這兩個(gè)庫(kù),都沒有采用AMD規(guī)范編寫。如果要加載它們的話,必須先定義它們的特征。
require.config({
shim: {
'underscore':{
exports: '_'
},'backbone': {
deps: ['underscore', 'jquery'],
exports: 'Backbone'
}}
});
require.config()接受一個(gè)配置對(duì)象,這個(gè)對(duì)象除了有前面說過的paths屬性之外,還有一個(gè)shim屬性,專門用來配置不兼容的模塊。具體來說,每個(gè)模塊要定義(1)exports值(輸出的變量名),表明這個(gè)模塊外部調(diào)用時(shí)的名稱;(2)deps數(shù)組,表明該模塊的依賴性。
比如,jQuery的插件可以這樣定義:
shim: {
'jquery.scroll': {
deps: ['jquery'],
exports: 'jQuery.fn.scroll'
}
}
七、require.js插件
require.js還提供一系列插件,實(shí)現(xiàn)一些特定的功能。
domready插件,可以讓回調(diào)函數(shù)在頁(yè)面DOM結(jié)構(gòu)加載完成后再運(yùn)行。
require(['domready!'], function (doc){
// called once the DOM is ready
});
text和image插件,則是允許require.js加載文本和圖片文件。
define([
'text!review.txt',
'image!cat.jpg'
],
function(review,cat){
console.log(review);
document.body.appendChild(cat);
}
);
類似的插件還有json和mdown,用于加載json文件和markdown文件。(完)
另一個(gè)人的概括(有點(diǎn)簡(jiǎn)單):
AMD就只有一個(gè)接口:define(id?,dependencies?,factory);
它要在聲明模塊的時(shí)候制定所有的依賴(dep),并且還要當(dāng)做形參傳到factory中,像這樣:
1 define(['dep1','dep2'],function(dep1,dep2){...});
要是沒什么依賴,就定義簡(jiǎn)單的模塊,下面這樣就可以啦:
1 define(function(){
2 var exports = {};
3 exports.method = function(){...};
4 return exports;
5 });
咦,這里有define,把東西包裝起來啦,那Node實(shí)現(xiàn)中怎么沒看到有define關(guān)鍵字呢,它也要把東西包裝起來呀,其實(shí)吧,只是Node隱式包裝了而已.....
這有AMD的WIKI中文版,講了很多蠻詳細(xì)的東西,用到的時(shí)候可以查看:AMD的WIKI中文版
三、CMD
大名遠(yuǎn)揚(yáng)的玉伯寫了seajs,就是遵循他提出的CMD規(guī)范,與AMD蠻相近的,不過用起來感覺更加方便些,最重要的是中文版,應(yīng)有盡有:seajs官方doc
1 define(function(require,exports,module){...});
用過seajs吧,這個(gè)不陌生吧,對(duì)吧。
前面說AMD,說RequireJS實(shí)現(xiàn)了AMD,CMD看起來與AMD好像呀,那RequireJS與SeaJS像不像呢?
雖然CMD與AMD蠻像的,但區(qū)別還是挺明顯的,官方非官方都有闡述和理解,我覺得吧,說的都挺好:
官方闡述SeaJS與RequireJS異同
SeaJS與RequireJS的最大異同(這個(gè)說的也挺好)
總結(jié)
- 上一篇: 房租650元一个月扣月租金200%怎么扣
- 下一篇: Vue.js 源码分析(一) 代码结构