隨著網(wǎng)站逐漸變成"互聯(lián)網(wǎng)應(yīng)用程序",嵌入網(wǎng)頁的 Javascript 代碼越來越龐大,越來越復(fù)雜。
網(wǎng)頁越來越像桌面程序,需要一個(gè)團(tuán)隊(duì)分工協(xié)作、進(jìn)度管理、單元測試等等......開發(fā)者不得不使用軟件工程的方法,管理網(wǎng)頁的業(yè)務(wù)邏輯。
Javascript 模塊化編程,已經(jīng)成為一個(gè)迫切的需求。理想情況下,開發(fā)者只需要實(shí)現(xiàn)核心的業(yè)務(wù)邏輯,其他都可以加載別人已經(jīng)寫好的模塊。
但是,Javascript 不是一種模塊化編程語言,它不支持"類"(class),更遑論"模塊"(module)了。(正在制定中的 ECMAScript 標(biāo)準(zhǔn)第六版,將正式支持"類"和"模塊",但還需要很長時(shí)間才能投入實(shí)用。)
Javascript 社區(qū)做了很多努力,在現(xiàn)有的運(yùn)行環(huán)境中,實(shí)現(xiàn)"模塊"的效果。本文總結(jié)了當(dāng)前"Javascript 模塊化編程"的最佳實(shí)踐,說明如何投入實(shí)用。雖然這不是初級(jí)教程,但是只要稍稍了解 Javascript 的基本語法,就能看懂。
一、原始寫法
模塊就是實(shí)現(xiàn)特定功能的一組方法。
只要把不同的函數(shù)(以及記錄狀態(tài)的變量)簡單地放在一起,就算是一個(gè)模塊。
function m1(){ //...}function m2(){ //...}
上面的函數(shù) m1() 和 m2(),組成一個(gè)模塊。使用的時(shí)候,直接調(diào)用就行了。
這種做法的缺點(diǎn)很明顯:"污染"了全局變量,無法保證不與其他模塊發(fā)生變量名沖突,而且模塊成員之間看不出直接關(guān)系。
二、對象寫法
為了解決上面的缺點(diǎn),可以把模塊寫成一個(gè)對象,所有的模塊成員都放到這個(gè)對象里面。
var module1 = new Object ({ _count : 0, m1 : function (){ //... }, m2 : function (){ //... }});
上面的函數(shù) m1()和 m2(),都封裝在 module1 對象里。使用的時(shí)候,就是調(diào)用這個(gè)對象的屬性:
module1.m1();
但是,這樣的寫法會(huì)暴露所有模塊成員,內(nèi)部狀態(tài)可以被外部改寫。比如,外部代碼可以直接改變內(nèi)部計(jì)數(shù)器的值。
module1._count = 5;
三、立即執(zhí)行函數(shù)寫法
使用"立即執(zhí)行函數(shù)"(Immediately-Invoked Function ExPRession,IIFE),可以達(dá)到不暴露私有成員的目的。
var module1 = (function(){ var _count = 0; var m1 = function(){ //... }; var m2 = function(){ //... }; return { m1 : m1, m2 : m2 };})();
使用上面的寫法,外部代碼無法讀取內(nèi)部的_count 變量。
console.info (module1._count); //undefined
module1就是 Javascript 模塊的基本寫法。下面,再對這種寫法進(jìn)行加工。
四、放大模式
如果一個(gè)模塊很大,必須分成幾個(gè)部分,或者一個(gè)模塊需要繼承另一個(gè)模塊,這時(shí)就有必要采用"放大模式"(augmentation)。
var module1 = (function (mod){ mod.m3 = function () { //... }; return mod;})(module1);
上面的代碼為 module1 模塊添加了一個(gè)新方法 m3(),然后返回新的 module1 模塊。
五、寬放大模式(Loose augmentation)
在瀏覽器環(huán)境中,模塊的各個(gè)部分通常都是從網(wǎng)上獲取的,有時(shí)無法知道哪個(gè)部分會(huì)先加載。如果采用上一節(jié)的寫法,第一個(gè)執(zhí)行的部分有可能加載一個(gè)不存在空對象,這時(shí)就要采用"寬放大模式"。
var module1 = ( function (mod){ //... return mod;})(window.module1 {});
與"放大模式"相比,"寬放大模式"就是"立即執(zhí)行函數(shù)"的參數(shù)可以是空對象。
六、輸入全局變量
獨(dú)立性是模塊的重要特點(diǎn),模塊內(nèi)部最好不與程序的其他部分直接交互。
為了在模塊內(nèi)部調(diào)用全局變量,必須顯式地將其他變量輸入模塊。
var module1 = (function ($, YAHOO) { //...})(jQuery, YAHOO);
上面的 module1 模塊需要使用 jQuery 庫和 YUI 庫,就把這兩個(gè)庫(其實(shí)是兩個(gè)模塊)當(dāng)作參數(shù)輸入 module1。這樣做除了保證模塊的獨(dú)立性,還使得模塊之間的依賴關(guān)系變得明顯。這方面更多的討論,參見 Ben Cherry 的著名文章《JavaScript Module Pattern: In-Depth》。
七、模塊的規(guī)范
先想一想,為什么模塊很重要?
因?yàn)橛辛四K,我們就可以更方便地使用別人的代碼,想要什么功能,就加載什么模塊。
但是,這樣做有一個(gè)前提,那就是大家必須以同樣的方式編寫模塊,否則你有你的寫法,我有我的寫法,豈不是亂了套!考慮到 Javascript 模塊現(xiàn)在還沒有官方規(guī)范,這一點(diǎn)就更重要了。
目前,通行的 Javascript 模塊規(guī)范共有兩種:CommonJS 和 AMD。我主要介紹 AMD,但是要先從 CommonJS 講起。
八、CommonJS
2009年,美國程序員 Ryan Dahl 創(chuàng)造了 node.js 項(xiàng)目,將 Javascript 語言用于服務(wù)器端編程。
這標(biāo)志"Javascript 模塊化編程"正式誕生。因?yàn)槔蠈?shí)說,在瀏覽器環(huán)境下,沒有模塊也不是特別大的問題,畢竟網(wǎng)頁程序的復(fù)雜性有限;但是在服務(wù)器端,一定要有模塊,與操作系統(tǒng)和其他應(yīng)用程序互動(dòng),否則根本沒法編程。
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è)系列主要針對瀏覽器編程,不涉及 node.js,所以對 CommonJS 就不多做介紹了。我們在這里只要知道,require () 用于加載模塊就行了。
九、瀏覽器環(huán)境
有了服務(wù)器端模塊以后,很自然地,大家就想要客戶端模塊。而且最好兩者能夠兼容,一個(gè)模塊不用修改,在服務(wù)器和瀏覽器都可以運(yùn)行。
但是,由于一個(gè)重大的局限,使得 CommonJS 規(guī)范不適用于瀏覽器環(huán)境。還是上一節(jié)的代碼,如果在瀏覽器中運(yùn)行,會(huì)有一個(gè)很大的問題,你能看出來嗎?
var math = require ('math');math.add (2, 3);
第二行 Math.add (2, 3),在第一行 require ('math') 之后運(yùn)行,因此必須等 math.js 加載完成。也就是說,如果加載時(shí)間很長,整個(gè)應(yīng)用就會(huì)停在那里等。
這對服務(wù)器端不是一個(gè)問題,因?yàn)樗械哪K都存放在本地硬盤,可以同步加載完成,等待時(shí)間就是硬盤的讀取時(shí)間。但是,對于瀏覽器,這卻是一個(gè)大問題,因?yàn)槟K都放在服務(wù)器端,等待時(shí)間取決于網(wǎng)速的快慢,可能要等很長時(shí)間,瀏覽器處于"假死"狀態(tài)。
因此,瀏覽器端的模塊,不能采用"同步加載"(synchronous),只能采用"異步加載"(asynchronous)。這就是 AMD 規(guī)范誕生的背景。
十、AMD
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 庫實(shí)現(xiàn)了 AMD 規(guī)范:require.js 和 curl.js。本系列的第三部分,將通過介紹 require.js,進(jìn)一步講解 AMD 的用法,以及如何將模塊化編程投入實(shí)戰(zhàn)。
我采用的是一個(gè)非常流行的庫 require.js。
一、為什么要用 require.js?
最早的時(shí)候,所有 Javascript 代碼都寫在一個(gè)文件里面,只要加載這一個(gè)文件就夠了。后來,代碼越來越多,一個(gè)文件不夠了,必須分成多個(gè)文件,依次加載。下面的網(wǎng)頁代碼,相信很多人都見過。
<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)頁渲染,加載文件越多,網(wǎng)頁失去響應(yīng)的時(shí)間就會(huì)越長;其次,由于 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īng);
(2)管理模塊之間的依賴性,便于代碼的編寫和維護(hù)。
二、require.js 的加載
使用 require.js 的第一步,是先去官方網(wǎng)站下載最新版本。
下載后,假定把它放在 js 子目錄下面,就可以加載了。
<script src="js/require.js"></script>
有人可能會(huì)想到,加載這個(gè)文件,也可能造成網(wǎng)頁失去響應(yīng)。解決辦法有兩個(gè),一個(gè)是把它放在網(wǎng)頁底部加載,另一個(gè)是寫成下面這樣:
<script src="js/require.js" defer async="true" ></script>
async 屬性表明這個(gè)文件需要異步加載,避免網(wǎng)頁失去響應(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)頁程序的主模塊。在上例中,就是 js 目錄下面的 main.js,這個(gè)文件會(huì)第一個(gè)被 require.js 加載。由于 require.js 默認(rèn)的文件后綴名是 js,所以可以把 main.js 簡寫成 main。
三、主模塊的寫法
上一節(jié)的 main.js,我把它稱為"主模塊",意思是整個(gè)網(wǎng)頁的入口代碼。它有點(diǎn)像C語言的 main ()函數(shù),所有代碼都從這兒開始運(yùn)行。
下面就來看,怎么寫 main.js。
如果我們的代碼不依賴任何其他模塊,那么可以直接寫入 javascript 代碼。
// main.jsalert ("加載成功!");
但這樣的話,就沒必要使用 require.js 了。真正常見的情況是,主模塊依賴于其他模塊,這時(shí)就要使用 AMD 規(guī)范定義的的 require ()函數(shù)。
// main.jsrequire (['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 () 方法,我們可以對模塊的加載行為進(jìn)行自定義。require.config () 就寫在主模塊(main.js)的頭部。參數(shù)就是一個(gè)對象,這個(gè)對象的 paths 屬性指定各個(gè)模塊的加載路徑。
require.config ({ paths: { "jquery": "jquery.min.js", "underscore": "underscore.min.js", "backbone": "backbone.min.js" }});
上面的代碼給出了三個(gè)模塊
新聞熱點(diǎn)
疑難解答
網(wǎng)友關(guān)注