JavaScript模塊化編程(一):模塊原型和理論概念詳解

 隨着網站逐漸變成"互聯網應用程序",嵌入網頁的Javascript代碼越來越龐大,越來越複雜。

  網頁越來越像桌面程序,需要一個團隊分工協作、進度管理、單元測試等等……開發者不得不使用軟件工程的方法,管理網頁的業務邏輯。

  Javascript模塊化編程,已經成爲一個迫切的需求。理想情況下,開發者只需要實現核心的業務邏輯,其他都可以加載別人已經寫好的模塊。

  但是,Javascript不是一種模塊化編程語言,它不支持""(class),更遑論"模塊"(module)了。(正在制定中的ECMAScript標準第六版,將正式支持"類"和"模塊",但還需要很長時間才能投入實用。)

  Javascript社區做了很多努力,在現有的運行環境中,實現"模塊"的效果。本文總結了當前"Javascript模塊化編程"的最佳實踐,說明如何投入實用。雖然這不是初級教程,但是隻要稍稍瞭解Javascript的基本語法,就能看懂。

一、原始寫法

  模塊就是實現特定功能的一組方法。

  只要把不同的函數(以及記錄狀態的變量)簡單地放在一起,就算是一個模塊。

1
2
3
4
5
6
7
8
9
10
11
functionm1(){
 
   //...
 
}
 
functionm2(){
 
    //...
 
}

  上面的函數m1()和m2(),組成一個模塊。使用的時候,直接調用就行了。

  這種做法的缺點很明顯:"污染"了全局變量,無法保證不與其他模塊發生變量名衝突,而且模塊成員之間看不出直接關係。

二、對象寫法

  爲了解決上面的缺點,可以把模塊寫成一個對象,所有的模塊成員都放到這個對象裏面。

1
2
3
4
5
6
7
8
9
10
11
12
13
varmodule1 = newObject({
 
    _count : 0,
 
    m1 : function(){
        //...
    },
 
    m2 : function(){
        //...
    }
 
});

  上面的函數m1()和m2(),都封裝在module1對象裏。使用的時候,就是調用這個對象的屬性。

1
module1.m1();

  但是,這樣的寫法會暴露所有模塊成員,內部狀態可以被外部改寫。比如,外部代碼可以直接改變內部計數器的值。

1
module1._count = 5;

三、立即執行函數寫法

  使用"立即執行函數"(Immediately-Invoked Function Expression,IIFE),可以達到不暴露私有成員的目的。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
varmodule1 = (function(){
 
    var_count = 0;
 
    varm1 = function(){
        //...
    };
 
    varm2 = function(){
        //...
    };
 
    return{
        m1 : m1,
        m2 : m2
    };
 
})();

  使用上面的寫法,外部代碼無法讀取內部的_count變量。

1
console.info(module1._count);//undefined

  module1就是Javascript模塊的基本寫法。下面,再對這種寫法進行加工。

四、放大模式

  如果一個模塊很大,必須分成幾個部分,或者一個模塊需要繼承另一個模塊,這時就有必要採用"放大模式"(augmentation)。

1
2
3
4
5
6
7
8
9
10
11
varmodule1 = (function(mod){
 
    mod.m3 = function() {
 
        //...
 
    };
 
    returnmod;
 
})(module1);

  上面的代碼爲module1模塊添加了一個新方法m3(),然後返回新的module1模塊。

五、寬放大模式(Loose augmentation)

  在瀏覽器環境中,模塊的各個部分通常都是從網上獲取的,有時無法知道哪個部分會先加載。如果採用上一節的寫法,第一個執行的部分有可能加載一個不存在空對象,這時就要採用"寬放大模式"。

1
2
3
4
5
6
7
varmodule1 = ( function(mod){
 
    //...
 
    returnmod;
 
})(window.module1 || {});

  與"放大模式"相比,"寬放大模式"就是"立即執行函數"的參數可以是空對象。

六、輸入全局變量

  獨立性是模塊的重要特點,模塊內部最好不與程序的其他部分直接交互。

  爲了在模塊內部調用全局變量,必須顯式地將其他變量輸入模塊。

