本文實(shí)例分析了PHP代碼重構(gòu)方法。分享給大家供大家參考，具體如下：

隨著 PHP 從一種簡(jiǎn)單的腳本語(yǔ)言轉(zhuǎn)變?yōu)橐环N成熟的編程語(yǔ)言，一個(gè)典型的 PHP 應(yīng)用程序的代碼庫(kù)的復(fù)雜性也隨之增大。為了控制對(duì)這些應(yīng)用程序的支持和維護(hù)，我們可以使用各種測(cè)試工具來(lái)自動(dòng)化該流程。其中一種是單元測(cè)試，它允許您直接測(cè)試所編寫(xiě)代碼的正確性。然而，通常遺留代碼庫(kù)是不適合進(jìn)行這種測(cè)試的。本文將介紹對(duì)包含常見(jiàn)問(wèn)題的 PHP 代碼的重構(gòu)策略，以便簡(jiǎn)化使用流行的單元測(cè)試工具進(jìn)行測(cè)試的過(guò)程，同時(shí)減少改進(jìn)代碼庫(kù)的依賴性。

簡(jiǎn)介

回顧 PHP 的發(fā)展歷程，我們發(fā)現(xiàn)它已經(jīng)從一個(gè)簡(jiǎn)單的用來(lái)替代當(dāng)時(shí)流行的 CGI 腳本的動(dòng)態(tài)腳本語(yǔ)言變成一種成熟的現(xiàn)代編程語(yǔ)言。 隨著代碼庫(kù)的增長(zhǎng)，手動(dòng)測(cè)試已經(jīng)變成不可能完成的任務(wù)，無(wú)論是大是小，所有代碼的變化都會(huì)對(duì)整個(gè)應(yīng)用程序產(chǎn)生影響。這些影響可能小到只是影響某個(gè)頁(yè)面的加 載或表單保存，也可能是產(chǎn)生難以檢測(cè)的問(wèn)題，或者產(chǎn)生只在特定條件下才會(huì)出現(xiàn)的錯(cuò)誤。甚至，它可能會(huì)使以前修復(fù)的問(wèn)題重新出現(xiàn)在應(yīng)用程序中。為此開(kāi)發(fā)了許 多測(cè)試工具來(lái)解決這些問(wèn)題。

其中一種流行的方法是所謂的功能或驗(yàn)收測(cè)試，它會(huì)通過(guò)應(yīng)用程序的典型用戶交互來(lái)測(cè)試這個(gè)應(yīng)用程序。這是一種 很適合測(cè)試應(yīng)用程序中各個(gè)進(jìn)程的方法，但是測(cè)試過(guò)程可能非常慢，而且一般無(wú)法測(cè)試底層的類和方法是否按要求正常工作。這時(shí)，我們需要使用另一種測(cè)試方法， 那就是單元測(cè)試。單元測(cè)試的目標(biāo)是測(cè)試應(yīng)用程序底層代碼的功能，保證它們執(zhí)行后產(chǎn)生正確的結(jié)果。通常，這些 “不斷增大” 的 Web 應(yīng)用程序會(huì)慢慢出現(xiàn)越來(lái)越多久而久之難以測(cè)試的遺留代碼，這使開(kāi)發(fā)團(tuán)隊(duì)很難保證應(yīng)用程序測(cè)試的覆蓋率。這通常被稱為 “不可測(cè)試代碼”?，F(xiàn)在讓我們看看如何識(shí)別應(yīng)用程序中的不可測(cè)試代碼，以及修復(fù)這些代碼的方法。

識(shí)別不可測(cè)試的代碼

