答應我,別再寫上千行的類了好嗎

答應我,別再寫上千行的類了好嗎?

最近在對已有項目進行擴展的時候,發現要改動的一個類長766行,開放了近40個public接口,我流着淚把它給改完了。爲了防止這樣的慘劇再次發生在個人身上,我以爲有必要寫一篇博客來讓廣大程序猿同胞知道代碼重構的重要性運維

若是你身邊有一個類寫上千行的猿,必定要把此文轉給ta函數

爲何類不能過長?

類過長——讀不通,擴展不通

  • 讀不通——直接用滾輪滾都得好幾秒,就算是原做者,時間長了恐怕也難以理清整個類,更不用說是其餘的讀者
  • 擴展不通——一個類有過多的接口,會讓擴展這個類變得異常困難,一動千行

類過長——可能有冗餘代碼

此時CV工程師打了個冷戰測試

冗餘代碼,就是重複代碼,一般出自使用Ctrl+C,Ctrl+V來生產代碼的CV工程師之手,冗餘代碼的危害很是大:設計

  1. 冗餘代碼使方法、類過長,不簡潔
  2. 冗餘代碼會形成發散式修改(冗餘代碼須要變更時,每一處Ctrl+V都須要修改)

類過長——多半是職責過多

一個類開放幾十個接口,絕對存在職責過多的問題,就像圖中的Tom貓同樣手忙腳亂,一個類的職責過多也有巨大問題:cdn

  1. 違反設計原則——單一職責原則(單一職責原則要求一個類只實現一個職責,好比一隻Tom只作掃地、擦桌、拖地中的一件事,而其餘事的實現能夠轉移給史派克狗或肥胖女傭),違反了這個原則會致使發散式變化、發散式修改、類過長等代碼問題,還會讓你的類難以擴展,甚至會讓其餘程序猿認爲你不專業對象

  2. 發散式變化(指引起此類修改的地方不少),若是一個類的職責不少,那它的扇入(調用者)必定不少,每一個調用者的修改都有可能讓你這個類不得不隨之修改,也就是發散式變化blog

    就是說無論哪兒出了問題,你這個類都得遭殃接口

  3. 發散式修改(指此類修改引起修改的地方不少),相同的,若是一個類職責不少,那支撐它實現的下級,即扇出(被調用方)必定不少,若是此類邏輯發生變更,全部下級被調用者可能都得隨之修改,也就是發散式修改get

    就是說你這個類出了問題,無論哪兒都會遭殃博客

  4. 難以擴展:若是你的一個類接口很是多,那它的子類怎麼辦?它的包裝類怎麼辦?難道所有都要實現這麼多接口,所有都要承擔一樣多的職責嗎?擴展起來真的很是麻煩

  5. 觸發機關:【測試之怒】【運維之怒】

我已經寫了幾千行了,怎麼辦?

重構——抽取冗餘代碼

抽取冗餘代碼就是將重複代碼抽取成一個獨立的方法,以後再使用這段代碼時就再也不須要Ctrl + C,Ctrl + V,而是直接調用對應的方法便可

這樣作也能夠縮短原方法,使原方法更加簡潔易懂

更值得一提的是若是這段代碼須要修改,也只需修改一處,而不是發散式地處處修改

真是一箭三雕

使用IDEA進行冗餘代碼的抽取

  1. 找到重複代碼

  2. 進行方法抽取 右鍵->選擇重構->抽取->方法 (或者直接使用快捷鍵Ctrl + Alt + m)

    自動檢測出個別重複代碼的細微差異,有些代碼可能只改動一兩個變量,IDEA會自動檢測出來,並在抽取方法時提醒咱們,選擇左側Accept Signature Change(接受簽名變更)可使抽取的方法自動替換更多的重複點

    能夠選擇替換掉全部的重複代碼(居然有18處)

  3. 重構——更改方法簽名

    若是你對抽取出的方法的名字、參數、返回值或是修飾符不滿意,不要使用Ctrl + R 修改,IDEA提供了重構方法——更改簽名(快捷鍵Ctrl + F6)

    注意:方法的名字指的是方法作了什麼,而非怎麼去作,最好是 動詞+名詞 格式

    好比:Tom.掃地() √

    ​ Tom.掃地With掃把() ×

    ​ Tom.用掃把掃地() ×

重構——轉移成員變量+函數(轉移職責)

將不該該由本身管理的成員變量和函數轉移出去

那就要考慮兩個問題:該轉移誰?轉移給誰?

來看一個圖

  1. 圖中成員【偏A】被類【A】調用兩次,而只被它所在的類【過長類】調用1次,於是應該轉移給【A】去管理
  2. 因爲函數【偏A】與成員【偏A】的親密度較高(只調用了【偏A】),於是應與【偏A】共進退,同去留,轉移給【A】
  3. 成員【偏B】和函數【偏B】也是相同道理
  4. 職責1(函數【1】和成員【偏職責1】)和職責2(函數【2】和成員【偏職責2】)因爲找不到可轉移的合適的類,因此應抽取出一個新的類

注意,先決定移動哪一個成員變量,而後再決定移動哪一個函數

使用IDEA轉移成員變量和函數

  1. 移動成員變量,鼠標選擇成員變量->右鍵->Refactor->Move,而後選擇轉移至哪一個類

  2. 移動函數(與移動成員變量步驟相同)

重構——抽取類

當你發現要轉移的成員變量和函數找不到合適的類時(轉移職責卻找不到下家),要想起來,這裏是程序世界,而咱們程序猿就是類和對象的造物主,是時候建立一個新的類,讓它來替咱們分擔職責(成員變量和函數)了

使用IDEA抽取類

  1. 重構 選中要搬的成員變量和函數,右鍵->Refactor->Extract->Delegate(抽取一個委託者,委託他來管理這部分變量和函數,若是隻有變量或只有函數,能夠抽出參數對象Paramater Object或方法對象Method Object)

    不推薦抽取參數對象,由於通常參數對象是給參數多的方法用的(用參數對象取代一長溜的參數),並且若是成員變量抽取了也不會影響任何函數的話,那就是無用對象了,不如直接把他們刪除掉

  2. 爲新類起個名,選個包吧

  3. 注意,抽取的函數和成員必定要符合一個原則,那就是被抽取函數使用被抽取成員的次數必定高於剩餘函數的次數,否則違反親密性原則(成員應歸於調用它最多的類,沒有理由你用的比我多還讓我來管理)

  4. 一些小問題

    因爲抽取的函數直接使用了未抽取的對象而致使重構失敗,涉及到另外一個重構(使用get方法而非直接使用私有成員變量),使用此重構便可解決

技術不分領域,思想一脈相承,歡迎訪問橙味菌的博客 本文由博客一文多發平臺 OpenWrite 發佈!

相關文章
相關標籤/搜索