1
2
3
4
5
varmodule1 = (function($, YAHOO) {
 
    //...
 
})(jQuery, YAHOO);

  上面的module1模塊需要使用jQuery庫和YUI庫,就把這兩個庫(其實是兩個模塊)當作參數輸入module1。這樣做除了保證模塊的獨立性,還使得模塊之間的依賴關係變得明顯。這方面更多的討論,參見Ben Cherry的著名文章《JavaScript Module Pattern: In-Depth》

七、模塊的規範

  先想一想,爲什麼模塊很重要?

  因爲有了模塊,我們就可以更方便地使用別人的代碼,想要什麼功能,就加載什麼模塊。

  但是,這樣做有一個前提,那就是大家必須以同樣的方式編寫模塊,否則你有你的寫法,我有我的寫法,豈不是亂了套!考慮到Javascript模塊現在還沒有官方規範,這一點就更重要了。

  目前,通行的Javascript模塊規範共有兩種:CommonJSAMD。我主要介紹AMD,但是要先從CommonJS講起。

八、CommonJS

  2009年,美國程序員Ryan Dahl創造了node.js項目,將javascript語言用於服務器端編程。

  

  這標誌"Javascript模塊化編程"正式誕生。因爲老實說,在瀏覽器環境下,沒有模塊也不是特別大的問題,畢竟網頁程序的複雜性有限;但是在服務器端,一定要有模塊,與操作系統和其他應用程序互動,否則根本沒法編程。

  node.js的模塊系統,就是參照CommonJS規範實現的。在CommonJS中,有一個全局性方法require(),用於加載模塊。假定有一個數學模塊math.js,就可以像下面這樣加載。

1
varmath = require('math');

  然後,就可以調用模塊提供的方法:

1
2
3
varmath = require('math');
 
math.add(2,3);// 5

  因爲這個系列主要針對瀏覽器編程,不涉及node.js,所以對CommonJS就不多做介紹了。我們在這裏只要知道,require()用於加載模塊就行了。

九、瀏覽器環境

  有了服務器端模塊以後,很自然地,大家就想要客戶端模塊。而且最好兩者能夠兼容,一個模塊不用修改,在服務器和瀏覽器都可以運行。

  但是,由於一個重大的侷限,使得CommonJS規範不適用於瀏覽器環境。還是上一節的代碼,如果在瀏覽器中運行,會有一個很大的問題,你能看出來嗎?

1
2
3
varmath = require('math');
 
math.add(2, 3);

  第二行math.add(2, 3),在第一行require(‘math’)之後運行,因此必須等math.js加載完成。也就是說,如果加載時間很長,整個應用就會停在那裏等。

  這對服務器端不是一個問題,因爲所有的模塊都存放在本地硬盤,可以同步加載完成,等待時間就是硬盤的讀取時間。但是,對於瀏覽器,這卻是一個大問題,因爲模塊都放在服務器端,等待時間取決於網速的快慢,可能要等很長時間,瀏覽器處於"假死"狀態。

  因此,瀏覽器端的模塊,不能採用"同步加載"(synchronous),只能採用"異步加載"(asynchronous)。這就是AMD規範誕生的背景。

十、AMD

  AMD是"Asynchronous Module Definition"的縮寫,意思就是"異步模塊定義"。它採用異步方式加載模塊,模塊的加載不影響它後面語句的運行。所有依賴這個模塊的語句,都定義在一個回調函數中,等到加載完成之後,這個回調函數纔會運行。

  AMD也採用require()語句加載模塊,但是不同於CommonJS,它要求兩個參數:

1
require([module], callback);

  第一個參數[module],是一個數組,裏面的成員就是要加載的模塊;第二個參數callback,則是加載成功之後的回調函數。如果將前面的代碼改寫成AMD形式,就是下面這樣:

1
2
3
4
5
require(['math'],function(math) {
 
    math.add(2, 3);
 
});

  math.add()與math模塊加載不是同步的,瀏覽器不會發生假死。所以很顯然,AMD比較適合瀏覽器環境。

  目前,主要有兩個Javascript庫實現了AMD規範:require.jscurl.js。本系列的下一部分,將通過介紹require.js,進一步講解AMD的用法,以及如何將模塊化編程投入實戰。

注:
原文作者:阮一峯
原文鏈接:http://www.ruanyifeng.com/blog/2012/10/javascript_module.html
   http://www.ruanyifeng.com/blog/2012/10/asynchronous_module_definition.html

發佈了30 篇原創文章 · 獲贊 8 · 訪問量 30萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章