11個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. 活用位操作符

編程語言計算乘除的性能都不高,但是某些情況使用位操作符可以提升乘除等運算的性能。

11. 純函數

純函數是指不依賴於且不改變它作用域之外的變量狀態的函數。
純函數的返回值隻由它調用時的參數決定,它的執行不依賴於系統的狀態(執行上下文)。
相同的輸入參數,一定會得到相同的輸出,也就是內部不含有會影響輸出的隨機變量。

不屬於純函數的特點:

  • 更改文件系統
  • 往數據庫插入記錄
  • 發送一個 http 請求
  • 可變數據
  • 打印/log
  • 獲取用戶輸入
  • DOM 查詢
  • 訪問系統狀態

純函數的作用:

  • 可靠性:函數返回永遠和預期一致
  • 可緩存性:因為隻要輸入一樣輸出一定一樣,因此可將輸入作為key,輸出作為值,使用對象緩存已經計算的結果
  • 可移植性:因為沒有外部依賴,所以移植到任何環境都可正確運行
  • 可測試性:方便針對函數做單元測試
  • 可並行性:對一些復雜計算,可以並行計算(例如使用nodejs多個子進程同時並行計算多個任務,提高計算速度)

應用場景:

  • 工具函數最好使用純函數
  • 多平臺使用的代碼(nodejs、瀏覽器、微信小程序、native客戶端等)
  • 相對獨立的功能
var a = 1;
// 非純函數
function sum(b) {
 return a + b;
}
// 非純函數
function sum(b) {
 a = 2;
 return b;
}
// 非純函數
function sum(b) {
 return b + Math.random();
}


// 純函數
function sum (b, c) {
 return b + c;
}

參考

JavaScript設計模式與開發實踐

到此這篇關於11個Javascript小技巧幫你提升代碼質量(小結)的文章就介紹到這瞭,更多相關Javascript 提升代碼質量內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: