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

这样的返回，保证了所有变量的存在，同样可以减少一次判断。

所以，综合以上，在我们返回结果的时候，尽量使用同种类型的变量，尽量减少使用数组返回。

以上是php技巧之如何巧妙避免PHP程式中的一些壞程式碼的詳細內容。更多資訊請關注PHP中文網其他相關文章！