Javascript的模組化編程

標籤：

隨著網站逐漸層成"互連網應用程式"，嵌入網頁的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）

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

　　var module1 = ( function (mod){

　　　　//...

　　　　return mod;

　　})(window.module1 || {});

與"放大模式"相比，＂寬放大模式＂就是"立即執行函數"的參數可以是Null 物件。

六、輸入全域變數

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

為了在模組內部調用全域變數，必須顯式地將其他變數輸入模組。

　　var module1 = (function ($, YAHOO) {

　　　　//...

　　})(jQuery, YAHOO);

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

這個系列的第一部分介紹了Javascript模組的基本寫法，今天介紹如何規範地使用模組。

（接上文）

七、模組的規範

先想一想，為什麼模組很重要？

因為有了模組，我們就可以更方便地使用別人的代碼，想要什麼功能，就載入什麼模組。

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

目前，通行的Javascript模組規範共有兩種：CommonJS和AMD。我主要介紹AMD，但是要先從CommonJS講起。

八、CommonJS

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

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

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

　　var math = require(‘math‘);

然後，就可以調用模組提供的方法：

　　var math = require(‘math‘);

　　math.add(2,3); // 5

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

九、瀏覽器環境

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

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

　　var math = 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，它要求兩個參數：

　　require([module], callback);

第一個參數[module]，是一個數組，裡面的成員就是要載入的模組；第二個參數callback，則是載入成功之後的回呼函數。如果將前面的代碼改寫成AMD形式，就是下面這樣：

　　require([‘math‘], function (math) {

　　　　math.add(2, 3);

　　});

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

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

我採用的是一個非常流行的庫require.js。

一、為什麼要用require.js？

最早的時候，所有Javascript代碼都寫在一個檔案裡面，只要載入這一個檔案就夠了。後來，代碼越來越多，一個檔案不夠了，必須分成多個檔案，依次載入。下面的網頁代碼，相信很多人都見過。

　　<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>

這段代碼依次載入多個js檔案。

這樣的寫法有很大的缺點。首先，載入的時候，瀏覽器會停止網頁渲染，負載檔案越多，網頁失去響應的時間就會越長；其次，由於js檔案之間存在依賴關係，因此必須嚴格保證載入順序（比如上例的1.js要在2.js的前面），依賴性最大的模組一定要放到最後載入，當依賴關係很複雜的時候，代碼的編寫和維護都會變得困難。

require.js的誕生，就是為瞭解決這兩個問題：

　　

　　（1）實現js檔案的非同步載入，避免網頁失去響應；

　　（2）管理模組之間的依賴性，便於代碼的編寫和維護。

二、require.js的載入

使用require.js的第一步，是先去官方網站下載最新版本。

下載後，假定把它放在js子目錄下面，就可以載入了。

　　<script src="js/require.js"></script>

有人可能會想到，載入這個檔案，也可能造成網頁失去響應。解決辦法有兩個，一個是把它放在網頁底部載入，另一個是寫成下面這樣：

　　<script src="js/require.js" defer async="true" ></script>

async屬性工作表明這個檔案需要非同步載入，避免網頁失去響應。IE不支援這個屬性，只支援defer，所以把defer也寫上。

載入require.js以後，下一步就要載入我們自己的代碼了。假定我們自己的代碼檔案是main.js，也放在js目錄下面。那麼，只需要寫成下面這樣就行了：

　　<script src="js/require.js" data-main="js/main"></script>

data-main屬性的作用是，指定網頁程式的主模組。在上例中，就是js目錄下面的main.js，這個檔案會第一個被require.js載入。由於require.js預設的檔案尾碼名是js，所以可以把main.js簡寫成main。

三、主模組的寫法

上一節的main.js，我把它稱為"主模組"，意思是整個網頁的入口代碼。它有點像C語言的main()函數，所有代碼都從這兒開始運行。

下面就來看，怎麼寫main.js。

如果我們的代碼不依賴任何其他模組，那麼可以直接寫入javascript代碼。

　　// main.js

　　alert("載入成功！");

但這樣的話，就沒必要使用require.js了。真正常見的情況是，主模組依賴於其他模組，這時就要使用AMD規範定義的的require()函數。

　　// main.js

　　require([‘moduleA‘, ‘moduleB‘, ‘moduleC‘], function (moduleA, moduleB, moduleC){

　　　　// some code here

　　});

require()函數接受兩個參數。第一個參數是一個數組，表示所依賴的模組，上例就是[‘moduleA‘, ‘moduleB‘, ‘moduleC‘]，即主模組依賴這三個模組；第二個參數是一個回呼函數，當前面指定的模組都載入成功後，它將被調用。載入的模組會以參數形式傳入該函數，從而在回呼函數內部就可以使用這些模組。

require()非同步載入moduleA，moduleB和moduleC，瀏覽器不會失去響應；它指定的回呼函數，只有前面的模組都載入成功後，才會運行，解決了依賴性的問題。

下面，我們看一個實際的例子。

假定主模組依賴jquery、underscore和backbone這三個模組，main.js就可以這樣寫：

　　require([‘jquery‘, ‘underscore‘, ‘backbone‘], function ($, _, Backbone){

　　　　// some code here

　　});

require.js會先載入jQuery、underscore和backbone，然後再運行回呼函數。主模組的代碼就寫在回呼函數中。

四、模組的載入

上一節最後的樣本中，主模組的相依模組是[‘jquery‘, ‘underscore‘, ‘backbone‘]。預設情況下，require.js假定這三個模組與main.js在同一個目錄，檔案名稱分別為jquery.js，underscore.js和backbone.js，然後自動載入。

使用require.config()方法，我們可以對模組的載入行為進行自訂。require.config()就寫在主模組（main.js）的頭部。參數就是一個對象，這個對象的paths屬性指定各個模組的載入路徑。

　　require.config({

　　　　paths: {

　　　　　　"jquery": "jquery.min",
　　　　　　"underscore": "underscore.min",
　　　　　　"backbone": "backbone.min"

　　　　}

　　});

上面的代碼給出了三個模組的檔案名稱，路徑預設與main.js在同一個目錄（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"

　　　　}

　　});

如果某個模組在另一台主機上，也可以直接指定它的網址，比如：

　　require.config({

　　　　paths: {

　　　　　　"jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"

　　　　}

　　});

require.js要求，每個模組是一個單獨的js檔案。這樣的話，如果載入多個模組，就會發出多次HTTP請求，會影響網頁的載入速度。因此，require.js提供了一個最佳化工具，當模組部署完畢以後，可以用這個工具將多個模組合并在一個檔案中，減少HTTP請求數。

五、AMD模組的寫法

require.js載入的模組，採用AMD規範。也就是說，模組必須按照AMD的規定來寫。

具體來說，就是模組必須採用特定的define()函數來定義。如果一個模組不依賴其他模組，那麼可以直接定義在define()函數之中。

假定現在有一個math.js檔案，它定義了一個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));

　　});

如果這個模組還依賴其他模組，那麼define()函數的第一個參數，必須是一個數組，指明該模組的依賴性。

　　define([‘myLib‘], function(myLib){

　　　　function foo(){

　　　　　　myLib.doSomething();

　　　　}

　　　　return {

　　　　　　foo : foo

　　　　};

　　});

當require()函數載入上面這個模組的時候，就會先載入myLib.js檔案。

六、載入非規範的模組

理論上，require.js載入的模組，必須是按照AMD規範、用define()函數定義的模組。但是實際上，雖然已經有一部分流行的函數庫（比如jQuery）符合AMD規範，更多的庫並不符合。那麼，require.js是否能夠載入非規範的模組呢？

回答是可以的。

這樣的模組在用require()載入之前，要先用require.config()方法，定義它們的一些特徵。

舉例來說，underscore和backbone這兩個庫，都沒有採用AMD規範編寫。如果要載入它們的話，必須先定義它們的特徵。

　　require.config({

　　　　shim: {

　　　　　　‘underscore‘:{
　　　　　　　　exports: ‘_‘
　　　　　　},

　　　　　　‘backbone‘: {
　　　　　　　　deps: [‘underscore‘, ‘jquery‘],
　　　　　　　　exports: ‘Backbone‘
　　　　　　}

　　　　}

　　});

require.config()接受一個設定物件，這個對象除了有前面說過的paths屬性之外，還有一個shim屬性，專門用來配置不相容的模組。具體來說，每個模組要定義（1）exports值（輸出的變數名），表明這個模組外部調用時的名稱；（2）deps數組，表明該模組的依賴性。

比如，jQuery的外掛程式可以這樣定義：

　　shim: {

　　　　‘jquery.scroll‘: {

　　　　　　deps: [‘jquery‘],

　　　　　　exports: ‘jQuery.fn.scroll‘

　　　　}

　　}

七、require.js外掛程式

require.js還提供一系列外掛程式，實現一些特定的功能。

domready外掛程式，可以讓回呼函數在頁面DOM結構載入完成後再運行。

　　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檔案。

 

Javascript的模組化編程