怎麼讓代碼再也不臃腫，寫的像詩同樣優雅

基本類型偏執

基本類型偏執(Primitive Obsession)

• 使用基本類型而不是小對象來實現簡單任務（例如貨幣、範圍、電話號碼字符串等）。
• 使用常量編碼信息（例如一個用於引用管理員權限的常量USER_ADMIN_ROLE = 1 ）。
• 使用字符串常量做爲字段名在數組中使用。

問題緣由

相似其餘大部分壞味道，基本類型偏執誕生於類初建的時候。一開始，可能只是很少的字段，隨着表示的特性愈來愈多，基本數據類型字段也愈來愈多。

基本類型經常被用於表示模型的類型。你有一組數字或字符串用來表示某個實體。

還有一個場景：在模擬場景，大量的字符串常量被用於數組的索引。

解決方法

大多數編程語言都支持基本數據類型和結構類型（類、結構體等）。結構類型容許程序員將基本數據類型組織起來，以表明某一事物的模型。

基本數據類型能夠當作是機構類型的積木塊。當基本數據類型數量成規模後，將它們有組織地結合起來，能夠更方便的管理這些數據。

• 若是你有大量的基本數據類型字段，就有可能將其中部分存在邏輯聯繫的字段組織起來，造成一個類。更進一步的是，將與這些數據有關聯的方法也一併移入類中。爲了實現這個目標，能夠嘗試 以類取代類型碼(Replace Type Code with Class) 。
• 若是基本數據類型字段的值是用於方法的參數，可使用 引入參數對象(Introduce Parameter Object) 或 保持對象完整(Preserve Whole Object) 。
• 若是想要替換的數據值是類型碼，而它並不影響行爲，則能夠運用 以類取代類型碼(Replace Type Code with Class) 將它替換掉。若是你有與類型碼相關的條件表達式，可運用 以子類取代類型碼(Replace Type Code with Subclass) 或 以狀態/策略模式取代類型碼(Replace Type Code with State/Strategy) 加以處理。
• 若是你發現本身正從數組中挑選數據，可運用 以對象取代數組(Replace Array with Object) 。

收益

• 多虧了使用對象替代基本數據類型，使得代碼變得更加靈活。
• 代碼變得更加易讀和更加有組織。特殊數據能夠集中進行操做，而不像以前那樣分散。不用再猜想這些陌生的常量的意義以及它們爲何在數組中。
• 更容易發現重複代碼。

重構方法說明

以類取代類型碼(Replace Type Code with Class)

問題

類之中有一個數值類型碼，但它並不影響類的行爲。

解決

以一個新的類替換該數值類型碼。

引入參數對象(Introduce Parameter Object)

問題

某些參數老是很天然地同時出現。

解決

以一個對象來取代這些參數。

保持對象完整(Preserve Whole Object)

問題

你從某個對象中取出若干值，將它們做爲某一次函數調用時的參數。

int low = daysTempRange.getLow();
int high = daysTempRange.getHigh();
boolean withinPlan = plan.withinRange(low, high);複製代碼

解決

改成傳遞整個對象。

boolean withinPlan = plan.withinRange(daysTempRange);複製代碼

以子類取代類型碼(Replace Type Code with Subclass)

問題

你有一個不可變的類型碼，它會影響類的行爲。

解決

以子類取代這個類型碼。

以狀態/策略模式取代類型碼(Replace Type Code with State/Strategy)

問題

你有一個類型碼，它會影響類的行爲，但你沒法經過繼承消除它。

解決

以狀態對象取代類型碼。

以對象取代數組(Replace Array with Object)

問題

你有一個數組，其中的元素各自表明不一樣的東西。

String[] row = new String[3];
row[0] = "Liverpool";
row[1] = "15";複製代碼

解決

以對象替換數組。對於數組中的每一個元素，以一個字段來表示。

Performance row = new Performance();
row.setName("Liverpool");
row.setWins("15");複製代碼

數據泥團

數據泥團(Data Clumps)

有時，代碼的不一樣部分包含相同的變量組（例如用於鏈接到數據庫的參數）。這些綁在一塊兒出現的數據應該擁有本身的對象。

問題緣由

