好程序員分享 JavaScript 命名空間模式實(shí)例詳解, 本文實(shí)例講述了 JavaScript命名空間模式 , 具體如下:
成都創(chuàng)新互聯(lián)公司成立與2013年,先為龍門(mén)等服務(wù)建站,龍門(mén)等地企業(yè),進(jìn)行企業(yè)商務(wù)咨詢(xún)服務(wù)。為龍門(mén)企業(yè)網(wǎng)站制作PC+手機(jī)+微官網(wǎng)三網(wǎng)同步一站式服務(wù)解決您的所有建站問(wèn)題。命名空間可以被認(rèn)為是唯一標(biāo)識(shí)符下代碼的邏輯分組。為什么會(huì)出現(xiàn)命名空間這一概念呢?因?yàn)榭捎玫膯卧~數(shù)太少,并且不同的人寫(xiě)的程序不可能所有的變量都沒(méi)有重名現(xiàn)象。在 JavaScript中,命名空間可以幫助我們防止與全局命名空間下的其他對(duì)象或變量產(chǎn)生沖突。命名空間也有助于組織代碼,有更強(qiáng)的可維護(hù)性和可讀性。本文旨在探討JavaScript里的幾種常見(jiàn)命名空間模式,為我們提供一個(gè)思路。
JavaScript執(zhí)行環(huán)境有很多獨(dú)特之處,全局變量和函數(shù)的使用就是其中之一。JavaScript的執(zhí)行環(huán)境由各種各樣的全局變量構(gòu)成,這些全局變量先于函數(shù)執(zhí)行環(huán)境而創(chuàng)建。這些全局變量都掛載于“全局對(duì)象”下,在瀏覽器中,window對(duì)象就等同于全局對(duì)象。那么,在全局作用域中聲明的任何變量和函數(shù)都是window對(duì)象的屬性,當(dāng)名稱(chēng)有沖突時(shí),就會(huì)產(chǎn)生一些不可控的問(wèn)題。全局變量會(huì)帶來(lái)以下問(wèn)題:
命名沖突
代碼的脆弱性
難以測(cè)試
在編程開(kāi)發(fā)中合理的使用命名空間,可以避免相同的變量或?qū)ο竺Q(chēng)產(chǎn)生的沖突。而且,命名空間也有助于組織代碼,有更強(qiáng)的可維護(hù)性和可讀性。 JavaScript中雖然沒(méi)有提供原生的命名空間支持,但我們可以使用其他的方法(對(duì)象和閉包)實(shí)現(xiàn)類(lèi)似的效果。下面就是一些常見(jiàn)的命名空間模式:
1.單一全局變量
JavaScript中一個(gè)流行的命名空間模式是選擇一個(gè)全局變量作為主要的引用對(duì)象。因?yàn)槊總€(gè)可能的全局變量都成為唯一全局變量的屬性,也就不用再創(chuàng)建多個(gè)全局變量,那么也就避免了和其他聲明的沖突。
單一全局變量模式已經(jīng)在不少的 JavaScript類(lèi)庫(kù)中使用,如:
示例如下:
var myApplication = (function() {
function() {
// ***
},
return {
// **
}
})();
雖然單一全局變量模式適合某些情況,但其大的挑戰(zhàn)是確保單一全局變量在頁(yè)面中是唯一使用的,不會(huì)發(fā)生命名沖突。
2.命名空間前綴
命名空間前綴模式其思路非常清晰,就是選擇一個(gè)獨(dú)特的命名空間,然后在其后面聲明聲明變量、方法和對(duì)象。示例如下:
var = myApplication_propertyA = {};
var = myApplication_propertyA = {};
function myApplication_myMethod() {
// ***
}
從某種程度上來(lái)說(shuō),它確實(shí)減少了命名沖突的發(fā)生概率,但其并沒(méi)有減少全局變量的數(shù)目。當(dāng)應(yīng)用程序規(guī)模擴(kuò)大時(shí),就會(huì)產(chǎn)生很多的全局變量。在全局命名空間內(nèi),這種模式對(duì)其他人都沒(méi)有使用的這個(gè)前綴有很強(qiáng)的依賴(lài),而且有些時(shí)候也不好判斷是否有人已經(jīng)使用某個(gè)特殊前綴,在使用這種模式時(shí)一定要特別注意。
3.對(duì)象字面量表示法
對(duì)象字面量模式可以認(rèn)為是包含一組鍵值對(duì)的對(duì)象,每一對(duì)鍵和值由冒號(hào)分隔,鍵也可以是代碼新的命名空間。示例如下:
var myApplication = {
// 可以很容易的為對(duì)象字面量定義功能
getInfo:function() {
// ***
},
// 可以進(jìn)一步支撐對(duì)象命名空間
models:{},
views:{
pages:{}
},
collections:{}
};
與為對(duì)象添加屬性一樣,我們也可以直接將屬性添加到命名空間。對(duì)象字面量方法不會(huì)污染全局命名空間,并在邏輯上協(xié)助組織代碼和參數(shù)。并且,這種方式可讀性和可維護(hù)性非常強(qiáng),當(dāng)然我們?cè)谑褂脮r(shí)應(yīng)當(dāng)進(jìn)行同名變量的存在性測(cè)試,以此來(lái)避免沖突。下面是一些常用的檢測(cè)方法:
var myApplication = myApplication || {};
if(!myApplication) {
myApplication = {};
}
window.myApplication || (window.myApplication || {});
// 針對(duì)jQuery
var myApplication = $.fn.myApplication = function() {};
var myApplication = myApplication === undefined ? {} :myApplication;
對(duì)象字面量為我們提供了優(yōu)雅的鍵 /值語(yǔ)法,我們可以非常便捷的組織代碼,封裝不同的邏輯或功能,而且可讀性、可維護(hù)性、可擴(kuò)展性極強(qiáng)。
4.嵌套命名空間
嵌套命名空間模式可以說(shuō)是對(duì)象字面量模式的升級(jí)版,它也是一種有效的避免沖突模式,因?yàn)榧词挂粋€(gè)命名空間存在,它也不太可能擁有同樣的嵌套子對(duì)象。示例如下:
var myApplication = myApplication || {}; // 定義嵌套子對(duì)象 myApplication.routers = myApplication.routers || {}; myApplication.routers.test = myApplication.routers.test || {}; |
當(dāng)然,我們也可以選擇聲明新的嵌套命名空間或?qū)傩宰鳛樗饕龑傩?,如?/p>
myApplication['routers'] = myApplication['routers'] || {}; |
使用嵌套命名空間模式,可以使代碼易讀且有組織性,而且相對(duì)安全,不易產(chǎn)生沖突。其弱點(diǎn)是,如果我們的命名空間嵌套過(guò)多,會(huì)增加瀏覽器的查詢(xún)工作量,我們可以把要多次訪問(wèn)的子對(duì)象進(jìn)行局部緩存,以此來(lái)減少查詢(xún)時(shí)間。
5.立即調(diào)用的函數(shù)表達(dá)式
立即調(diào)用函數(shù)( IIFE)實(shí)際上就是匿名函數(shù),被定義后立即被調(diào)用。在JavaScript中,由于變量和函數(shù)都是在這樣一個(gè)只能在內(nèi)部進(jìn)行訪問(wèn)的上下文中被顯式地定義,函數(shù)調(diào)用提供了一種實(shí)現(xiàn)私有變量和方法的便捷方式。IIFE是用于封裝應(yīng)用程序邏輯的常用方法,以保護(hù)它免受全局名稱(chēng)空間的影響,其在命名空間方面也可以發(fā)揮其特殊的作用。示例如下:
// 命名空間和undefined作為參數(shù)傳遞,確保: // 1.命名空間可以在局部修改,不重寫(xiě)函數(shù)外部上下文 // 2.undefined 的參數(shù)值是確保undefined,避免ES5規(guī)范里定義的undefined (function (namespace, undefined) { // 私有屬性 var foo = "foo"; bar = "bar"; // 公有方法和屬性 namespace.foobar = "foobar"; namespace.sayHello = function () { say("Hello World!"); }; // 私有方法 function say(str) { console.log("You said:" + str); }; })(window.namespace = window.namespace || {}); |
可擴(kuò)展性是任何可伸縮命名空間模式的關(guān)鍵,使用 IIFE可以輕松實(shí)現(xiàn)這一目的,我們可以再次使用IIFE給命名空間添加更多的功能。
6.命名空間注入
命名空間注入是 IIFE的另一個(gè)變體,從函數(shù)包裝器內(nèi)部為一個(gè)特定的命名空間“注入”方法和屬性,使用this作為命名空間代理。這種模式的優(yōu)點(diǎn)是可以將功能行為應(yīng)用到多個(gè)對(duì)象或命名空間。示例如下:
var myApplication = myApplication || {}; myApplication.utils = {}; (function () { var value = 5; this.getValue = function () { return value; } // 定義新的子命名空間 this.tools = {}; }).apply(myApplication.utils); (function () { this.diagnose = function () { return "diagnose"; } }).apply(myApplication.utils.tools); // 同樣的方式在普通的IIFE上擴(kuò)展功能,僅僅將上下文作為參數(shù)傳遞并修改,而不是僅僅使用this |
還有一種使用 API來(lái)實(shí)現(xiàn)上下文和參數(shù)自然分離的方法,該模式感覺(jué)更像是一個(gè)模塊的創(chuàng)建者,但作為模塊,它還提供了一個(gè)封裝解決方案。示例如下:
var ns = ns || {}, ns1 = ns1 || {}; // 模塊、命名空間創(chuàng)建者 var creator = function (val) { var val = val || 0; this.next = function () { return val ++ ; }; this.reset = function () { val = 0; } } creator.call(ns); // ns.next, ns.reset 此時(shí)已經(jīng)存在 creator.call(ns1, 5000); // ns1包含相同的方法,但值被重寫(xiě)為5000了 |
命名空間注入是用于為多個(gè)模塊或命名空間指定一個(gè)類(lèi)似的功能基本集,但最好是在聲明私有變量或者方法時(shí)再使用它,其他時(shí)候使用嵌套命名空間已經(jīng)足以滿(mǎn)足需要了。
7.自動(dòng)嵌套的命名空間
嵌套命名空間模式可以為代碼單元提供有組織的結(jié)構(gòu)層級(jí),但每次創(chuàng)建一個(gè)層級(jí)時(shí),我們也得確保其有相應(yīng)的父層級(jí)。當(dāng)層級(jí)數(shù)量很大時(shí),會(huì)給我們帶來(lái)很大的麻煩,我們不能快速便捷的創(chuàng)建想創(chuàng)建的層級(jí)。那么如何解決這個(gè)問(wèn)題呢? Stoyan Stefanov提出,創(chuàng)建一個(gè)方法,其接收字符串參數(shù)作為一個(gè)嵌套,解析它,并自動(dòng)用所需的對(duì)象填充基本名稱(chēng)空間。下面是這種模式的一種實(shí)現(xiàn):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | function extend(ns, nsStr) { var parts = nsStr.split("."), parent = ns, pl; pl = parts.length; for (var i = 0; i < pl; i++) { // 屬性如果不存在,則創(chuàng)建它 if (typeof parent[parts[i]] === "undefined") { parent[prats[i]] = {}; } parent = parent[parts[i]]; } return parent; } // 用法 var myApplication = myApplication || {}; var mod = extend(myApplication, "module.module2"); |