關(guān)于代碼庫(kù)不可測(cè)試性的問(wèn)題域通常在編寫(xiě)代碼時(shí)是不明顯的。當(dāng)編寫(xiě) PHP 應(yīng)用程序代碼時(shí)，人們傾向于按照 Web 請(qǐng)求的流程來(lái)編寫(xiě)代碼，這通常就是在應(yīng)用程序設(shè)計(jì)時(shí)采用一種更加流程化的方法。急于完成項(xiàng)目或快速修復(fù)應(yīng)用程序都可能促使開(kāi)發(fā)人員 “走捷徑”，以便快速完成編碼。以前，編寫(xiě)不當(dāng)或者混亂的代碼可能會(huì)加重應(yīng)用程序中的不可測(cè)試性問(wèn)題，因?yàn)殚_(kāi)發(fā)人員通常會(huì)進(jìn)行風(fēng)險(xiǎn)最小的修復(fù)，即使它可能產(chǎn)生后續(xù)的支持問(wèn)題。這些問(wèn)題域都是無(wú)法通過(guò)一般的單元測(cè)試發(fā)現(xiàn)的。

依賴全局狀態(tài)的函數(shù)

全局變量在 PHP 應(yīng)用程序中很方便。它們?cè)试S您在應(yīng)用程序中初始化一些變量或?qū)ο?，然后在?yīng)用程序的其他位置使用。然而，這種靈活性是有代價(jià)的，過(guò)度使用全局變量是不可測(cè)試代碼的一個(gè)通病。我們可以在 清單 1中看到這種情況。

清單 1. 依賴于全局狀態(tài)的函數(shù)

<?php
function formatNumber($number)
{
  global $decimal_precision, $decimal_separator, $thousands_separator;
  if ( !isset($decimal_precision) ) $decimal_precision = 2;
  if ( !isset($decimal_separator) ) $decimal_separator = '.';
  if ( !isset($thousands_separator) ) $thousands_separator = ',';
  return number_format($number, $decimal_precision, $decimal_separator,
 $thousands_separator);
}

這些全局變量帶來(lái)了兩個(gè)不同的問(wèn)題。第一個(gè)問(wèn)題是您需要在測(cè)試中考慮所有這些全局變量，保證給它們?cè)O(shè)置了函數(shù)可接受的有效值。第二個(gè)問(wèn)題更為嚴(yán)重， 那就是您無(wú)法修改后續(xù)測(cè)試的狀態(tài)并使它們的結(jié)果無(wú)效，您需要保證將全局狀態(tài)重置為測(cè)試運(yùn)行之前的狀態(tài)。PHPUnit 有一些工具可以幫您備份全局變量并在測(cè)試運(yùn)行后恢復(fù)它們的值，這些工具能夠幫助解決這個(gè)問(wèn)題。然而，更好的方法是使測(cè)試類能夠直接給方法傳入這些全局變量的值。清單 2顯示了采用這種方法的一個(gè)例子。

清單 2. 修改這個(gè)函數(shù)以支持重寫(xiě)全局變量

<?php
function formatNumber($number, $decimal_precision = null, $decimal_separator = null,
$thousands_separator = null)
{
  if ( is_null($decimal_precision) ) global $decimal_precision;
  if ( is_null($decimal_separator) ) global $decimal_separator;
  if ( is_null($thousands_separator) ) global $thousands_separator;
  if ( !isset($decimal_precision) ) $decimal_precision = 2;
  if ( !isset($decimal_separator) ) $decimal_separator = '.';
  if ( !isset($thousands_separator) ) $thousands_separator = ',';
  return number_format($number, $decimal_precision, $decimal_separator,
 $thousands_separator);
}

這樣做不僅使代碼變得更具可測(cè)試性，而且也使它不依賴于方法的全局變量。這使得我們能夠?qū)Υa進(jìn)行重構(gòu)，不再使用全局變量。

無(wú)法重置的單一實(shí)例

