javascript
学习阮一峰Javascript模块化编程,requireJS使用
使用背景NOW:
網(wǎng)站功能逐漸豐富,網(wǎng)頁(yè)中的js也變得越來(lái)越復(fù)雜和臃腫,原有通過(guò)script標(biāo)簽來(lái)導(dǎo)入一個(gè)個(gè)的js文件這種方式已經(jīng)不能滿(mǎn)足現(xiàn)在互聯(lián)網(wǎng)開(kāi)發(fā)模式。
項(xiàng)目需要一個(gè)團(tuán)隊(duì)分工協(xié)作、進(jìn)度管理、單元測(cè)試等等......開(kāi)發(fā)者不得不使用軟件工程的方法,管理網(wǎng)頁(yè)的業(yè)務(wù)邏輯,而項(xiàng)目業(yè)務(wù)邏輯是包含許多特定功能的模塊組合而成,理想情況下,開(kāi)發(fā)者只需要實(shí)現(xiàn)核心的業(yè)務(wù)邏輯,其他都可以加載別人已經(jīng)寫(xiě)好的模塊。
所以,Javascript模塊化編程,已經(jīng)成為一個(gè)迫切的需求。
?
?
介紹WHAT:
一、原始寫(xiě)法
模塊就是實(shí)現(xiàn)特定功能的一組方法。
只要把不同的函數(shù)(以及記錄狀態(tài)的變量)簡(jiǎn)單地放在一起,就算是一個(gè)模塊。
function m1(){
//...
}
function m2(){
//...
}
上面的函數(shù)m1()和m2(),組成一個(gè)模塊。使用的時(shí)候,直接調(diào)用就行了。
這種做法的缺點(diǎn)很明顯:"污染"了全局變量,無(wú)法保證不與其他模塊發(fā)生變量名沖突,而且模塊成員之間看不出直接關(guān)系。
?
二、對(duì)象寫(xiě)法
為了解決上面的缺點(diǎn),可以把模塊寫(xiě)成一個(gè)對(duì)象,所有的模塊成員都放到這個(gè)對(duì)象里面。
var module1 = new Object({
_count : 0,
m1 : function (){
//...
},
m2 : function (){
//...
}
});
上面的函數(shù)m1()和m2(),都封裝在module1對(duì)象里。使用的時(shí)候,就是調(diào)用這個(gè)對(duì)象的屬性。
module1.m1();
但是,這樣的寫(xiě)法會(huì)暴露所有模塊成員,內(nèi)部狀態(tài)可以被外部改寫(xiě)。比如,外部代碼可以直接改變內(nèi)部計(jì)數(shù)器的值。
module1._count = 5;
?
三、立即執(zhí)行函數(shù)寫(xiě)法
使用"立即執(zhí)行函數(shù)"(Immediately-Invoked Function Expression,IIFE),匿名自執(zhí)行函數(shù),可以達(dá)到不暴露私有成員的目的。
var module1 = (function(){
var _count = 0;
var m1 = function(){
//...
};
var m2 = function(){
//...
};
return {
m1 : m1,
m2 : m2
};
})();
使用上面的寫(xiě)法,外部代碼無(wú)法讀取內(nèi)部的_count變量。
console.info(module1._count); //undefined
module1就是Javascript模塊的基本寫(xiě)法。下面,再對(duì)這種寫(xiě)法進(jìn)行加工。
?
四、放大模式
將依賴(lài)模塊作為參數(shù)傳進(jìn)匿名自執(zhí)行函數(shù)
如果一個(gè)模塊很大,必須分成幾個(gè)部分,或者一個(gè)模塊需要繼承另一個(gè)模塊,這時(shí)就有必要采用"放大模式"(augmentation)。
var module1 = (function (mod){
mod.m3 = function () {
//...
};
return mod;
})(module1);
上面的代碼為module1模塊添加了一個(gè)新方法m3(),然后返回新的module1模塊。
?
五、寬放大模式(Loose augmentation)
空對(duì)象作為備用參數(shù)可以防止依賴(lài)模塊未先加載的錯(cuò)誤
在瀏覽器環(huán)境中,模塊的各個(gè)部分通常都是從網(wǎng)上獲取的,有時(shí)無(wú)法知道哪個(gè)部分會(huì)先加載。如果采用上一節(jié)的寫(xiě)法,第一個(gè)執(zhí)行的部分有可能加載一個(gè)不存在空對(duì)象,這時(shí)就要采用"寬放大模式"。
var module1 = ( function (mod){
//...
return mod;
})(window.module1 || {});
與"放大模式"相比,"寬放大模式"就是"立即執(zhí)行函數(shù)"的參數(shù)可以是空對(duì)象。
?
六、輸入全局變量
獨(dú)立性是模塊的重要特點(diǎn),模塊內(nèi)部最好不與程序的其他部分直接交互。
為了在模塊內(nèi)部調(diào)用全局變量,必須顯式地將其他變量輸入模塊。
var module1 = (function ($, YAHOO) {
//...
})(jQuery, YAHOO);
上面的module1模塊需要使用jQuery庫(kù)和YUI庫(kù),就把這兩個(gè)庫(kù)(其實(shí)是兩個(gè)模塊)當(dāng)作參數(shù)輸入module1。這樣做除了保證模塊的獨(dú)立性,還使得模塊之間的依賴(lài)關(guān)系變得明顯。
?
七、模塊的規(guī)范
先想一想,為什么模塊很重要?
因?yàn)橛辛四K,我們就可以更方便地使用別人的代碼,想要什么功能,就加載什么模塊。
但是,這樣做有一個(gè)前提,那就是大家必須以同樣的方式編寫(xiě)模塊,否則你有你的寫(xiě)法,我有我的寫(xiě)法,豈不是亂了套!考慮到Javascript模塊現(xiàn)在還沒(méi)有官方規(guī)范,這一點(diǎn)就更重要了。
目前,通行的Javascript模塊規(guī)范共有兩種:CommonJS和AMD。我主要介紹AMD,但是要先從CommonJS講起。
?
八、CommonJS
2009年,美國(guó)程序員Ryan Dahl創(chuàng)造了node.js項(xiàng)目,將javascript語(yǔ)言用于服務(wù)器端編程。
這標(biāo)志"Javascript模塊化編程"正式誕生。因?yàn)槔蠈?shí)說(shuō),在瀏覽器環(huán)境下,沒(méi)有模塊也不是特別大的問(wèn)題,畢竟網(wǎng)頁(yè)程序的復(fù)雜性有限;但是在服務(wù)器端,一定要有模塊,與操作系統(tǒng)和其他應(yīng)用程序互動(dòng),否則根本沒(méi)法編程。
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
因?yàn)檫@個(gè)系列主要針對(duì)瀏覽器編程,不涉及node.js,所以對(duì)CommonJS就不多做介紹了。我們?cè)谶@里只要知道,require()用于加載模塊就行了。
?
九、瀏覽器環(huán)境
有了服務(wù)器端模塊以后,很自然地,大家就想要客戶(hù)端模塊。而且最好兩者能夠兼容,一個(gè)模塊不用修改,在服務(wù)器和瀏覽器都可以運(yùn)行。
但是,由于一個(gè)重大的局限,使得CommonJS規(guī)范不適用于瀏覽器環(huán)境。還是上一節(jié)的代碼,如果在瀏覽器中運(yùn)行,會(huì)有一個(gè)很大的問(wèn)題,你能看出來(lái)嗎?
var math = require('math');
math.add(2, 3);
第二行math.add(2, 3),在第一行require('math')之后運(yùn)行,因此必須等math.js加載完成。也就是說(shuō),如果加載時(shí)間很長(zhǎng),整個(gè)應(yīng)用就會(huì)停在那里等。
這對(duì)服務(wù)器端不是一個(gè)問(wèn)題,因?yàn)樗械哪K都存放在本地硬盤(pán),可以同步加載完成,等待時(shí)間就是硬盤(pán)的讀取時(shí)間。但是,對(duì)于瀏覽器,這卻是一個(gè)大問(wèn)題,因?yàn)槟K都放在服務(wù)器端,等待時(shí)間取決于網(wǎng)速的快慢,可能要等很長(zhǎng)時(shí)間,瀏覽器處于"假死"狀態(tài)。
因此,瀏覽器端的模塊,不能采用"同步加載"(synchronous),只能采用"異步加載"(asynchronous)。這就是AMD規(guī)范誕生的背景。
也就是"異步加載"可以解決模塊加載等待過(guò)程中瀏覽器的假死未響應(yīng)的問(wèn)題。
?
十、AMD
AMD是"Asynchronous Module Definition"的縮寫(xiě),意思就是"異步模塊定義"。它采用異步方式加載模塊,模塊的加載不影響它后面語(yǔ)句的運(yùn)行。所有依賴(lài)這個(gè)模塊的語(yǔ)句,都定義在一個(gè)回調(diào)函數(shù)中,等到加載完成之后,這個(gè)回調(diào)函數(shù)才會(huì)運(yùn)行。
AMD也采用require()語(yǔ)句加載模塊,但是不同于CommonJS,它要求兩個(gè)參數(shù):
require([module], callback);
第一個(gè)參數(shù)[module],是一個(gè)數(shù)組,里面的成員就是要加載的模塊;第二個(gè)參數(shù)callback,則是加載成功之后的回調(diào)函數(shù)。如果將前面的代碼改寫(xiě)成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。
?
?
?
require使用優(yōu)勢(shì) WHY:
?
一、為什么要用require.js?
最早的時(shí)候,所有Javascript代碼都寫(xiě)在一個(gè)文件里面,只要加載這一個(gè)文件就夠了。后來(lái),代碼越來(lái)越多,一個(gè)文件不夠了,必須分成多個(gè)文件,依次加載。下面的網(wǎng)頁(yè)代碼,相信很多人都見(jiàn)過(guò)。
<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文件。
這樣的寫(xiě)法有很大的缺點(diǎn)。首先,加載的時(shí)候,瀏覽器會(huì)停止網(wǎng)頁(yè)渲染,加載文件越多,網(wǎng)頁(yè)失去響應(yīng)的時(shí)間就會(huì)越長(zhǎng);其次,由于js文件之間存在依賴(lài)關(guān)系,因此必須嚴(yán)格保證加載順序(比如上例的1.js要在2.js的前面),依賴(lài)性最大的模塊一定要放到最后加載,當(dāng)依賴(lài)關(guān)系很復(fù)雜的時(shí)候,代碼的編寫(xiě)和維護(hù)都會(huì)變得困難。
require.js的誕生,就是為了解決這兩個(gè)問(wèn)題:
(1)實(shí)現(xiàn)js文件的異步加載,避免網(wǎng)頁(yè)失去響應(yīng);》防止js加載阻塞頁(yè)面渲染
(2)管理模塊之間的依賴(lài)性,便于代碼的編寫(xiě)和維護(hù)。
?
?
?
?
使用步驟HOW:
?
二、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è)是寫(xiě)成下面這樣:
<script src="js/require.js"?defer async="true"?></script>
async屬性表明這個(gè)文件需要異步加載,避免網(wǎng)頁(yè)失去響應(yīng)。IE不支持這個(gè)屬性,只支持defer,所以把defer也寫(xiě)上。
加載require.js以后,下一步就要加載我們自己的代碼了。假定我們自己的代碼文件是main.js,也放在js目錄下面。那么,只需要寫(xiě)成下面這樣就行了:
<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)寫(xiě)成main。
?
三、主模塊的寫(xiě)法
上一節(jié)的main.js,我把它稱(chēng)為"主模塊",意思是整個(gè)網(wǎng)頁(yè)的入口代碼。它有點(diǎn)像C語(yǔ)言的main()函數(shù),所有代碼都從這兒開(kāi)始運(yùn)行。
下面就來(lái)看,怎么寫(xiě)main.js。
如果我們的代碼不依賴(lài)任何其他模塊,那么可以直接寫(xiě)入javascript代碼。
// main.js
alert("加載成功!");
但這樣的話(huà),就沒(méi)必要使用require.js了。真正常見(jiàn)的情況是,主模塊依賴(lài)于其他模塊,這時(shí)就要使用AMD規(guī)范定義的的require()函數(shù)。
在main.js中使用 require(['moduleName', ...], function (moduleA, moduleB, moduleC){.....});函數(shù)加載依賴(lài)模塊A\B\C,執(zhí)行回調(diào)邏輯
// main.js
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
// some code here
});
require()函數(shù)接受兩個(gè)參數(shù)。第一個(gè)參數(shù)是一個(gè)數(shù)組,表示所依賴(lài)的模塊,上例就是['moduleA', 'moduleB', 'moduleC'],即主模塊依賴(lài)這三個(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)行,解決了依賴(lài)性的問(wèn)題。
下面,我們看一個(gè)實(shí)際的例子。
假定主模塊依賴(lài)jquery、underscore和backbone這三個(gè)模塊,main.js就可以這樣寫(xiě):
require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
// some code here
});
上述例子中的callback函數(shù)中發(fā)現(xiàn)有$參數(shù),這個(gè)就是依賴(lài)的jquery模塊的輸出變量,如果你依賴(lài)多個(gè)模塊,可以依次寫(xiě)入多個(gè)參數(shù)來(lái)使用:
?
四、定義依賴(lài)模塊的加載路徑
上一節(jié)最后的示例中,主模塊的依賴(lài)模塊是['jquery', 'underscore', 'backbone']。默認(rèn)情況下,require.js假定這三個(gè)模塊與main.js在同一個(gè)目錄,文件名分別為jquery.js,underscore.js和backbone.js,然后自動(dòng)加載。
在main.js主模塊中使用require.config()方法可以定義依賴(lài)模塊文件的路徑!
使用require.config()方法,我們可以對(duì)模塊的加載行為進(jìn)行自定義。require.config()就寫(xiě)在主模塊(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目錄,則有兩種寫(xiě)法。一種是逐一指定路徑。
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.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"
}
});
require.js要求,每個(gè)模塊是一個(gè)單獨(dú)的js文件。這樣的話(huà),如果加載多個(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模塊的寫(xiě)法
require.js加載的模塊,采用AMD規(guī)范。也就是說(shuō),模塊必須按照AMD的規(guī)定來(lái)寫(xiě)。
具體來(lái)說(shuō),就是模塊必須采用特定的define()函數(shù)來(lái)定義。如果一個(gè)模塊不依賴(lài)其他模塊,那么可以直接定義在define()函數(shù)之中。
假定現(xiàn)在有一個(gè)math.js文件,它定義了一個(gè)math模塊。那么,math.js就要這樣寫(xiě):
// 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è)模塊還依賴(lài)其他模塊,那么define()函數(shù)的第一個(gè)參數(shù),必須是一個(gè)數(shù)組,指明該模塊的依賴(lài)性。
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()方法,定義它們的一些特征。
舉例來(lái)說(shuō),underscore和backbone這兩個(gè)庫(kù),都沒(méi)有采用AMD規(guī)范編寫(xiě)。如果要加載它們的話(huà),必須先定義它們的特征。
require.config({
shim: {
'underscore':{
exports: '_'
},
'backbone': {
deps: ['underscore', 'jquery'],
exports: 'Backbone'
}
}
});
require.config()接受一個(gè)配置對(duì)象,這個(gè)對(duì)象除了有前面說(shuō)過(guò)的paths屬性之外,還有一個(gè)shim屬性,專(zhuān)門(mén)用來(lái)配置不兼容的模塊。具體來(lái)說(shuō),每個(gè)模塊要定義(1)exports值(輸出的變量名),表明這個(gè)模塊外部調(diào)用時(shí)的名稱(chēng);(2)deps數(shù)組,表明該模塊的依賴(lài)性。
比如,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);
}
);
類(lèi)似的插件還有json和mdown,用于加載json文件和markdown文件。
?
?
?
參考網(wǎng)址:
阮一峰模塊化編程:http://www.ruanyifeng.com/blog/2012/10/javascript_module.html
菜鳥(niǎo)教程requireJS:https://www.runoob.com/w3cnote/requirejs-tutorial-1.html
總結(jié)
以上是生活随笔為你收集整理的学习阮一峰Javascript模块化编程,requireJS使用的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: luogu p3515 Lightnin
- 下一篇: 计算机教学与实际生活相结合,小学数学教学