javascript專欄介紹小技巧來提昇文章程式碼品質
推薦(免費) :javascript(影片)
簡介
主要介紹以下幾點:
提煉函數
合併重複的條件片段
#把條件分支語句提煉成函數
合理使用循環
提前讓函數退出代替巢狀條件分支
傳遞物件參數來取代過長的參數清單
少用三目運算子
合理地使用鍊式呼叫
分解大型類別
本文會不斷更新,不足之處歡迎留言區補充。
1. 提煉函數
#好處:
#避免超大函數。
獨立出來的函數有助於程式碼重複使用。
獨立出來的函數更容易被覆寫。
獨立出來的函數如果擁有一個好的命名,它本身就起到了註解的作用。
語意化將多段分離的邏輯放在不同的函數中實現,可以使程式碼邏輯清晰,清楚的看到每一步在做什麼。
程式碼範例:
實作取得數據,然後操作dom顯示數據,最後新增事件
函數提煉前
// 逻辑都写在一起,需要将所有逻辑看完才知道这段代码是干嘛的,局部逻辑无法复用 function main() { $.ajax.get('/getData').then((res) => { const ul = document.getElementById('ul'); ul.innerHTML = res.list.map(text => `<li class="li">${text}</li>`).join('\n'); const list = document.getElementsByClassName('li'); for (let i = 0; i < list.length; i ++) { list[i].addEventListener('focus', () => { // do something }); } }); }
函數提煉後
function getData() { return $.ajax.get('/getData').then((res) => res.data.list); } function showList(list) { const ul = document.getElementById('ul'); ul.innerHTML = list.map(text => `<li class="li">${text}</li>`).join('\n'); } function addEvent() { const list = document.getElementsByClassName('li'); for (let i = 0; i < list.length; i ++) { list[i].addEventListener('focus', () => { // do something }); } } // 逻辑清晰,一眼读懂每一步在做什么,某些提炼出来的函数还可以被复用 async function main() { const list = await getData(); // 获取数据 showList(list); // 显示页面 addEvent(); // 添加事件 }
2. 合併重複的條件片段
如果一個函數體內有一些條件分支語句,而這些條件分支語句內部散佈了一些重複的程式碼,那麼就有必要進行合併去重工作。
// 合并前 function main( currPage ){ if ( currPage <= 0 ){ currPage = 0; jump( currPage ); // 跳转 }else if ( currPage >= totalPage ){ currPage = totalPage; jump( currPage ); // 跳转 }else{ jump( currPage ); // 跳转 } }; // 合并后 function main( currPage ){ if ( currPage <= 0 ){ currPage = 0; }else if ( currPage >= totalPage ){ currPage = totalPage; } jump( currPage ); // 把jump 函数独立出来 };
3. 把條件分支語句提煉成函數
#複雜的條件分支語句是導致程式難以閱讀和理解的重要原因,而且容易導致一個龐大的函數。有時可以將條件分支語句提煉成語意化的函數,使程式碼更直觀,邏輯清晰。
// 根据不同季节决定打折力度 function getPrice( price ){ var date = new Date(); if ( date.getMonth() >= 6 && date.getMonth() <= 9 ){ // 夏天 return price * 0.8; } return price; }; // 是否是夏天 function isSummer(){ var date = new Date(); return date.getMonth() >= 6 && date.getMonth() <= 9; }; // 提炼条件后 function getPrice( price ){ if ( isSummer() ){ return price * 0.8; } return price; };
4. 合理使用循環
如果多段程式碼實際上負責的是一些重複性的工作,那麼可以用循環代替,使程式碼量更少。
// 判断是什么浏览器 function getBrowser(){ const str = navigator.userAgent; if (str.includes('QQBrowser')) { return 'qq'; } else if (str.includes('Chrome')) { return 'chrome'; } else if (str.includes('Safari')) { return 'safri'; } else if (str.includes('Firefox')) { return 'firefox'; } else if(explorer.indexOf('Opera') >= 0){ return 'opera'; } else if (str.includes('msie')) { return 'ie'; } else { return 'other'; } }; // 循环判断,将对应关系抽象为配置,更加清晰明确 function getBrowser(){ const str = navigator.userAgent; const list = [ {key: 'QQBrowser', browser: 'qq'}, {key: 'Chrome', browser: 'chrome'}, {key: 'Safari', browser: 'safari'}, {key: 'Firefox', browser: 'firefox'}, {key: 'Opera', browser: 'opera'}, {key: 'msie', browser: 'ie'}, ]; for (let i = 0; i < list.length; i++) { const item = list[i]; if (str.includes(item.key)) {return item.browser}; } return 'other'; }
5. 提前讓函數退出代替巢狀條件分支
#讓函數變成多出口提前返回,取代巢狀條件分支。
function del( obj ){ var ret; if ( !obj.isReadOnly ){ // 不为只读的才能被删除 if ( obj.isFolder ){ // 如果是文件夹 ret = deleteFolder( obj ); }else if ( obj.isFile ){ // 如果是文件 ret = deleteFile( obj ); } } return ret; }; function del( obj ){ if ( obj.isReadOnly ){ // 反转if 表达式 return; } if ( obj.isFolder ){ return deleteFolder( obj ); } if ( obj.isFile ){ return deleteFile( obj ); } };
6. 傳遞物件參數代替過長的參數列表
函數參數過長那麼就增加出錯的風險,想保證傳遞的順序正確就是一件麻煩的事,程式碼可讀性也會變差,盡量確保函數的參數不會太長。如果必須傳遞多個參數的話,建議使用物件代替。
一般來說,函數參數最好不要超過3個
function setUserInfo( id, name, address, sex, mobile, qq ){ console.log( 'id= ' + id ); console.log( 'name= ' +name ); console.log( 'address= ' + address ); console.log( 'sex= ' + sex ); console.log( 'mobile= ' + mobile ); console.log( 'qq= ' + qq ); }; setUserInfo( 1314, 'sven', 'shenzhen', 'male', '137********', 377876679 ); function setUserInfo( obj ){ console.log( 'id= ' + obj.id ); console.log( 'name= ' + obj.name ); console.log( 'address= ' + obj.address ); console.log( 'sex= ' + obj.sex ); console.log( 'mobile= ' + obj.mobile ); console.log( 'qq= ' + obj.qq ); }; setUserInfo({ id: 1314, name: 'sven', address: 'shenzhen', sex: 'male', mobile: '137********', qq: 377876679 });
7. 少用三目運算子
三目運算子效能高,代碼量少。
但不應該濫用三目運算符,我們應該在簡單邏輯分支使用,在複雜邏輯分支中避免使用。
// 简单逻辑可以使用三目运算符 var global = typeof window !== "undefined" ? window : this; // 复杂逻辑不适合使用 var ok = isString ? (isTooLang ? 2 : (isTooShort ? 1 : 0)) : -1;
8. 合理使用鍊式呼叫
優點:
鍊式呼叫使用簡單,程式碼量少。
缺點:
鍊式呼叫帶來的壞處就是在偵錯不方便,如果我們知道一條鏈中有錯誤出現,必須先把這條鏈拆開才能加上一些偵錯log 或增加斷點,這樣才能定位錯誤出現的地方。
如果該鏈條的結構相對穩定,則後期不易發生修改,可以使用鍊式。
var User = { id: null, name: null, setId: function( id ){ this.id = id; return this; }, setName: function( name ){ this.name = name; return this; } }; User .setId( 1314 ) .setName( 'sven' ); var user = new User(); user.setId( 1314 ); user.setName( 'sven' );
9. 分解大型類別
大型類別的分解和函數的提煉很像,類別太大會出現邏輯不清晰,難以理解和維護的問題。
合理的大類別分解可以使類別的邏輯清晰,且子模組可以方便多用。
10. 活用位元運算子
程式語言計算乘除的效能都不高,但是某些情況使用位元運算子可以提升乘除等運算的效能。
// 按位右移 var n = parseInt(3 / 2); // 原始 var n = 3 >> 1; // 按位右移
以上是掌握javascript 小技巧幫你提升程式碼品質的詳細內容。更多資訊請關注PHP中文網其他相關文章!