單一實(shí)例指的是旨在讓?xiě)?yīng)用程序中一次只存在一個(gè)實(shí)例的類。它們是應(yīng)用程序中用于全局對(duì)象的一種常見(jiàn)模式，如數(shù)據(jù)庫(kù)連接和配置設(shè)置。它們通常被認(rèn)為是應(yīng)用程序的禁忌， 因?yàn)樵S多開(kāi)發(fā)人員認(rèn)為創(chuàng)建一個(gè)總是可用的對(duì)象用處不大，因此他們并不太注意這一點(diǎn)。這個(gè)問(wèn)題主要源于單一實(shí)例的過(guò)度使用，因?yàn)樗鼤?huì)造成大量不可擴(kuò)展的所謂 god objects 的出現(xiàn)。但是從測(cè)試的角度看，最大的問(wèn)題是它們通常是不可更改的。清單 3就是這樣一個(gè)例子。

清單 3. 我們要測(cè)試的 Singleton 對(duì)象

<?php
class Singleton
{
  private static $instance;
  protected function __construct() { }
  private final function __clone() {}
  public static function getInstance()
  {
    if ( !isset(self::$instance) ) {
      self::$instance = new Singleton;
    }
    return self::$instance;
  }
}

您可以看到，當(dāng)單一實(shí)例首次實(shí)例化之后，每次調(diào)用 getInstance() 方法實(shí)際上返回的都是同一個(gè)對(duì)象，它不會(huì)創(chuàng)建新的對(duì)象，如果我們對(duì)這個(gè)對(duì)象進(jìn)行修改，那么就可能造成很?chē)?yán)重的問(wèn)題。最簡(jiǎn)單的解決方案就是給對(duì)象增加一個(gè) reset 方法。清單 4 顯示的就是這樣一個(gè)例子。

清單 4. 增加了 reset 方法的 Singleton 對(duì)象

<?php
class Singleton
{
  private static $instance;
  protected function __construct() { }
  private final function __clone() {}
  public static function getInstance()
  {
    if ( !isset(self::$instance) ) {
      self::$instance = new Singleton;
    }
    return self::$instance;
  }
  public static function reset()
  {
    self::$instance = null;
  }
}

現(xiàn)在，我們可以在每次測(cè)試之前調(diào)用 reset 方法，保證我們?cè)诿看螠y(cè)試過(guò)程中都會(huì)先執(zhí)行 singleton 對(duì)象的初始化代碼?？傊?，在應(yīng)用程序中增加這個(gè)方法是很有用的，因?yàn)槲覀儸F(xiàn)在可以輕松地修改單一實(shí)例。

使用類構(gòu)造函數(shù)

進(jìn)行單元測(cè)試的一個(gè)良好做法是只測(cè)試需要測(cè)試的代碼，避免創(chuàng)建不必要的對(duì)象和變量。您創(chuàng)建的每一個(gè)對(duì)象和變量都需要在測(cè)試之后刪除。這對(duì)于文件和數(shù)據(jù)庫(kù)表等 麻煩的項(xiàng)目來(lái)說(shuō)成為一個(gè)問(wèn)題，因?yàn)樵谶@些情況下，如果您需要修改狀態(tài)，那么您必須更小心地在測(cè)試完成之后進(jìn)行一些清理操作。堅(jiān)持這一規(guī)則的最大障礙在于對(duì) 象本身的構(gòu)造函數(shù)，它執(zhí)行的所有操作都是與測(cè)試無(wú)關(guān)的。清單 5 就是這樣一個(gè)例子。

清單 5. 具有一個(gè)大 singleton 方法的類

<?php
class MyClass
{
  protected $results;
  public function __construct()
  {
    $dbconn = new DatabaseConnection('localhost','user','password');
    $this->results = $dbconn->query('select name from mytable');
  }
  public function getFirstResult()
  {
    return $this->results[0];
  }
}

在這里，為了測(cè)試對(duì)象的 fdfdfd 方法，我們最終需要建立一個(gè)數(shù)據(jù)庫(kù)連接，給表添加一些記錄，然后在測(cè)試之后清除所有這些資源。如果測(cè)試 fdfdfd完全不需要這些東西，那么這個(gè)過(guò)程可能太過(guò)于復(fù)雜。因此，我們要修改 清單 6所示的構(gòu)造函數(shù)。

