在 JavaScript 裡定義兩個同名函式,後者會直接覆蓋前者。這個看似麻煩的特性,剛好可以用來實作模板方法模式。
模板方法模式的精神是:把一組固定的流程寫在父層,把會變動的細節留給子層覆寫。在 JavaScript 中,只要讓物件上的方法可以被外部重新指派,就等於有了「可覆寫的鉤子」。
這在後台管理系統特別有用。以我參與的專案為例,有許多「顯示資料庫記錄」的頁面,每頁都有相同的讀取、查詢、新增、刪除、修改流程,只是對應的後端 API 與查詢條件不同。
function ListCommon2() {
var urlAdd;
var urlAjax;
var tableid;
var titleText = "";
var winid = "#win";
var columns;
var toolbars;
var queryParams;
var colkey;
var toolbarsType
this.initList = function (aurlAdd, aurlAjax, atableid, atitleText, awinid, acolumns, atoolbarsType) {
urlAdd = aurlAdd;
urlAjax = aurlAjax;
if (atableid) { tableid = atableid; }
if (atitleText) { titleText = atitleText; }
if (atitleText) { winid = awinid; }
columns = acolumns;
toolbarsType = atoolbarsType;
};
this.initData = function () {
if (!toolbarsType) {
toolbars = [
{ text: '添加', iconCls: 'icon-add', handler: Add }, '-',
{ text: '編輯', iconCls: 'icon-edit', handler: this.Edit }, '-',
{ text: '刪除', iconCls: 'icon-cancel', handler: this.delMsg }
];
} else {
toolbars = toolbarsType;
}
queryParams = this.GetqueryParams();
$(tableid).datagrid({
url: urlAjax + '?OperationType=list',
columns: columns,
toolbar: toolbars,
idField: colkey,
pagination: true,
pageSize: 20,
sortName: colkey,
sortOrder: 'desc',
rownumbers: true,
fitColumns: true,
striped: true,
method: "post",
queryParams: this.GetqueryParams(),
showFooter: true,
pageList: [10, 20, 30, 40, 50]
});
$("#add").click(function (e) { Add(); });
$("#edit").bind('click', { obj: this }, function (event) { event.data.obj.Edit(); });
$("#del").bind('click', { obj: this }, function (event) { event.data.obj.delMsg(); });
$("#btnQuery").bind('click', { obj: this }, function (event) {
var queryParamsnew = event.data.obj.GetqueryParams();
$(tableid).datagrid('load', queryParamsnew)
});
};
this.GetqueryParams = function () {
var NameList = this.Getcolsinfo();
var otherQueryParams = this.GetOtherQueryParams();
if (!otherQueryParams) {
return { colkey: colkey, colsinfo: NameList }
} else {
return otherQueryParams;
}
};
// 這個方法預設什么都不做,留給各頁面覆寫
this.GetOtherQueryParams = function () {
return null;
};
this.Getcolsinfo = function () {
var fieldNameList = [];
if (columns.length > 0) {
for (var i = 0; i < columns[0].length; i++) {
fieldNameList.push(columns[0][i].field);
}
} else {
alert("未綁定數據");
}
colkey = fieldNameList[fieldNameList.length - 1];
return fieldNameList.join(",");
};
function Add() {
var _content = '<iframe id="FRMdetail" frameborder="0" src=' + urlAdd +
' style="width:100%;height:100%;"></iframe>';
$(winid).dialog({
width: 600, height: 400, modal: true, content: _content,
title: "增加" + titleText, draggable: true, resizable: true,
shadow: true, minimizable: false
});
}
this.Edit = function (editId) {
var id; var obj = typeof (editId);
if (!editId || obj == "object") {
var items = $(tableid).datagrid('getSelections');
var length = items.length;
if (length == 0) {
$.messager.alert('提示', '請選擇一條記錄然後編輯');
return;
} else if (length > 1) {
$.messager.alert('提示', '由於一次只能編輯一條記錄,所以只能修改第一條記錄');
return;
}
id = GetId(items[0]);
} else {
id = editId;
}
var _content = '<iframe id="FRMdetail" frameborder="0" src=' + urlAdd + '?Id=' + id +
' style="width:100%;height:100%;"></iframe>';
$(winid).dialog({
width: 600, height: 400, modal: true, content: _content,
title: "修改" + titleText, draggable: true, resizable: true,
shadow: true, minimizable: false
});
};
this.windowclose = function () { $(winid).window('close'); };
this.SaveOkCallback = function () {
this.windowclose();
$(tableid).datagrid('reload');
$(tableid).datagrid('unselectAll');
};
this.delMsg = function (delId) {
var length = 1;
var id;
var items; var obj = typeof (delId);
if (!delId || obj == "object") {
items = $(tableid).datagrid('getSelections');
length = items.length;
if (length == 0) {
$.messager.alert('提示', '請至少選擇一條記錄然後刪除');
return;
}
} else {
id = delId;
}
var text = '你確認刪除' + length + '條記錄嗎?';
if (length == 1) { text = '你確認刪除該條記錄嗎?'; }
$.messager.confirm('提示', text, function (r) {
if (r) {
if (!delId) {
var idList = [];
$.each(items, function (key, value) {
var id = GetId(value); // 視情況而定的主鍵欄位
idList.push(id);
});
id = idList.join(",");
}
del(id)
}
});
};
function del(id) {
$.ajax({
type: "post",
url: urlAjax + "?OperationType=del&id=" + id,
success: function (msg) {
var obj = jQuery.parseJSON(msg);
$.messager.alert('提示', obj.Msg);
if (obj.IsSuccess == true) { selectcallback(); }
}
});
}
function selectcallback() { SaveOkCallback(); }
}
仔細看會發現,這段程式碼幾乎涵蓋了查詢、修改、新增、刪除所有操作。唯一因頁而異的是查詢條件的參數,所以各頁面只要重寫 GetOtherQueryParams 就好:
$(document).ready(function () {
obj = new ListCommon2();
obj.initList(urlAdd, urlAjax, tableid, titleText, winid, columns, '#tb');
obj.GetOtherQueryParams = function () {
var colsinfo = obj.Getcolsinfo();
return {
colsinfo: colsinfo,
SWV_Performance_fk: $('#SWV_Performance_fk').combobox('getValue'),
S_NAME: $("#S_NAME").val(),
SQ_NAME: $("#SQ_NAME").val()
};
};
obj.initData();
})
當然也可以不覆寫方法,而是像 GetId(items[0]) 這樣先在共用程式裡呼叫、留到各頁面定義:
<script type="text/javascript">
function GetId(item) {
return item.SWV_ID
}
</script>
達到同樣效果的路徑有三條:覆寫物件方法、留全域函式給頁面定義、或者傳入 callback 函式。個人認為模板方法(第一種)最好,因為覆寫的意圖明確、作用域也收在物件內,不會污染全域,後續維護時要看某頁有什麼特殊邏輯,翻到該頁找覆寫的方法即可。
若用 ES6 重寫,這個模式會更自然:把 ListCommon2 寫成 class,各頁面用 extends 繼承並覆寫 getOtherQueryParams(),就能少了手動指派方法的步驟。