在沒有模組系統的年代,把所有函式與變數都掛在全域物件上會造成严重衝突。命名空間(namespace)就是為了解決這個問題而生的組織手法。本文示範如何寫一個能自動建立巢狀結構的 namespace 函式。
var MYAPP = MYAPP || {};
MYAPP.namespace = function(ns_string){
var parts = ns_string.split('.');
var parent = MYAPP;
var i = 0;
if (parts[0] === "MYAPP"){
parts = parts.slice(1);
}
for (i = 0; i < parts.length; i++){
if (typeof parent[parts[i]] === 'undefined'){
parent[parts[i]] = {};
}
parent = parent[parts[i]];
}
return parent;
}
var module2 = MYAPP.namespace('MYAPP.modules.module2');
第一行 var MYAPP = MYAPP || {}; 是整個模式的起點:如果 MYAPP 已存在就沿用,否則建立空物件。這樣不論這個檔案被引入幾次,都不會把先前的內容洗掉。
namespace 函式做的事是「依路徑逐層建立並下降」:把 'MYAPP.modules.module2' 用點號切成陣列,去掉開頭的 MYAPP(因為 parent 已經是它了),然後迴圈逐一檢查——若該層屬性還不存在就建一個空物件,接著把 parent 指向它,往下一層走。迴圈結束後回傳最末端的物件,方便直接掛東西上去。
var utils = MYAPP.namespace('MYAPP.utils');
utils.formatDate = function(d){ /* ... */ };
utils.formatMoney = function(n){ /* ... */ };
// 之後呼叫
MYAPP.utils.formatMoney(1000);
// 也可以直接掛在回傳值上
var module2 = MYAPP.namespace('MYAPP.modules.module2');
module2.init = function(){ /* ... */ };
這個模式在 jQuery 外掛盛行的年代幾乎是標準寫法($.myPlugin = ... 就是同一思路)。但 ES6 之後,JavaScript 有了原生的模組系統,命名空間的必要性大幅下降:
// utils.js —— 明確宣告對外公開什麼
export function formatMoney(n){ /* ... */ }
export function formatDate(d){ /* ... */ }
// main.js —— 明確宣告需要什麼
import { formatMoney } from './utils.js';
ES Module 的優勢在於:依賴關係是靜態且明示的(不必猜某個全域變數由誰定義)、自動套用該檔案的作用域(不污染全域)、支援 tree-shaking(未使用的程式碼會被消除)、且瀏覽器與 Node.js 都原生支援。
所以本文的 namespace 函式今天的價值主要在兩個方面:一是理解「全域污染為什麼是問題」以及前 ES6 時代如何權衡;二是維護老專案時看得懂、改得動這類程式碼。
範例中 typeof parent[parts[i]] === 'undefined' 的判斷必須用 typeof,不能直接寫 if (!parent[parts[i]])。因為若該屬性存在但值為 0、'' 或 false,後者會誤判為不存在而把它覆蓋成空物件。用 typeof 比對才是精確的「是否存在」檢查。