一般，數據泥團的出現時由於糟糕的編程結構或「複製-粘貼式編程」。

有一個判斷是不是數據泥團的好辦法：刪掉衆多數據中的一項。這麼作，其餘數據有沒有於是失去意義？若是它們再也不有意義，這就是個明確的信號：你應該爲它們產生一個新的對象。

解決方法

• 首先找出這些數據以字段形式出現的地方，運用 提煉類(Extract Class) 將它們提煉到一個獨立對象中。
• 若是數據泥團在函數的參數列中出現，運用 引入參數對象(Introduce Parameter Object) 將它們組織成一個類。
• 若是數據泥團的部分數據出如今其餘函數中，考慮運用 保持對象完整(Preserve Whole Object) 將整個數據對象傳入到函數中。
• 檢視一下使用這些字段的代碼，也許，將它們移入一個數據類是個不錯的主意。

收益

• 提升代碼易讀性和組織性。對於特殊數據的操做，能夠集中進行處理，而不像之前那樣分散。
• 減小代碼量。

什麼時候忽略

• 有時爲了對象中的部分數據而將整個對象做爲參數傳遞給函數，可能會產生讓兩個類之間不收歡迎的依賴關係，這中狀況下能夠不傳遞整個對象。

重構方法說明

提煉類(Extract Class)

問題

某個類作了不止一件事。

解決

創建一個新類，將相關的字段和函數從舊類搬移到新類。

引入參數對象(Introduce Parameter Object)

問題

某些參數老是很天然地同時出現。

解決

以一個對象來取代這些參數。

保持對象完整(Preserve Whole Object)

問題

你從某個對象中取出若干值，將它們做爲某一次函數調用時的參數。

int low = daysTempRange.getLow();
int high = daysTempRange.getHigh();
boolean withinPlan = plan.withinRange(low, high);複製代碼

解決

改成傳遞整個對象。

boolean withinPlan = plan.withinRange(daysTempRange);複製代碼

過大的類

過大的類(Large Class)

一個類含有過多字段、函數、代碼行。

問題緣由

類一般一開始很小，可是隨着程序的增加而逐漸膨脹。

相似於過長函數，程序員一般以爲在一個現存類中添加新特性比建立一個新的類要容易。

解決方法

設計模式中有一條重要原則：職責單一原則。一個類應該只賦予它一個職責。若是它所承擔的職責太多，就該考慮爲它減減負。

• 若是過大類中的部分行爲能夠提煉到一個獨立的組件中，可使用 提煉類(Extract Class)。
• 若是過大類中的部分行爲能夠用不一樣方式實現或使用於特殊場景，可使用 提煉子類(Extract Subclass)。
• 若是有必要爲客戶端提供一組操做和行爲，可使用 提煉接口(Extract Interface)。
• 若是你的過大類是個 GUI 類，可能須要把數據和行爲移到一個獨立的領域對象去。你可能須要兩邊各保留一些重複數據，並保持兩邊同步。 複製被監視數據(Duplicate Observed Data) 能夠告訴你怎麼作。

收益

• 重構過大的類可使程序員沒必要記住一個類中大量的屬性。
• 在大多數狀況下，分割過大的類能夠避免代碼和功能的重複。

重構方法說明

提煉類(Extract Class)

問題

某個類作了不止一件事。

解決

創建一個新類，將相關的字段和函數從舊類搬移到新類。

提煉子類(Extract Subclass)

問題

一個類中有些特性僅用於特定場景。

解決

建立一個子類，並將用於特殊場景的特性置入其中。

提煉接口(Extract Interface)

問題

多個客戶端使用一個類部分相同的函數。另外一個場景是兩個類中的部分函數相同。

解決

移動相同的部分函數到接口中。

複製被監視數據(Duplicate Observed Data)

問題

若是存儲在類中的數據是負責 GUI 的。

解決

一個比較好的方法是將負責 GUI 的數據放入一個獨立的類，以確保 GUI 數據與域類之間的鏈接和同步。

過長函數

過長函數(Long Method)

一個函數含有太多行代碼。通常來講，任何函數超過 10 行時，你就能夠考慮是否是過長了。 函數中的代碼行數原則上不要超過 100 行。

問題的緣由