清單 6. 為忽略所有不必要的初始化邏輯而修改的類

<?php
class MyClass
{
  protected $results;
  public function __construct($init = true)
  {
    if ( $init ) $this->init();
  }
  public function init()
  {
    $dbconn = new DatabaseConnection('localhost','user','password');
    $this->results = $dbconn->query('select name from mytable');
  }
  public function getFirstResult()
  {
    return $this->results[0];
  }
}

我們重構(gòu)了構(gòu)造函數(shù)中大量的代碼，將它們移到一個(gè) init() 方法中，這個(gè)方法默認(rèn)情況下仍然會(huì)被構(gòu)造函數(shù)調(diào)用，以避免破壞現(xiàn)有代碼的邏輯。然而，現(xiàn)在我們?cè)跍y(cè)試過(guò)程中只能夠傳遞一個(gè)布爾值 false 給構(gòu)造函數(shù)，以避免調(diào)用 init()方法和所有不必要的初始化邏輯。類的這種重構(gòu)也會(huì)改進(jìn)代碼，因?yàn)槲覀儗⒊跏蓟壿嫃膶?duì)象的構(gòu)造函數(shù)分離出來(lái)了。

經(jīng)硬編碼的類依賴性

正如我們?cè)谇耙还?jié)介紹的，造成測(cè)試?yán)щy的大量類設(shè)計(jì)問(wèn)題都集中在初始化各種不需要測(cè)試的對(duì)象上。在前面，我們知道繁重的初始化邏 輯可能會(huì)給測(cè)試的編寫(xiě)造成很大的負(fù)擔(dān)（特別是當(dāng)測(cè)試完全不需要這些對(duì)象時(shí)），但是如果我們?cè)跍y(cè)試的類方法中直接創(chuàng)建這些對(duì)象，又可能造成另一個(gè)問(wèn)題。清單 7顯示的就是可能造成這個(gè)問(wèn)題的示例代碼。

清單 7. 在一個(gè)方法中直接初始化另一個(gè)對(duì)象的類

<?php
class MyUserClass
{
  public function getUserList()
  {
    $dbconn = new DatabaseConnection('localhost','user','password');
    $results = $dbconn->query('select name from user');
    sort($results);
    return $results;
  }
}

假設(shè)我們正在測(cè)試上面的 getUserList方法，但是我們的測(cè)試關(guān)注點(diǎn)是保證返回的 用戶清單是按字母順序正確排序的。在這種情況下，我們的問(wèn)題不在于是否能夠從數(shù)據(jù)庫(kù)獲取這些記錄，因?yàn)槲覀兿胍獪y(cè)試的是我們是否能夠?qū)Ψ祷氐挠涗涍M(jìn)行排 序。問(wèn)題是，由于我們是在這個(gè)方法中直接實(shí)例化一個(gè)數(shù)據(jù)庫(kù)連接對(duì)象，所以我們需要執(zhí)行所有這些繁瑣的操作才能夠完成方法的測(cè)試。因此，我們要對(duì)方法進(jìn)行修 改，使這個(gè)對(duì)象可以在中間插入，如 清單 8所示。

清單 8. 這個(gè)類有一個(gè)方法會(huì)直接實(shí)例化另一個(gè)對(duì)象，但是也提供了一種重寫(xiě)的方法

<?php
class MyUserClass
{
  public function getUserList($dbconn = null)
  {
    if ( !isset($dbconn) || !( $dbconn instanceOf DatabaseConnection ) ) {
      $dbconn = new DatabaseConnection('localhost','user','password');
    }
    $results = $dbconn->query('select name from user');
    sort($results);
    return $results;
  }
}

現(xiàn)在您可以直接傳入一個(gè)對(duì)象，它與預(yù)期數(shù)據(jù)庫(kù)連接對(duì)象相兼容，然后直接使用這個(gè)對(duì)象，而非創(chuàng)建一個(gè)新對(duì)象。您也可以傳 入一個(gè)模擬對(duì)象，也就是我們?cè)谝恍┱{(diào)用方法中，用硬編碼的方式直接返回我們想要的值。在這里，我們可以模擬數(shù)據(jù)庫(kù)連接對(duì)象的查詢方法，這樣我們就只需要返 回結(jié)果，而不需要真正地去查詢數(shù)據(jù)庫(kù)。進(jìn)行這樣的重構(gòu)也能夠改進(jìn)這個(gè)方法，因?yàn)樗试S您的應(yīng)用程序在需要時(shí)插入不同的數(shù)據(jù)庫(kù)連接，而不是只綁定一個(gè)指定的 默認(rèn)數(shù)據(jù)庫(kù)連接。

可測(cè)試代碼的好處

顯然，編寫(xiě)更具可測(cè)試性的代碼肯定能夠簡(jiǎn)化 PHP 應(yīng)用程序的單元測(cè)試（正如您在本文展示的例子中所看到的），但是在這個(gè)過(guò)程中，它也能夠改進(jìn)應(yīng)用程序的設(shè)計(jì)、模塊化和穩(wěn)定性。我們都曾經(jīng)看到過(guò) “spaghetti” 代碼，它們?cè)?PHP 應(yīng)用程序的一個(gè)主要流程中充斥了大量的業(yè)務(wù)和表現(xiàn)邏輯，這毫無(wú)疑問(wèn)會(huì)給那些使用這個(gè)應(yīng)用程序的人造成嚴(yán)重的支持問(wèn)題。在使代碼變得更具可測(cè)試性的過(guò)程中， 我們對(duì)前面一些有問(wèn)題的代碼進(jìn)行了重構(gòu)；這些代碼不僅設(shè)計(jì)上有問(wèn)題，功能上也有問(wèn)題。通過(guò)使這些函數(shù)和類的用途更廣泛，以及通過(guò)刪除硬編碼的依賴性，我們 使之更容易被應(yīng)用程序其他部分重用，我們提高了代碼的可重用性。此外，我們還將編寫(xiě)不當(dāng)?shù)拇a替換成更優(yōu)質(zhì)的代碼，從而簡(jiǎn)化將來(lái)對(duì)代碼庫(kù)的支持。

結(jié)束語(yǔ)

在本文中，通過(guò) PHP 應(yīng)用程序中一些典型的不可測(cè)試代碼示例，我們了解了如何改進(jìn) PHP 代碼的可測(cè)試性。我們還介紹了這些情況是如何出現(xiàn)在應(yīng)用程序中的，然后介紹了如何恰當(dāng)?shù)匦迯?fù)這些問(wèn)題代碼來(lái)便于進(jìn)行測(cè)試。我們還了解了這些代碼的修改不僅 能夠提高代碼的可測(cè)試性，也能夠普遍改進(jìn)代碼的質(zhì)量，以及提高重構(gòu)代碼的可重用性。

更多關(guān)于PHP相關(guān)內(nèi)容感興趣的讀者可查看本站專題：《php面向?qū)ο蟪绦蛟O(shè)計(jì)入門(mén)教程》、《PHP數(shù)組(Array)操作技巧大全》、《PHP基本語(yǔ)法入門(mén)教程》、《PHP運(yùn)算與運(yùn)算符用法總結(jié)》、《php字符串(string)用法總結(jié)》、《php+mysql數(shù)據(jù)庫(kù)操作入門(mén)教程》及《php常見(jiàn)數(shù)據(jù)庫(kù)操作技巧匯總》

希望本文所述對(duì)大家PHP程序設(shè)計(jì)有所幫助。

最新評(píng)論