php 5.4 全新的代碼復用Trait詳解，5.4trait

php 5.4 全新的代碼復用Trait詳解，5.4trait

從PHP的5.4.0版本開始,PHP提供了一種全新的代碼復用的概念,那就是Trait。Trait其字面意思是"特性"、"特點",我們可以理解為,使用Trait關鍵字,可以為PHP中的類添加新的特性。

熟悉面向對象的都知道,軟件開發中常用的代碼復用有繼承和多態兩種方式。在PHP中,只能實現單繼承。而Trait則避免了這點。下面通過簡單的額例子來進行對比說明。

1. 繼承 VS 多態 VS Trait

現在有Publish.php和Answer.php這兩個類。要在其中添加LOG功能,記錄類內部的動作。有以下幾種方案:

1. 繼承
2. 多態
3. Trait

1.1. 繼承

如圖:

代碼結構如下:

// Log.php
<?php
Class Log
{
 public function startLog()
 {
  // echo ...
 }

 public function endLog()
 {
  // echo ...
 }
}

// Publish.php
<?php
Class Publish extends Log
{

}

// Answer.php
<?php
Class Answer extends Log
{
 
}

可以看到繼承的確滿足了要求。但這卻違背了面向對象的原則。而發布(Publish)和回答(Answer)這樣的操作和日志(Log)之間的關系並不是子類與父類的關系。所以不推薦這樣使用。

1.2. 多態

如圖:

實現代碼:

// Log.php
<?php
Interface Log
{
 public function startLog();
 public function endLog();
}

// Publish.php
<?php
Class Publish implements Log
{
 public function startLog()
 {
  // TODO: Implement startLog() method.
 }
 public function endLog()
 {
  // TODO: Implement endLog() method.
 }
}

// Answer.php
<?php
Class Answer implements Log
{
 public function startLog()
 {
  // TODO: Implement startLog() method.
 }
 public function endLog()
 {
  // TODO: Implement endLog() method.
 }
}

記錄日志的操作應該都是一樣的,因此,發布(Publish)和回答(Answer)動作中的日志記錄實現也是一樣的。很明顯,這違背了DRY(Don't Repeat Yourself)原則。所以是不推薦這樣實現的。

1.3. Trait

如圖:

實現代碼如下:

// Log.php
<?php
trait Log{
 public function startLog() {
  // echo ..
 }
 public function endLog() {
  // echo ..
 }
}

// Publish.php
<?php
class Publish {
 use Log;
}
$publish = new Publish();
$publish->startLog();
$publish->endLog();

// Answer.php
<?php
class Answer {
 use Log;
}
$answer = new Answer();
$answer->startLog();
$answer->endLog();

可以看到,我們在沒有增加代碼復雜的情況下,實現了代碼的復用。

1.4. 結論

繼承的方式雖然也能解決問題,但其思路違背了面向對象的原則,顯得很粗暴;多態方式也可行,但不符合軟件開發中的DRY原則,增加了維護成本。而Trait方式則避免了上述的不足之處,相對優雅的實現了代碼的復用。

2. Trait的作用域

了解了Trait的好處,我們還需要了解其實現中的規則,先來說一下作用域。這個比較好證明,實現代碼如下:

<?php
class Publish {
 use Log;
 public function doPublish() {
  $this->publicF();
  $this->protectF();
  $this->privateF();
 }
}
$publish = new Publish();
$publish->doPublish();

執行上述代碼輸出結果如下:

public function
protected function
private function

可以發現,Trait的作用域在引用該Trait類的內部是都可見的。可以理解為use關鍵字將Trait的實現代碼Copy了一份到引用該Trait的類中。

3. Trait中屬性的優先級

說到優先級,就必須要有一個對比的參照物,這裡的參照對象時引用Trait的類及其父類。

通過以下的代碼來證明Trait應用中的屬性的優先級:

<?php
trait Log
{
 public function publicF()
 {
  echo __METHOD__ . ' public function' . PHP_EOL;
 }
 protected function protectF()
 {
  echo __METHOD__ . ' protected function' . PHP_EOL;
 }
}

class Question
{
 public function publicF()
 {
  echo __METHOD__ . ' public function' . PHP_EOL;
 }
 protected function protectF()
 {
  echo __METHOD__ . ' protected function' . PHP_EOL;
 }
}

class Publish extends Question
{
 use Log;

 public function publicF()
 {
  echo __METHOD__ . ' public function' . PHP_EOL;
 }
 public function doPublish()
 {
  $this->publicF();
  $this->protectF();
 }
}
$publish = new Publish();
$publish->doPublish();

上述代碼的輸出結果如下:

Publish::publicF public function
Log::protectF protected function

通過上面的例子,可以總結出Trait應用中的優先級如下:

來自當前類的成員覆蓋了 trait 的方法

trait 覆蓋了被繼承的方法

類成員優先級為:當前類>Trait>父類

4. Insteadof和As關鍵字

在一個類中,可以引用多個Trait,如下:

<?php
trait Log
{
 public function startLog()
 {
  echo __METHOD__ . ' public function' . PHP_EOL;
 }
 protected function endLog()
 {
  echo __METHOD__ . ' protected function' . PHP_EOL;
 }
}

trait Check
{
 public function parameterCheck($parameters) {
  // do sth
 }
}

class Publish extends Question
{
 use Log,Check;
 public function doPublish($para) {
  $this->startLog();
  $this->parameterCheck($para);
  $this->endLog();
 }
}

通過上面的方式,我們可以在一個類中引用多個Trait。引用多個Trait的時候,就容易出問題了,最常見的問題就是兩個Trait中如果出現了同名的屬性或者方法該怎麼辦呢?這個時候就需要用到Insteadof 和 as 這兩個關鍵字了.請看如下實現代碼:

<?php

trait Log
{
 public function parameterCheck($parameters)
 {
  echo __METHOD__ . ' parameter check' . $parameters . PHP_EOL;
 }

 public function startLog()
 {
  echo __METHOD__ . ' public function' . PHP_EOL;
 }
}

trait Check
{
 public function parameterCheck($parameters)
 {
  echo __METHOD__ . ' parameter check' . $parameters . PHP_EOL;
 }

 public function startLog()
 {
  echo __METHOD__ . ' public function' . PHP_EOL;
 }
}

class Publish
{
 use Check, Log {
  Check::parameterCheck insteadof Log;
  Log::startLog insteadof Check;
  Check::startLog as csl;
 }

 public function doPublish()
 {
  $this->startLog();
  $this->parameterCheck('params');
  $this->csl();
 }
}

$publish = new Publish();
$publish->doPublish();

執行上述代碼,輸出結果如下:

Log::startLog public function
Check::parameterCheck parameter checkparams
Check::startLog public function

就如字面意思一般,insteadof關鍵字用前者取代了後者,as 關鍵字給被取代的方法起了一個別名。

在引用Trait時,使用了use關鍵字,use關鍵字也用來引用命名空間。兩者的區別在於,引用Trait時是在class內部使用的。