編碼風格側重「怎麼寫得整齊」,設計模式側重「怎麼組織架構」。本文整理的是介於兩者之間的一些常用手法——不影響架構,卻能明顯提升可讀性與正確性。
// 一般寫法
var a = 0;
var b = 1;
var c = 'xxx';
// 推薦寫法
var a = 0,
b = 1,
c = 'xxx';
// 一般寫法
var obj = new Object();
obj.a = 'aa';
obj.b = 'bb';
var arr = new Array();
// 推薦寫法
var obj = {
a: 'aa',
b: 'bb'
};
var arr = [];
// 字面量還能直接寫成查表結構
function getXX(index) {
return ['aa', 'bb', 'xx', 55, 'xxb'][index];
}
function getMessage(code) {
return {
404: 'xxx',
500: 'xxx'
}[code];
}
var regex = new RegExp('something');
// 只有在規則需要動態組裝時才用建構函式
var cls = 'someclass',
regex = new RegExp(cls + '\\s*', 'ig');
// 其他情況一律用字面量
var regex2 = /something/ig;
var arg = arg || 'default';
document.getElementById('test').onclick = function (event) {
var event = event || window.event;
};
要注意 || 的副作用:0、空字串、false 都會被視為「需要 fallback」。若這些是合法值,請改用明確的 undefined 檢查,或 ES6 的空值指派 ??。
// 用 && 串接,避免逐層嵌套
answer = obj && obj.xx && obj.xx.xxx;
// 連續判斷
if (obj && obj.xx && obj.xx.xxx) {
// do something
}
// 使用全等
if (a === b) {
// do something
}
// 做特性偵測,而非瀏覽器偵測
if (document.getElementById) {
// 能力存在
}
ES6 之後可用可選鏈 obj?.xx?.xxx 取代長串 && 判斷,語意更清楚。
check ? value1 : value2;
// 直接寫成 return 更簡潔
function xx() {
return (condition) ? value1 : value2;
}
// 多層條件時的排版
foo = predicate ? "one"
: predicate ? "two"
: "default";
var name = value[i]; i++; // 等價寫法 var name = value[i++];
// 先離線修改,再一次性掛回文件
el.style.display = 'none';
// ...操作
el.style.display = 'block';
// 大量新增節點時用文件片段
var fragment = document.createDocumentFragment();
// 清空子節點
el.innerHTML = '';
// 小心 NodeList 是即時的
var images = document.getElementsByTagName('img');
把監聽器掛在更外層的容器上,用事件冒泡處理內部元素的互動,能大幅減少監聽器數量:
document.getElementById('list').onclick = function (evt) {
var evt = evt || window.event,
target = evt.target || evt.srcElement;
if (target.id === 'btn1') {
// do something
}
};
var MYAPP = {};
MYAPP.dom.get = function (id) {};
MYAPP.style.css = function (el, style) {};
讓方法回傳 this,就能串起來寫:
function setValue(el, value) {
el.value = value;
return this;
}
var obj = new MYAPP.dom.Element('span');
obj.setText('hello')
.setStyle('color', 'red')
.setStyle('font', 'Verdana');
(function () {
var _private = 'cant see me';
})();
// 也可傳入外部依賴,兼作別名
(function ($) {
$('#xxb').click(function () {});
})(jQuery);
function foo(id, conf) {
// do something
}
foo('bar', {
key1: 1,
key2: 2
});
+'010' === 10;
Number('010') === 10;
parseInt('010', 10) === 10;
10 + '' === '10';
+new Date(); // 取得時間戳
// 僅在需要向下相容舊環境時才這麼做
Array.prototype.forEach = function () {};
修改內建原型會影響整個頁面的所有程式碼,也容易與其他函式庫衝突。能用工具函式解決的,就不要動原型。
// 把長度計算提到外面,避免每次條件判斷都重新求值
for (var i = 0, j = document.getElementsByTagName('a').length; i < j; i++) {
}
// 倒著走,邊界條件更省
for (var i = arr.length; i > 0; i--) {
}
// 多數情況下最快
while (i--) {
}
Array.prototype.forEach();
document.getElementsByClassName();
document.querySelectorAll();
if (document.getElementsByClassName) {
// 用原生實作
} else {
// 自己的 fallback
}
只判斷一次,之後直接把函式本身替換掉:
function lazyDef() {
if (condition1) {
lazyDef = function () {};
} else if (condition2) {
lazyDef = function () {};
}
return lazyDef();
}
var MYAPP = {};
MYAPP.dom = (function () {
var _setStyle = function (el, prop, value) {
console.log('setStyle');
};
return {
setStyle: _setStyle
};
})();
// 即使外部覆寫了 MYAPP.dom.setStyle,內部的 _setStyle 仍可用
console.log('xx', 'xx'); // 可傳多個參數,輸出以空格串接
console.dir(someObj); // 展開物件結構
console.dirxml(someDom); // 檢視 DOM 節點
console.time('timer'); // 搭配 console.timeEnd 計時
console.warn('xxx');
也可以包一層,避免正式環境殘留:
function msg(text) {
if (window.console && console.log) {
console.log(text);
}
}
這些技巧單看都不複雜,但一致性才是關鍵。整份程式碼若都遵循同一套慣例,閱讀成本會低非常多。