DRY原則的一個簡單實踐

葡萄城技術團隊發表於2020-06-12

轉載請註明出處：葡萄城官網，葡萄城為開發者提供專業的開發工具、解決方案和服務，賦能開發者。

原文出處：https://dzone.com/articles/dry-dont-repeat-yourself

 

我們之前就發過一篇相關的文章：https://www.cnblogs.com/powertoolsteam/p/12758496.html 其中也提到了包括DRY在內的一些軟體開發的原則。

DRY 是軟體開發的原則之一，其目的主要是為了避免程式碼重複，指導開發者儘量以抽象的思維去解決重複，基本上是，當您發現自己一遍又一遍地編寫相同的程式碼時，可能會有更好的方法。 

實際案例

讓我們先看一個例子，看看這個例子是否可以改進，以及如何通過重構來避免程式碼重複。

這裡有一個簡單的Report類，該類接收一些資料並通過控制檯以格式化的方式直接輸出。

我們這裡使用php的一個程式碼片段來舉例，相信大家對程式碼的結構和想要完成的工作都不難理解，所以為了大家更容易理解，我只對一些下面用到的php函式定義做一個解釋：

  1. echo()  函式輸出一個或多個字串
  2. ucwords()函式把字串中每個單詞的首字元轉換為大寫。
  3. strtolower() 函式把字串轉換為小寫。
  4. file_put_contents() 函式把一個字串寫入檔案中。
  5. floor() 函式向下舍入為最接近的整數。
class Report
{
   public function show(array $data)
   {
       echo "Report: " . ucwords(strtolower($data["name"])) . "\n";
       echo "Product: " . ucwords(strtolower($data["product"])) . "\n";
       echo "Start date: " . date("Y/m/d", $data["startDate"]) . "\n";
       echo "End date: " . date("Y/m/d", $data["endDate"]) . "\n";
       echo "Total: " . $data["total"] . "\n";
       echo "Average x day: " . floor($data["total"] / 365) . "\n";
       echo "Average x week: " . floor($data["total"] / 52) . "\n";
   }
}

可以看到，上面的程式碼完成目標是沒有任何問題的。

這時我們對Report類提出一個新的需求：把所有字串也可以儲存到檔案中。

我們經過一通複製和貼上上面的程式碼，新建一個名為saveToFile的函式，就可以很快的完成這個需求，程式碼如下：

class Report
{
   public function show(array $data)
   {
       echo "Report: " . ucwords(strtolower($data["name"])) . "\n";
       echo "Product: " . ucwords(strtolower($data["product"])) . "\n";
       echo "Start date: " . date("Y/m/d", $data["startDate"]) . "\n";
       echo "End date: " . date("Y/m/d", $data["endDate"]) . "\n";
       echo "Total: " . $data["total"] . "\n";
       echo "Average x day: " . floor($data["total"] / 365) . "\n";
       echo "Average x week: " . floor($data["total"] / 52) . "\n";
       echo "Average x month: " . floor($data["total"] / 12) . "\n";
   }
   public function saveToFile(array $data)
   {
       $report = '';
       $report .= "Report: " . ucwords(strtolower($data["name"])) . "\n";
       $report .= "Product: " . ucwords(strtolower($data["product"])) . "\n";
       $report .= "Start date: " . date("Y/m/d", $data["startDate"]) . "\n";
       $report .= "End date: " . date("Y/m/d", $data["endDate"]) . "\n";
       $report .= "Total: " . $data["total"] . "\n";
       $report .= "Average x day: " . floor($data["total"] / 365) . "\n";
       $report .= "Average x week: " . floor($data["total"] / 52) . "\n";
       $report .= "Average x month: " . floor($data["total"] / 12) . "\n";
       file_put_contents("./report.txt", $report);
   }
}

那麼，上面的程式碼能夠滿足我們提出的需求嗎？答案當然“是的”。但是從技術角度來看，這段程式碼似乎是有些問題的，它的重複程式碼到處都是。無論是對程式碼閱讀及後期維護來講，這都是一場噩夢。

所以我們需要進行一些重構，抽象能抽象的方法，讓冗繁的程式碼變得更簡潔。

首先，我們對Report類進行功能上的抽象，生成報告並輸出一共可以分為兩個功能，一個只負責建立Report，一個只負責如何處理Report，那麼讓我們開始重構吧。　　

class Report
{
   public function show(array $data)
   {
       echo $this->createReport($data);
   }
   public function saveToFile(array $data)
   {
       file_put_contents("./report.txt", $this->createReport($data));
   }
   private function createReport(array $data): string
   {
       $report = '';
       $report .= "Report: " . ucwords(strtolower($data["name"])) . "\n";
       $report .= "Product: " . ucwords(strtolower($data["product"])) . "\n";
       $report .= "Start date: " . date("Y/m/d", $data["startDate"]) . "\n";
       $report .= "End date: " . date("Y/m/d", $data["endDate"]) . "\n";
       $report .= "Total: " . $data["total"] . "\n";
       $report .= "Average x day: " . floor($data["total"] / 365) . "\n";
       $report .= "Average x week: " . floor($data["total"] / 52) . "\n";
       $report .= "Average x month: " . floor($data["total"] / 12) . "\n";
       return $report;
   }
}

現在看起來更清楚一些，對嗎？

下面我們還有函式使用重複的問題要解決，例如，Report和Products的名稱函式使用重複：

$report .= "Report: " . ucwords(strtolower($data["name"])) . "\n";
$report .= "Product: " . ucwords(strtolower($data["product"])) . "\n";

我們可以將這些轉換抽象為一個新的函式：

private function normalizeName($name): string
{
   return ucwords(strtolower($name));
}

另一個重複：日期格式。

$report .= "Start date: " . date("Y/m/d", $data["startDate"]) . "\n";
$report .= "End date: " . date("Y/m/d", $data["endDate"]) . "\n";

讓我們將其抽象為：

private function formatDate($date): string
{
   return date("Y/m/d", $date);
}

最後一個：平均值計算。

$report .= "Average x day: " . floor($data["total"] / 365) . "\n";
$report .= "Average x week: " . floor($data["total"] / 52) . "\n";
$report .= "Average x month: " . floor($data["total"] / 12) . "\n";

儘管計算結果並不完全相同，但執行的操作大家是一致的，所以可以抽象為如下：

private function calculateAverage(array $data, $period): string
{
   return floor($data["total"] / $period);
}

所以，經過了一番重構，最終的Report類變為了如下：

class Report
{
   public function show(array $data)
   {
       echo $this->createReport($data);
   }
   public function saveToFile(array $data)
   {
       file_put_contents("./report.txt", $this->createReport($data));
   }
   private function createReport(array $data)
   {
       $report = '';
       $report .= "Report: " . $this->normalizeName($data["name"]) . "\n";
       $report .= "Product: " . $this->normalizeName($data["product"]) . "\n";
       $report .= "Start date: " . $this->formatDate($data["startDate"]) . "\n";
       $report .= "End date: " . $this->formatDate($data["endDate"]) . "\n";
       $report .= "Total: " . $data["total"] . "\n";
      $report .= "Average x day: " . $this->calculateAverage($data, 365) . "\n";
      $report .= "Average x week: " . $this->calculateAverage($data, 52) . "\n";
      $report .= "Average x month: " . $this->calculateAverage($data, 12) . "\n";
      return $report;
  }
  private function formatDate($date): string
  {
       return date("Y/m/d", $date);
   }
  private function calculateAverage(array $data, $period): string
  {
      return floor($data["total"] / $period);
  }
  private function normalizeName($name): string
  {
      return ucwords(strtolower($name));
  }
}

這是一個簡單的例子，實際情況可能比這要更加複雜的多，但我僅想通過這個例項向大家說明一個問題，那就是避免重複程式碼的重要性及我們如何通過重構去處理重複程式碼。

有時候重複一次相同的程式碼可能沒問題，但是當第三次​​我們寫出相同的程式碼時，那就說明是時候重構你的程式碼了。

結論：

請記住DRY原則，並隨時抱著不要重複自己程式碼的想法去完成開發工作。

 

相關文章