PHP中Trait詳解及其應用

從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應用中的優先級以下:

1. 來自當前類的成員覆蓋了 trait 的方法
2. 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內部使用的。

• 其餘介紹的Trait的文章：如何使用Trait?
• 文章首發在：PHP中Trait詳解及其應用