JavaScript 模組化程式設計(一):模組的寫法

阮一峰的網路日誌發表於2017-01-31

隨著網站逐漸變成”網際網路應用程式”,嵌入網頁的Javascript程式碼越來越龐大,越來越複雜。

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

JavaScript模組化程式設計,已經成為一個迫切的需求。理想情況下,開發者只需要實現核心的業務邏輯,其他都可以載入別人已經寫好的模組。

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

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

一、原始寫法

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

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

function m1(){
  //...
}
function m2(){
  //...
}

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

這種做法的缺點很明顯:”汙染”了全域性變數,無法保證不與其他模組發生變數名衝突,而且模組成員之間看不出直接關係。

二、物件寫法

為了解決上面的缺點,可以把模組寫成一個物件,所有的模組成員都放到這個物件裡面。

  var module1 = new Object({
    _count : 0,
    m1 : function (){
      //...
    },
    m2 : function (){
      //...
    }
  });

上面的函式m1()和m2(),都封裝在module1物件裡。使用的時候,就是呼叫這個物件的屬性。

module1.m1();

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

module1._count = 5;

三、立即執行函式寫法

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

  var module1 = (function(){
    var _count = 0;
    var m1 = function(){
      //...
    };
    var m2 = function(){
      //...
    };
    return {
      m1 : m1,
      m2 : m2
    };
  })();

使用上面的寫法,外部程式碼無法讀取內部的_count變數。

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

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

四、放大模式

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

  var module1 = (function (mod){
    mod.m3 = function () {
      //...
    };
    return mod;
  })(module1);

上面的程式碼為module1模組新增了一個新方法m3(),然後返回新的module1模組。

五、寬放大模式(Loose augmentation)

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

  var module1 = ( function (mod){
    //...
    return mod;
  })(window.module1 || {});

與”放大模式”相比,"寬放大模式"就是”立即執行函式”的引數可以是空物件。

六、輸入全域性變數

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

為了在模組內部呼叫全域性變數,必須顯式地將其他變數輸入模組。

  var module1 = (function ($, YAHOO) {
    //...
  })(jQuery, YAHOO);

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

這個系列的第二部分,將討論如何在瀏覽器環境組織不同的模組、管理模組之間的依賴性。

相關文章