php技巧之如何巧妙避免PHP程式中的一些壞代碼

本篇文章給大家分享了如何在PHP執行個體代碼中發現壞代碼以及如何修複的問題，有興趣的朋友參考下。

做PHP開發已經有快一年的時間了，在這一年的時間中，學習了很多生產環境中的技巧，學習了很多東西，期間也閱讀了一些優秀的源碼和關於代碼的書，對寫代碼這一塊有了一定的思考，也看過很多別人寫的好的代碼和壞的代碼，這裡說說自己的感悟和改進吧。

本篇部落格直說自己的感悟，在寫代碼時，我給自己立下的規則，這樣可以讓代碼清晰可讀並少走一些坑。這些簡單的規則雖然沒有設計模式看起來那麼激動人心，但是，平常注意可以讓代碼看起來很清爽。

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

這個問題其實表述起來可能不容易理解。這個問題是因為PHP語言本身的特點決定的。由於PHP是一個弱類型的動態指令碼語言，所以很多情況下，給了這個語言本省很寬鬆的條件讓開發人員去編寫代碼。但是往往這些便利也會變為坑，所以在使用一些動態語言很方便的寫法的時候，尤其要注意。

下面我們先聲明一個類，暫且叫這個類為使用者類，這個User類的背景設定為，架構內建，不允許修改，並且隱藏在架構深處，不容易發現，實際案例可以參考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);  }}

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

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

這樣的代碼在PHP中是完全可以啟動並執行，並且不會報錯，但是這樣的代碼會對之後的一些事情做為幹擾。我們現在假定，上邊的代碼是在PHP web項目中是一個攔截器，或者叫做中介軟體也可以，然後我們在controller中會會使用到這個類的執行個體，並且使用到這個中介軟體中添加的這個變數，如下：

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

這裡設定的情境是，WebOperate是一個中介軟體，所有的Controller都會走這個中介軟體後到達Controller，之後，在處理相應的Controller的功能，接下來，Controller會將中介軟體的執行個體注入進來，供控制器使用，而中介軟體開發人員不是很在意其的存在：

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

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

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

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

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

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

那麼這下問題來了，其實User類中並沒有這個類，所以這個變數根本沒有數值，但是根據經驗，是中介軟體已經賦值過一次了，所以我們應該可以直接使用，但是並沒有這個數值，我們開始看源碼發現，繼承的User類中根本不存在這個變數，那麼這個變數之前為什麼可以使用呢，因為在中介軟體中，給User的實力付了值。

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

我們應該這樣寫：

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

這樣的中介軟體，在調用的時候繼承類也可以使用同樣的方法，很簡單並且很不容易出現壞的味道。

2. 類or數組

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

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

就像如下代碼：

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 "成功";  }

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

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

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

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

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

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];

給出統一的傳回值類型的時候就完全不需要判斷傳回值類型而且可以設定一個規範返回提示。

2）我們也可以使用數組

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

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

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;}

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

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