DIV CSS 佈局教程網

從全局變量污染說起:用模塊模式寫出更優美的 AngularJS 代碼
編輯:JavaScript綜合知識     

很多介紹設計模式的文章一上來就拋術語,讀者還不知道問題在哪,就已經被術語淹沒了。本文換個順序:先親眼看到「全局變量污染」造成的 bug,再理解模塊模式(Module Pattern)如何解決它,最後看 AngularJS 怎樣把這套最佳實踐內建進框架裡。

閱讀本文不需要任何 AngularJS 經驗,甚至具備基礎 JavaScript 認知即可。

問題:JavaScript 默認把一切掛到全局

假設你的頁面裡有這麼一段腳本:

<script>
  var isDoingWork = false;
</script>

這個布爾變量的作用域是什麼?答案是全局。它並不「藏」在任何地方,而是被直接掛到了瀏覽器的全局 window 對象上。

打開瀏覽器開發者工具(Chrome / IE 按 F12,Opera 按 Ctrl-Shift-I),在控制台輸入 isDoingWork 回車,會看到輸出 false;再輸入 isDoingWork = true 回車,值就被改成了 true。你甚至可以直接寫 window.isDoingWork = true 來修改它——任何腳本、任何第三方庫都能改。

全局變量如何釀成事故

單看一個變量似乎無關痛癢,但現實中你往往會引入體量龐大的第三方庫,而且不會去讀完它幾千行源碼。假設你引入了一個名為 panacea.js 的庫:

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

而這個庫深處恰好有這麼一段:

var isDoingWork = false;
setInterval(function () { isDoingWork = !isDoingWork; }, 3000);

於是你的變量每 3 秒被翻轉一次,而你的業務邏輯基於它做判斷——一個極其難以定位的 bug 就此誕生。打開 modulePattern2.htm 反覆在控制台查看 isDoingWork,就能觀察到它自己每隔約 3 秒變化一次。

這不是杞人憂天:任何一個多人協作的前端項目,全局命名空間都是稀缺資源。

解決思路:模塊模式本質就是封裝

有物件導向經驗的人對「封裝」不會陌生——它是 OOP 三原則之一,另一種說法是「數據隱藏」。在 C# 這類語言中,字段可以聲明為 private,外部想改就必須通過構造函數或公開屬性:

public class Animal {
  // 構造函數允許外部設置
  public Animal(string name) { this.commonName = name; }
  // private 把字段隱藏在類內部
  private string commonName;
  // 只暴露讀取
  public string CommonName { get { return this.commonName; } }
}

JavaScript 基於原型,沒有 class 關鍵字(在 ES6 之前),於是社區用「模塊模式」來模擬同樣的效果:把變量關進函數作用域,只把需要對外暴露的成員掛到一個對象上。

關鍵語法:IIFE

要寫出模塊模式,必須先認識 IIFE(Immediately Invoked Function Expression,立即調用函數表達式,讀音近似 "iffy")。最基礎的形式是:

(function () {
  // 一行行的代碼
}());

拆解一下這段語法:

(            // 1. 最外層括號
  function() // 2. 匿名函數聲明
  {          // 3. 函數體開始
    // 代碼
  }()        // 4. 這對括號表示「立刻調用」
);           // 5. 外層括號結束

第 2 行是一個匿名函數;第 4 行末尾的括號告訴解釋器「馬上執行它」;而最外層那對包裹整個表達式的括號,是為了避免匿名函數被當成普通語句而報語法錯誤。

IIFE 也可以接收參數:

(function (thing1, thing2) {
  // 內部可以直接使用 thing1、thing2
}("in string", 382));

動手驗證封裝效果

(function () {
  var isDoingWork = false;
  console.log("isDoingWork value : " + isDoingWork);
}());

打開 modulePattern3.htm,可以看到控制台輸出了變量的值。接下來在控制台輸入 isDoingWork 回車,你會發現瀏覽器報錯,提示該變量未定義——即使你嘗試 window.isDoingWork,也拿不到它。

原因很簡單:變量現在被創建在一個函數內部,只有這個函數能訪問它。在 JavaScript 中,函數是第一類對象,同時也是產生作用域的機制。

用 this 打開一個出口

但封裝得太死也有問題:外部完全拿不到值,模塊就失去了意義。既然函數是對象,它就有一個 this,指向當前對象。把 this 返回出去,就等於把一個引用交給了外部。

thing = (function () {
  this.isDoingWork = false;                                  // 2. 掛到 this 上
  console.log("isDoingWork value : " + this.isDoingWork);
  return this;                                               // 3. 返回引用
}());

