「全域變數是魔鬼」這句話,凡是 JavaScript 存在的地方都成立,Firefox 擴充自然也不例外。如果你往全域命名空間丟了不只一個物件,與其他擴充發生衝突幾乎是遲早的事,而且這種衝突造成的錯誤極難追查——畢竟每個人裝的擴充清單都不一樣。避免全域命名空間污染已經是基本原則,本文由這點出發,介紹一套應用在 Firebug 上的擴充架構模式,非常值得參考。
【原文】Firefox Extensions: Global Namespace Pollution
【作者】Jan Odvarko
【譯者】明達
最近有幾位開發者問我 Firefox 擴充該怎麼設計架構,我腦中浮現的第一個答案就是:審慎規劃 ChromeWindow 作用域下的全域變數。
全域變數定義不當,很容易讓不同擴充互相衝突,而這完全是應該避免的(AMO 審查流程也包括這一項),因為衝突引發的問題實在難以發現。以目前的開發環境來說,全域變數就是魔鬼,採用 OOP 模式時更是如此。
關於「如何從零開始寫一個 Firefox 擴充」,已經有很多詳細文章,我不打算重複。本文重點在於如何設計一個更容易維護的擴充架構。
命名空間架構
擴充衝突的主因就是定義了不當的全域變數。我認為每個擴充只需要一個全域變數就足夠了(名稱可以依擴充資訊決定,例如擴充名稱、網域或位址),既能滿足開發需求,也能避開那些麻煩的衝突。
Firebug 的命名空間架構基本建立在知名的 Module Pattern 之上(最早由 Douglas Crockford 提出)。這個模式簡單清晰,不過我得承認有很長一段時間並不真的理解它怎麼運作。
基本思路是把每個 JavaScript 檔放進自己的作用域,這靠一個函式來實現,不定義任何全域變數:
function() {
// 檔案中的所有程式碼
}
我把這個函式稱為命名空間。第一個問題是:怎麼確保它在正確的時機被呼叫。第二個問題是:如何在多個檔案之間共用物件(後面會回答)。Firebug 的解法是把所有命名空間先註冊起來,等 Firefox chrome UI 載入時再一次執行:
myExtension.ns(function()
{
// 檔案中的所有程式碼
});
這裡的命名空間函式被當成 myExtension.ns 的參數傳入,而 myExtension 是本擴充唯一的全域變數,代表整個擴充。名字太長不用擔心,可以另外建立捷徑(實務上這個名字可能類似 comSoftwareIsHardMyExtension)。
ns 函式本身很簡單,就是把方法都塞進一個陣列:
var namespaces = [];
this.ns = function(fn)
{
var ns = {};
namespaces.push(fn, ns);
return ns;
};
執行已註冊命名空間的函式不要叫 apply,其他名字都可以:
this.initialize = function() {
for (var i = 0; i < namespaces.length; i += 2) {
var fn = namespaces[i];
var ns = namespaces[i + 1];
fn.apply(ns);
}};
把前面的部分湊起來,就能看出全域擴充物件如何定義與初始化。以下是 browserOverlay.js 的內容,這個檔案會在 browserOverlay.xul 中被引用:
// 擴充唯一的全域變數
var myExtension = {};
(function() { // 註冊命名空間
var namespaces = [];
this.ns = function(fn) {
var ns = {};
namespaces.push(fn, ns);
return ns;
};
// 初始化
this.initialize = function() {
for (var i = 0; i < namespaces.length; i += 2) {
var fn = namespaces[i];
var ns = namespaces[i + 1];
fn.apply(ns);
}
};
// 收尾清理
this.shutdown = function() {
window.removeEventListener("load", myExtension.initialize, false);
window.removeEventListener("unload", myExtension.shutdown, false);
};
// 維護擴充的生命週期
window.addEventListener("load", myExtension.initialize, false);
window.addEventListener("unload", myExtension.shutdown, false);
}).apply(myExtension);
如前面所述,這裡只有一個全域物件 myExtension。它需要實作三個方法:
同時,兩個事件監聽器確保 initialize 與 shutdown 會在正確的時機被呼叫。
browserOverlay.xul 則大致如下:
<?xml version="1.0"?>
<overlay xmlns="https://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
<script src="chrome://namespace/content/browserOverlay.js" type="application/x-javascript"/>
<script src="chrome://namespace/content/Module1.js" type="application/x-javascript"/>
<script src="chrome://namespace/content/Module2.js" type="application/x-javascript"/>
</overlay>
Module1.js 與 Module2.js 的內容相同:
myExtension.ns(function() {
// 檔案中的所有程式碼
});
在模組間共享資料
所有腳本都被放進區域作用域之後,接著要解決第二個問題:如何在不同命名空間間共用函式與資料。思路理所當然是透過那個唯一的全域物件 myExtension。
先來看這段程式(都在 lib.js 中):
myExtension.LIB = {
// 共用函式介面
getCurrentURI: function() {
return window.location.href;
},
// 擴充物件的捷徑
theApp: myExtension,
// XPCOM 元件的捷徑
Cc: Components.classes,
Ci: Components.interfaces,
// 等等……
};
這裡在全域 myExtension 之下開了一個 LIB 屬性,定義一個要在所有模組間共用的函式庫。你應該在 Java 的套件結構看過同樣的做法:所有命名空間呈樹狀掛在一個唯一物件底下,YUI 也是這樣做的。
lib.js 一樣在 browserOverlay.xul 中引入,位置緊跟在 browserOverlay.js 之後:
<?xml version="1.0"?>
<overlay xmlns="https://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
<script src="chrome://myextension/content/browserOverlay.js" type="application/x-javascript"/>
<script src="chrome://myextension/content/lib.js" type="application/x-javascript"/>
<script src="chrome://myextension/content/Module1.js" type="application/x-javascript"/>
<script src="chrome://myextension/content/Module2.js" type="application/x-javascript"/>
</overlay>
模組內的腳本也可以再修一點:
myExtension.ns(function() {
with(myExtension.LIB) {
// 檔案中的所有程式碼
var moduleVariable = "僅供本模組存取";
dump("myExtension.Module initialization " + getCurrentURI() + "\n");
}
});
透過 with 語句,我們能像使用全域變數一樣方便地存取所有函式庫成員。
而若要存取代全域物件,還可以利用 theApp 這個捷徑(尤其命名空間名稱很長的時候):
myExtension.ns(function() {
with(myExtension.LIB) {
// 檔案中的所有程式碼
theApp.sharedValue = "新的共用屬性";
}
});
下圖從 UML 角度呈現整個架構:
