Douglas Crockford 提出過一個實用性極高的單例模式,特別適合以 YUI 為基礎的專案。他把這個做法稱為「模組模式」(module pattern)。運作方式可以拆成四步。
用 YUI 的話直接呼叫:
YAHOO.namespace("myProject");
這會掛一個空的 myProject 物件到 YAHOO 上(若已存在則不會被覆寫),之後就能往 YAHOO.myProject 裡添加成員。
YAHOO.myProject.myModule = function () {
return {
myPublicProperty: "我作為 YAHOO.myProject.myModule.myPublicProperty 被存取。",
myPublicMethod: function () {
YAHOO.log("我作為 YAHOO.myProject.myModule.myPublicMethod 被存取。");
}
};
}(); // 這個括號讓匿名函式立刻執行並回傳
注意最後那行——收尾的大括號加上緊接的 (),觸發了函式的立即執行。回傳的物件就此成為 YAHOO.myProject.myModule。
YAHOO.myProject.myModule = function () {
// 私有變數
var myPrivateVar = "我僅能在 YAHOO.myProject.myModule 內被存取。";
// 私有方法
var myPrivateMethod = function () {
YAHOO.log("我僅能在 YAHOO.myProject.myModule 內被存取。");
}
return {
myPublicProperty: "我作為 YAHOO.myProject.myModule.myPublicProperty 能被存取。",
myPublicMethod: function () {
YAHOO.log(myPrivateVar);
YAHOO.log(myPrivateMethod());
// 公開成員在函式內用 this 存取
YAHOO.log(this.myPublicProperty);
}
};
}();
在模組外部只能透過 YAHOO.myProject.myModule.xxx 存取公開成員;而 myPrivateVar 與 myPrivateMethod 只有匿名函式本身或回傳物件的成員能看到。雖然匿名函式執行完就該結束了,但憑藉閉包的力量——函式的區域變數在函式返回後仍然保留——這兩個私有成員會一直存活,直到 myModule 不再被需要為止。
假設有個列表,其中部分項目可以拖曳(帶有 draggable class):
<script type="text/javascript"
src="https://yui.yahooapis.com/2.2.2/build/utilities/utilities.js"></script>
<ul id="myList">
<li class="draggable">一項</li>
<li>二項</li> <!-- 二項將不能被拖拽 -->
<li class="draggable">三項</li>
</ul>
<script>
YAHOO.namespace("myProject");
YAHOO.myProject.myModule = function () {
// 私有簡寫參照,省字又省查詢
var yue = YAHOO.util.Event,
yud = YAHOO.util.Dom;
var getListItems = function () {
var elList = yud.get("myList");
return yud.getElementsByClassName(
"draggable", // 只取帶此 class 的項目
"li", // 只取列表項
elList // 限定搜尋範圍
);
};
return {
aDragObjects: [], // 對外公開,存放 DD 物件
init: function () {
yue.onDOMReady(this.makeLIsDraggable, this, true);
},
makeLIsDraggable: function () {
var aListItems = getListItems();
for (var i = 0, j = aListItems.length; i < j; i++) {
this.aDragObjects.push(new YAHOO.util.DD(aListItems[i]));
}
}
};
}();
YAHOO.myProject.myModule.init(); // 模組已執行完畢,可立即呼叫
</script>
這例子刻意寫得比較鬆散以便說明。當專案變複雜、API 變多時,這個模式依然能良好擴展:它避免了全域命名空間污染,提供對外的 API,同時支援受保護的「私有」資料與方法。即使今天已經不寫 YUI,這個思路也完整保留在 ES Module 與 IIFE 模組的設計裡。