第一行新增了一個全局變量 thing,它接收匿名函數返回的 this;此後就能用 thing.isDoingWork 精確地讀寫這個值,而不再污染全局的其他命名。打開 modulePattern4.htm 可以對比驗證。

模塊模式小結

到這裡,模塊模式的要點已經全部出現:

  • 用 IIFE 建立私有作用域,內部變量對外不可見;
  • 只把需要暴露的成員掛到返回對象上,形成明確的公共接口;
  • 全局命名空間保持乾淨,命名衝突與意外改寫的風險大幅降低。

AngularJS 把這套實踐內建了起來

既然模塊模式是公認的最佳實踐,AngularJS 直接把模塊系統做進了框架。下面這個例子包含兩個控制器,各自封裝在自己的文件裡。

HTML 部分

<!DOCTYPE html>
<html ng-app="mainApp">
  <head>
  <meta charset="utf-8" />
  <title>Angular Module Example</title>
  <script src="https://code.angularjs.org/1.2.20/angular.js"></script>
  <script src="mainCtrl.js"></script>
  <script src="secondCtrl.js"></script>
  </head>

  <body>
  <div ng-controller="MainCtrl as mc">
    <p>Hello {{mc.name}}!</p>
    <ol><li ng-repeat="a in mc.allThings">{{a}}</li></ol>
  </div>
  <div ng-controller="SecondCtrl as sc">
    <p>Hello {{sc.name}}</p>
    <ol><li ng-repeat="a in sc.allThings">{{a}}</li></ol>
  </div>
  </body>
</html>

ng-app 是 Angular 的指令(directive),本質上是 Angular 定義的屬性,由編譯器轉換成實際行為。這裡我們給應用取名為 mainApp,它就是稍後模塊模式的起點。

頁面引入了 3 個腳本:第一個是 AngularJS 庫本身,另外兩個是被實現為模塊的控制器。把它們拆成獨立文件,正是為了讓代碼彼此隔離、各自封裝。

mainCtrl.js:第一個控制器

(function () {
  var app = angular.module('mainApp', []);

  app.controller('MainCtrl', function () {
    console.log("in MainCtrl...");
    // vt = virtual this,只是個縮寫
    var vt = this;
    vt.name = 'MainCtrl';
    vt.allThings = ["first", "second", "third"];
  });
}());

整體依然包在 IIFE 裡,確保文件加載時立即執行。第一行 angular.module('mainApp', []) 是 Angular 向自己命名空間註冊模塊的方式,第二個參數是依賴數組——傳空數組表示「新建」,省略它則表示「獲取已存在的模塊」,這個區別非常關鍵。

隨後 app.controller('MainCtrl', fn) 把控制器函數掛到模塊上。控制器執行時,this 上被掛了 name 與 allThings 兩個成員,它們既可以在稍後被讀取,又被封裝在控制器對象內部,不會被隨意改寫。

視圖如何拿到這些數據

<div ng-controller="MainCtrl as mc">
  <p>Hello {{mc.name}}!</p>
  <ol><li ng-repeat="a in mc.allThings">{{a}}</li></ol>
</div>

MainCtrl as mc 這個語法糖讓我們用 mc 這個短別名引用控制器實例,於是 {{mc.name}} 會被編譯成 Hello MainCtrl!。ng-repeat 則遍歷數組,把 allThings 渲染成三個列表項。

secondCtrl.js:幾乎一樣,只有一處不同

(function () {
  var app = angular.module('mainApp');   // 注意:沒有依賴數組

  app.controller('SecondCtrl', function () {
    console.log("in SecondCtrl...");
    var vt = this;
    vt.name = 'SecondCtrl';
    vt.allThings = ["bacon", "lettuce", "tomato"];
  });
}());

唯一的差別是 angular.module('mainApp') 沒有傳第二個參數。因為 mainApp 已經存在,這裡是「獲取」而非「創建」,只是往已有的模塊上再掛一個控制器。若此處誤傳空數組,Angular 會把之前的模塊配置全部丟棄。

總結

回顧整條路徑:全局變量會引發命名衝突與難以追蹤的 bug;IIFE 提供私有作用域;返回 this 或指定對象形成公共接口;AngularJS 的 module / controller 機制把這套模式標準化了下來。

這不只是 Angular 的寫法,也是當代前端工程化的通用思路。學會它、用它,後續接觸任何現代框架都會輕鬆很多。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved