怎樣避免PHP實例代碼中的一些壞代碼

小編給大家分享一下怎樣避免PHP實例代碼中的一些壞代碼，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

做PHP開發(fā)已經(jīng)有快一年的時間了，在這一年的時間中，學習了很多生產(chǎn)環(huán)境中的技巧，學習了很多東西，期間也閱讀了一些優(yōu)秀的源碼和關于代碼的書，對寫代碼這一塊有了一定的思考，也看過很多別人寫的好的代碼和壞的代碼，這里說說自己的感悟和改進吧。

在寫代碼時，我給自己立下的規(guī)則，這樣可以讓代碼清晰可讀并少走一些坑。這些簡單的規(guī)則雖然沒有設計模式看起來那么激動人心，但是，平常注意可以讓代碼看起來很清爽。

1. 不要在對象外使用未聲明的變量

這個問題其實表述起來可能不容易理解。這個問題是因為PHP語言本身的特點決定的。由于PHP是一個弱類型的動態(tài)腳本語言，所以很多情況下，給了這個語言本省很寬松的條件讓開發(fā)者去編寫代碼。但是往往這些便利也會變?yōu)榭?，所以在使用一些動態(tài)語言很方便的寫法的時候，尤其要注意。

下面我們先聲明一個類，暫且叫這個類為用戶類，這個User類的背景設定為，框架自帶，不允許修改，并且隱藏在框架深處，不容易發(fā)現(xiàn)，實際案例可以參考laravel框架的Request類，代碼如下：

class User {
  public $username;
  public $password;
  
  public $otherInfo = [];
  
  
  public function readUserInfo() {
    return [
      'username' => $this->username,
      'password' => $this->password,
    ];
  }
  
  public function addAtri($info) {
    array_push($this->otherInfo, $info);
  }
}

這樣的代碼看似中規(guī)中矩，但是接下來，我們需要對這個類進行操作：

$user = new User();
$user->userRealName = "hello world";

這樣的代碼在PHP中是完全可以運行的，并且不會報錯，但是這樣的代碼會對之后的一些事情做為干擾。我們現(xiàn)在假定，上邊的代碼是在PHP web項目中是一個攔截器，或者叫做中間件也可以，然后我們在controller中會會使用到這個類的實例，并且使用到這個中間件中添加的這個變量，如下：

 class WebOperate {
   public function doOprate(User $user) {
     $user->userRealName = "hello world";
     next($user);
   }
 }

這里設定的場景是，WebOperate是一個中間件，所有的Controller都會走這個中間件后到達Controller，之后，在處理相應的Controller的功能，接下來，Controller會將中間件的實例注入進來，供控制器使用，而中間件開發(fā)人員不是很在意其的存在：

 class IndexController {
   public function index(User $user) {
     return $user->userRealName;
   }
 }

而這樣的代碼是可以完美運行的，接下來，開發(fā)人員想要的實另一個User類，這個User類中添加一些其他功能，正如之前所說，這個類在框架深處并且很難找到，且不允許修改，因為其他功能使用了這個類，所以，我們只有繼承并添加方法。根據(jù)開發(fā)經(jīng)驗，開發(fā)人員會認為User類中存在這個userRealName變量，所以就造成了這個寫法：

首先是基于這個User衍生出來的Teacher類：

 class Teacher extends User {
   public function sayHello() {
     return "hello world";
   }
 }

這樣，我們的Teacher就可以sayhello了，但是，這個時候，在我們的Controller中還想知道老師的真實姓名，怎么辦？根據(jù)經(jīng)驗，我們可以將注入的類換成Teacher并且返回真實姓名：

 class IndexController {
   public function index(Teacher $user) {
     return $user->userRealName;
   }
 }

那么這下問題來了，其實User類中并沒有這個類，所以這個變量根本沒有數(shù)值，但是根據(jù)經(jīng)驗，是中間件已經(jīng)賦值過一次了，所以我們應該可以直接使用，但是并沒有這個數(shù)值，我們開始看源碼發(fā)現(xiàn)，繼承的User類中根本不存在這個變量，那么這個變量之前為什么可以使用呢，因為在中間件中，給User的實力付了值。

所以我們的不能這樣直接使用未聲明的變量，在一個類中。

我們應該這樣寫：

class WebOperate {
  public function doOprate(User $user) {
    $user->addAtri([
      'userRealName' => 'hello world',
    ]);
    next($user);
  }
}

這樣的中間件，在調用的時候繼承類也可以使用同樣的方法，很簡單并且很不容易出現(xiàn)壞的味道。

2. 類or數(shù)組

其實這個問題同時也衍生出了另外的問題，就是函數(shù)返回值的問題。

首先，我明確表示，一個函數(shù)做多種類型的返回值是我個人感覺是不好的，在動態(tài)語言中雖然很常見，很多PHP的原生方法也有這樣的，但是，在生產(chǎn)中使用這樣的方式會造成函數(shù)返回的不確定性，我們需要作出很多判斷來證明我們的結論，但是，如果返回值類型只有一種，我們就可以直接判斷返回值就好了。

就像如下代碼：

public function addNewUser() {
    $res = $this->addData();
    if ($res) {
      return true;
    } else {
      return [
        'error' => 1,
        'errormsg' => "沒有添加成功"
      ];
    }
  }

這樣的代碼在作為調用者往往會多一次判斷，如下：

public function index() {
    $res = $this->addNewUser();
    if (is_array($res) && isset($res['error'])) {
      return isset($res['errormsg']) ? $res['errormsg'] : "未知錯誤";
    }
    return "成功";
  }

這樣的代碼幾乎每一次調用完成這個函數(shù)都會有這一套出現(xiàn)，不僅代碼不美觀，而且很臃腫。

這樣的代碼需要改善，首先限制住函數(shù)的返回值。比如，我們只讓這個函數(shù)返回bool類型的數(shù)：

public function addNewUser() {
  $res = $this->addData();
  if ($res) {
    return true;
  } else {
    return false;
  }
}

但是，顯然，很多時候，我們要的不是簡單的真價值，所以，我們會選擇返回更多信息，這個時候，我們可以有三種處理方式。

1）返回int類型的數(shù)，然后通過這個int類型的數(shù)去判斷處理結果，我們可以添加上映射關系：

class Operate{
  public $operateRes = [
    0 => '成功',
    1 => '添加失敗',
    2 => '未知錯誤',
  ];
  
  
  public function addNewUser() {
    $res = $this->addData();
    if ($res) {
      return 0;
    } else if ($res > 1) {
      return 1;
    }
    return 2;
  }
  
}

這樣方法的調用者就可以很簡單的使用方法并給出提示了：

$opera = new Operate();
$res = $opera->addNewUser();
return $opera->operateRes[$res];

給出統(tǒng)一的返回值類型的時候就完全不需要判斷返回值類型而且可以設置一個規(guī)范返回提示。

2）我們也可以使用數(shù)組

3）數(shù)組給人不缺定性，因為很多時候，數(shù)組里可以認為的少寫一些元素，如果少寫了，程序直接報錯，很不好。

所以第三種方式就是建議將固定格式的返回，寫成一個類，做返回的時候，使用這個類：

class Operate{
  public function addNewUser() {
    $res = $this->addData();
    $result = new Result();
    if ($res) {
      $result->errno = 0;
      $result->errmsg = "成功";
    } else if ($res > 1) {
      $result->errno = 1;
      $result->errmsg = "失敗";
    }
    $result->errno = 2;
    $result->errmsg = "未知錯誤";
    return $result;
  }
  
}

class Result {
  public $errno;
  public $errmsg;
}

這樣的返回，保證了所有變量的存在，同樣可以減少一次判斷。

所以，綜合以上，在我們返回結果的時候，盡量使用同種類型的變量，盡量減少使用數(shù)組返回。

以上是“怎樣避免PHP實例代碼中的一些壞代碼”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業(yè)資訊頻道！