一般狀況下，建立一個新函數的難度要大於添加功能到一個已存在的函數。大部分人都以爲：「我就添加這麼兩行代碼，爲此新建一個函數實在是小題大作了。」因而，張三加兩行，李四加兩行，王五加兩行。。。函很多天益龐大，最終爛的像一鍋漿糊，再也沒人能徹底看懂了。因而你們就更不敢輕易動這個函數了，只能惡性循環的往其中添加代碼。因此，若是你看到一個超過 200 行的函數，一般都是多個程序員東拼西湊出來的。

解決函數

一個很好的技巧是：尋找註釋。添加註釋，通常有這麼幾個緣由：代碼邏輯較爲晦澀或複雜；這段代碼功能相對獨立；特殊處理。 若是代碼前方有一行註釋，就是在提醒你：能夠將這段代碼替換成一個函數，並且能夠在註釋的基礎上給這個函數命名。若是函數有一個描述恰當的名字，就不須要去看內部代碼到底是如何實現的。就算只有一行代碼，若是它須要以註釋來講明，那也值得將它提煉到獨立函數中。

• 爲了給一個函數瘦身，可使用 提煉函數(Extract Method)。
• 若是局部變量和參數干擾提煉函數，可使用 以查詢取代臨時變量(Replace Temp with Query)，引入參數對象(Introduce Parameter Object) 或 保持對象完整(Preserve Whole Object) 。
• 若是前面兩條沒有幫助，能夠經過 以函數對象取代函數(Replace Method with Method Object) 嘗試移動整個函數到一個獨立的對象中。
• 條件表達式和循環經常也是提煉的信號。對於條件表達式，可使用 分解條件表達式(Decompose Conditional) 。至於循環，應該使用 提煉函數(Extract Method) 將循環和其內的代碼提煉到獨立函數中。

收益

• 在全部類型的面向對象代碼中，函數比較短小精悍的類每每生命週期較長。一個函數越長，就越不容易理解和維護。
• 此外，過長函數中每每含有難以發現的重複代碼。

性能

是否像許多人說的那樣，增長函數的數量會影響性能？在幾乎絕大多數狀況下，這種影響是能夠忽略不計，因此不用擔憂。 此外，如今有了清晰和易讀的代碼，在須要的時候，你將更容易找到真正有效的函數來重組代碼和提升性能。

重構方法說明

提煉函數(Extract Method)

問題

你有一段代碼能夠組織在一塊兒。

void printOwing() {
  printBanner();

  //print details
  System.out.println("name: " + name);
  System.out.println("amount: " + getOutstanding());
}複製代碼

解決

移動這段代碼到一個新的函數中，使用函數的調用來替代老代碼。

void printOwing() {
  printBanner();
  printDetails(getOutstanding());
}

void printDetails(double outstanding) {
  System.out.println("name: " + name);
  System.out.println("amount: " + outstanding);
}複製代碼

以查詢取代臨時變量(Replace Temp with Query)

問題

將表達式的結果放在局部變量中，而後在代碼中使用。

double calculateTotal() {
  double basePrice = quantity * itemPrice;
  if (basePrice > 1000) {
    return basePrice * 0.95;
  }
  else {
    return basePrice * 0.98;
  }
}複製代碼

解決

將整個表達式移動到一個獨立的函數中並返回結果。使用查詢函數來替代使用變量。若是須要，能夠在其餘函數中合併新函數。

double calculateTotal() {
  double basePrice = quantity * itemPrice;
  if (basePrice > 1000) {
    return basePrice * 0.95;
  }
  else {
    return basePrice * 0.98;
  }
}複製代碼

引入參數對象(Introduce Parameter Object)

問題

某些參數老是很天然地同時出現。

解決

以一個對象來取代這些參數。

保持對象完整(Preserve Whole Object)

問題

你從某個對象中取出若干值，將它們做爲某一次函數調用時的參數。

int low = daysTempRange.getLow();
int high = daysTempRange.getHigh();
boolean withinPlan = plan.withinRange(low, high);複製代碼

解決

改成傳遞整個對象。

boolean withinPlan = plan.withinRange(daysTempRange);複製代碼

以函數對象取代函數(Replace Method with Method Object)

問題

你有一個過長函數，它的局部變量交織在一塊兒，以至於你沒法應用提煉函數(Extract Method) 。

class Order {
  //...
  public double price() {
    double primaryBasePrice;
    double secondaryBasePrice;
    double tertiaryBasePrice;
    // long computation.
    //...
  }
}複製代碼

解決

將函數移到一個獨立的類中，使得局部變量成了這個類的字段。而後，你能夠將函數分割成這個類中的多個函數。

class Order {
  //...
  public double price() {
    return new PriceCalculator(this).compute();
  }
}

class PriceCalculator {
  private double primaryBasePrice;
  private double secondaryBasePrice;
  private double tertiaryBasePrice;

  public PriceCalculator(Order order) {
    // copy relevant information from order object.
    //...
  }

  public double compute() {
    // long computation.
    //...
  }
}複製代碼

分解條件表達式(Decompose Conditional)

問題

你有複雜的條件表達式。

if (date.before(SUMMER_START) || date.after(SUMMER_END)) {
  charge = quantity * winterRate + winterServiceCharge;
}
else {
  charge = quantity * summerRate;
}複製代碼

解決

根據條件分支將整個條件表達式分解成幾個函數。

if (notSummer(date)) {
  charge = winterCharge(quantity);
}
else {
  charge = summerCharge(quantity);
}複製代碼

過長參數列

過長參數列(Long Parameter List)

一個函數有超過 三、4 個入參。

問題緣由

過長參數列多是將多個算法併到一個函數中時發生的。函數中的入參能夠用來控制最終選用哪一個算法去執行。

過長參數列也多是解耦類之間依賴關係時的副產品。例如，用於建立函數中所需的特定對象的代碼已從函數移動到調用函數的代碼處，但建立的對象是做爲參數傳遞到函數中。所以，原始類再也不知道對象之間的關係，而且依賴性也已經減小。可是若是建立的這些對象，每個都將須要它本身的參數，這意味着過長參數列。

太長的參數列難以理解，太多參數會形成先後不一致、不易使用，並且一旦須要更多數據，就不得不修改它。

解決方案

• 若是向已有的對象發出一條請求就能夠取代一個參數，那麼你應該使用 以函數取代參數(Replace Parameter with Methods) 。在這裏，，「已有的對象」多是函數所屬類裏的一個字段，也多是另外一個參數。
• 你還能夠運用 保持對象完整(Preserve Whole Object) 未來自同一對象的一堆數據收集起來，並以該對象替換它們。
• 若是某些數據缺少合理的對象歸屬，可以使用 引入參數對象(Introduce Parameter Object) 爲它們製造出一個「參數對象」。

收益

• 更易讀，更簡短的代碼。
• 重構可能會暴露出以前未注意到的重複代碼。

什麼時候忽略

• 這裏有一個重要的例外：有時候你明顯不想形成"被調用對象"與"較大對象"間的某種依賴關係。這時候將數據從對象中拆解出來單獨做爲參數，也很合情理。可是請注意其所引起的代價。若是參數列太長或變化太頻繁，就須要從新考慮本身的依賴結構了。

重構方法說明

以函數取代參數(Replace Parameter with Methods)

問題

對象調用某個函數，並將所得結果做爲參數，傳遞給另外一個函數。而接受該參數的函數自己也可以調用前一個函數。

int basePrice = quantity * itemPrice;
double seasonDiscount = this.getSeasonalDiscount();
double fees = this.getFees();
double finalPrice = discountedPrice(basePrice, seasonDiscount, fees);複製代碼

解決

讓參數接受者去除該項參數，並直接調用前一個函數。

int basePrice = quantity * itemPrice;
double finalPrice = discountedPrice(basePrice);複製代碼

保持對象完整(Preserve Whole Object)

問題

你從某個對象中取出若干值，將它們做爲某一次函數調用時的參數。

int low = daysTempRange.getLow();
int high = daysTempRange.getHigh();
boolean withinPlan = plan.withinRange(low, high);複製代碼

解決

改成傳遞整個對象。

boolean withinPlan = plan.withinRange(daysTempRange);複製代碼

引入參數對象(Introduce Parameter Object)

問題

某些參數老是很天然地同時出現。

解決

以一個對象來取代這些參數。