DIV CSS 佈局教程網

在 JavaScript 中實作命名空間機制
編輯:關於JavaScript     

近來轉做 Web 開發,開始學 JavaScript,把在公司內網寫的一篇筆記搬出來。主題是命名空間——一個在多框架共存時代變得越來越重要的觀念。

問題:名字撞車

在引入命名空間之前,最頭痛的就是函式名/類名與別人衝突。公司內部專案之間可以靠「命名預約」(例如全部加前綴)解決,但把視野放到整個軟體開發領域,在協作開發盛行的時代這個問題依然存在。使用多個第三方框架或類庫時,你唯一能做的就是祈禱它們的命名不要撞;真的發生那種災難,唯一選擇是放棄其中一個。

JavaScript 當時的最新版本並不支援命名空間,所以衝突問題格外突出。想像你引用了兩個 js 檔,卻因為命名問題不得不放棄其中一個、多寫一堆程式碼,實在令人沮喪。在標準引入這個概念之前,自立自強是我們工程師的義務。

前提:JavaScript 裡「類就是物件」

與 Delphi、C# 不同,JavaScript 的類並不是物件的定義——事實上它並不存在真正的類,這裡所說的「類」是用函式模擬出來的。而函式在 JavaScript 中本身就是一個物件,因此結論是:一個類就是一個物件。這與傳統概念極為不同。

看懂這點,設計模式有概念的人就會發現:JavaScript 的類機制其實使用了原型(prototype)模式。

原理:層層嵌套的物件

既然類的本質是物件,問題就簡單了。把 GEA 專案組所有的 JS 類與函式當成屬性,放在一個名為 GEA 的物件裡;再把 GEA 當屬性放在名為 Grandsoft 的物件裡。於是 Grandsoft.GEA.Person 就是「Grandsoft 物件的 GEA 屬性中的 Person 類」。

實作:不超過 20 行

// 宣告一個全域物件,用來註冊命名空間
Namespace = new Object();

// 全域物件只有 register 一個函式,參數為命名空間全路徑,如 "Grandsoft.GEA"
Namespace.register = function (fullNS) {
  var nsArray = fullNS.split('.');   // 切成 Grandsoft、GEA 等片段
  var sEval = "";
  var sNS = "";

  for (var i = 0; i < nsArray.length; i++) {
    if (i != 0) sNS += ".";
    sNS += nsArray[i];
    // 逐層組出「若不存在則建立」的敘述
    // 先建 Grandsoft,再建 Grandsoft.GEA,依此類推
    sEval += "if (typeof(" + sNS + ") == 'undefined') " +
             sNS + " = new Object();";
  }
  if (sEval != "") eval(sEval);
}

核心技巧是:把「建立一層層物件」這件事,組合成一段程式碼字串再 eval。以 "Grandsoft.GEA" 為例,eval 的內容會是:

if (typeof(Grandsoft) == 'undefined') Grandsoft = new Object();
if (typeof(Grandsoft.GEA) == 'undefined') Grandsoft.GEA = new Object();

這樣不管傳入幾層路徑,都能確保每一層都存在,且不會覆蓋已有的物件。

使用方式

// 註冊命名空間
Namespace.register("Grandsoft.GEA");
Namespace.register("Grandsoft.GCM");

// 在 Grandsoft.GEA 裡宣告類 Person
Grandsoft.GEA.Person = function (name, age) {
  this.name = name;
  this.age  = age;
};

// 為 Person 加上公開方法 show()
Grandsoft.GEA.Person.prototype.show = function () {
  alert(this.name + " is " + this.age + " years old!");
};

// 使用
var p = new Grandsoft.GEA.Person("yanglf", 25);
p.show();

不用 eval 的改寫

用 eval 組程式碼是當年常見手法,但它有兩個問題:效能較差,而且任何 eval 都值得先問「有沒有更安全的寫法」。答案是有——用迴圈逐層建立屬性即可:

var Namespace = {};
Namespace.register = function (fullNS) {
  var parts = fullNS.split(".");
  var cur = window;                     // 從全域物件開始
  for (var i = 0; i < parts.length; i++) {
    if (typeof cur[parts[i]] == "undefined") {
      cur[parts[i]] = {};
    }
    cur = cur[parts[i]];                // 往下一層走
  }
  return cur;
};

Namespace.register("Grandsoft.GEA");
Namespace.register("Grandsoft.GCM");

邏輯完全相同,但不經過字串組 code,也沒有 eval 的風險。這個 register 函式同時回傳最底層的物件,呼叫端可以直接接著掛東西上去,更方便。

補充:物件常數與現代模組

再往前一步,可以把「命名空間」直接定義成巢狀的物件常數,用 IIFE 保持內部變數私有:

var Grandsoft = (function () {
  var _internal = 0;                   // 外部無法存取

  function Person(name, age) {
    this.name = name;
    this.age  = age;
  }
  Person.prototype.show = function () {
    return this.name + " is " + this.age;
  };

  return { Person: Person };           // 只對外公開 Person
})();

new Grandsoft.Person("yanglf", 25).show();

而 ES2015 之後,語言本身提供了正式的模組系統:export 與 import。模組有自己的作用域、依賴關係明確、可以靜態分析以便 tree-shaking,是命名空間問題的標準答案。上面這套手工機制今天的價值,在於理解「為什麼需要模組」——以及在你手上只有一支 <script> 標籤、無法使用打包工具時,它仍然管用。

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