DIV CSS 佈局教程網

JavaScript 模組化與命名空間管理:從隨手一個全域物件說起
編輯:關於JavaScript     

為什麼要模組化

這個問題跟編碼思想與程式碼管理的便利度有關。模組化的精神其實與物件導向如出一轍,差別只在於我們口中的「模組」是比「物件」更大的物件——把致力於同一個目的的功能函式,透過良好的封裝組合起來,並確保它便於複用。

這樣做的好處很直觀:易用、通用、易維護、可讀性高,還能順便避開變數名污染。而模組化,基本上就是「面向模組」版的物件導向:把同一個專案相關的功能有機地組合,用一個共同的名字管理起來。就程式架構而言,貫徹模組化其實比貫徹物件導向更容易一些。

JavaScript 沒有現成的機制

C#、Java 這類強型別語言天生就有完善的模組與命名空間機制,JavaScript 則不然——語言本身完全沒有為建立和管理模組提供任何功能。所以我們平時對命名空間的使用,常常顯得過於隨便:

var Hongru = {}   // namespace

(function(){
    Hongru.Class1 = function () {
        //TODO
    };
    Hongru.Class2 = function () {
        //TODO
    };
})();

一個全域變數或全域物件,就這樣被賦予了命名空間這麼重大的責任。但這麼做錯了嗎?不錯。對中小型站點來說,這點手段基本夠用,不太會出亂子。可是如果規模變大、專案變多,或者你一開始就抱著追求優雅架構的態度,那就該考慮更嚴謹的註冊與管理方式了。

在這方面,jQuery 比起 YUI、MooTools、Ext 稍遜一籌(雖然 jQuery 也有自己的一套機制)。這不妨礙我們喜歡它——側重點不同,jQuery 強在選擇器,否則也不會叫 j-Query 了。所以說它適合中小型網站,確實有道理;豆瓣開源的前端輕量級框架 Do,也是建立在 jQuery 之上,再封裝一層模組化管理與檔案同步載入。

命名空間會遇到的兩個真問題

用全域物件當命名空間,確實能減少全域變數、規避污染。但規模一大,管理多個全域物件的名字本身就會出問題:一旦不幸撞名,一個模組會覆蓋掉另一個模組的屬性,導致其中之一或兩者都無法正常運作,事後排查還特別麻煩。所以我們需要一套機制,在建立命名空間的當下就能判斷是否重名。

另一方面,不同模組之間也無法完全獨立。我們時常需要在不同命名空間下建立相同的方法或屬性,這時候「匯入」與「匯出」就成了課題。

針對這兩點,《JavaScript 權威指南》(犀牛書)給了很乾淨的解法。以下是我依據該方案簡化改寫的版本。

核心:createNamespace

因為命名空間本質上是物件、有層級關係,所以註冊子命名空間(例如 Hongru.me)時必須沿著層級逐層判斷。做法是先用 . 切開,再逐段確認:

// 建立命名空間,回傳最上層的 namespace 物件
Module.createNamespace = function (name, version) {
    if (!name) throw new Error('name required');
    if (name.charAt(0) == '.' ||
        name.charAt(name.length - 1) == '.' ||
        name.indexOf('..') != -1) throw new Error('illegal name');

    var parts = name.split('.');
    var container = Module.globalNamespace;

    for (var i = 0; i < parts.length; i++) {
        var part = parts[i];
        if (!container[part]) container[part] = {};
        container = container[part];
    }

    var namespace = container;
    if (namespace.NAME) throw new Error('module "' + name + '" is already defined');
    namespace.NAME = name;
    if (version) namespace.VERSION = version;

    Module.modules[name] = namespace;   // 登記到模組隊列
    return namespace;
};

這裡的 Module 是我們用來註冊與管理命名空間的「基模組」,它有一個 modules 屬性作為模影片列,存放所有已註冊的命名空間——正是有了這條隊列,我們才能方便地判斷是否重名:

var Module;
// 先確認 Module 尚未被佔用
if (!!Module && (typeof Module != 'object' || Module.NAME))
    throw new Error("NameSpace 'Module' already Exists!");

Module = {};
Module.NAME    = 'Module';
Module.VERSION = 0.1;

Module.EXPORT    = ['require', 'importSymbols'];
Module.EXPORT_OK = ['createNamespace', 'isDefined', 'modules', 'globalNamespace'];

Module.globalNamespace = this;
Module.modules = {'Module': Module};

測試一下:

Module.createNamespace('Hongru', 0.1);   // 第二個參數是版本號,可省略

在 Chrome 的除錯工具裡可以看到,新註冊的 Hongru 命名空間已經生效:

而 Module 的模影片列裡也多出了它:

版本與重名檢測

// 檢查名字是否已註冊
Module.isDefined = function (name) {
    return name in Module.modules;
};

// 檢查版本是否足夠
Module.require = function (name, version) {
    if (!(name in Module.modules)) throw new Error('Module ' + name + ' is not defined');
    if (!version) return;
    var n = Module.modules[name];
    if (!n.VERSION || n.VERSION < version)
        throw new Error('version ' + version + ' or greater is required');
};

屬性與方法的匯出/匯入

既然要做的是通用的命名空間工具,匯入匯出就必須可配置,不能一股腦全部搬。因此 Module 模板裡準備了兩個陣列作為標記隊列:EXPORT 是公開標記,EXPORT_OK 是可由呼叫端自訂的標記。若你覺得不必分這麼細,只用一個也完全可以。

Module.importSymbols = function (from) {
    if (typeof from == 'string') from = Module.modules[from];
    var to = Module.globalNamespace;   // 預設匯入到全域命名空間
    var symbols = [];
    var firstsymbol = 1;

    if (arguments.length > 1 && typeof arguments[1] == 'object' && arguments[1] != null) {
        to = arguments[1];
        firstsymbol = 2;
    }
    for (var a = firstsymbol; a < arguments.length; a++) symbols.push(arguments[a]);

    if (symbols.length == 0) {
        if (from.EXPORT) {
            for (var i = 0; i < from.EXPORT.length; i++) {
                var s = from.EXPORT[i];
                to[s] = from[s];
            }
            return;
        } else if (!from.EXPORT_OK) {
            for (var s in from) { to[s] = from[s]; }
            return;
        }
    }

    if (symbols.length > 0) {
        var allowed;
        if (from.EXPORT || from.EXPORT_OK) {
            allowed = {};
            if (from.EXPORT) {
                for (var i = 0; i < from.EXPORT.length; i++) allowed[from.EXPORT[i]] = true;
            }
            if (from.EXPORT_OK) {
                for (var i = 0; i < from.EXPORT_OK.length; i++) allowed[from.EXPORT_OK[i]] = true;
            }
        }

        for (var i = 0; i < symbols.length; i++) {
            var s = symbols[i];
            if (!(s in from)) throw new Error('symbol ' + s + ' is not defined');
            if (!!allowed && !(s in allowed))
                throw new Error(s + ' is not public, cannot be imported');
            to[s] = from[s];
        }
    }
};

參數安排是:第一個是來源空間,第二個是目的空間(可選,預設為 globalNamespace),後續參數則是你想匯出的具體屬性或方法(可選,預設是標記隊列裡的全部)。

測試:

Module.createNamespace('Hongru');
Module.createNamespace('me', 0.1);

me.EXPORT = ['define'];
me.define = function () { this.NAME = '__me'; };

Module.importSymbols(me, Hongru);   // 把 me 底下被標記的成員匯入 Hongru

執行結果如圖,原本定義在 me 底下的 define() 就出現在 Hongru 上了:

要注意的是,這裡所謂的「匯入」其實只是複製(copy),me 底下依然能正常存取 define()。

結語

這套 demo 提供的是一種管理命名空間的思路,肯定有更完善的做法,可以參考 YUI、Ext 等框架的實作,或者直接翻《JavaScript 權威指南》中談模組與命名空間的那一章。完整的原始碼在原文末尾亦有附上,包含 createNamespace、isDefined、require 與 importSymbols 四個方法,可直接取用。

放到今天來看,ES6 的 import / export 與 Node 的 CommonJS 已經是標準答案,這套手工機制主要存在於「維護老專案」與「理解背後原理」兩個價值上——但理解它,你才知道打包工具到底替你做了什麼。

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