PHP實作程式碼復用的traits新特性的方法

在閱讀yii2原始碼的時候接觸到了trait，就學習了一下，寫下部落格記錄一下。

自 PHP 5.4.0 起，PHP 實作了程式碼重複使用的一個方法，稱為 traits。

Traits 是一種為類似 PHP 的單繼承語言而準備的程式碼重複使用機制。 Trait 為了減少單繼承語言的限制，使開發人員能夠自由地在不同層次結構內獨立的類別中復用方法集。 Traits 和類別組合的語義是定義了一種方式來減少複雜性，避免與傳統多繼承和混入類別（Mixin）相關的典型問題。

Trait 和一個類別相似，但僅僅旨在用細粒度和一致的方式來組合功能。 Trait 不能透過它本身來實例化。它為傳統繼承增加了水平特性的組合；也就是說，應用類別的成員不需要繼承。

Trait 範例

程式碼如下：

<?php
trait ezcReflectionReturnInfo {
    function getReturnType() { /*1*/ }
    function getReturnDescription() { /*2*/ }
}
class ezcReflectionMethod extends ReflectionMethod {
    use ezcReflectionReturnInfo;
    /* ... */
}
class ezcReflectionFunction extends ReflectionFunction {
    use ezcReflectionReturnInfo;
    /* ... */
}
?>

#優先權

從基底類別繼承的成員被trait 插入的成員所覆蓋。優先順序是來自目前類別的成員覆寫了 trait 的方法，而 trait 則覆寫了被繼承的方法。

優先順序範例

程式碼如下:

<?php
class Base {
    public function sayHello() {
        echo &#39;Hello &#39;;
    }
}
trait SayWorld {
    public function sayHello() {
        parent::sayHello();
        echo &#39;World!&#39;;
    }
}
class MyHelloWorld extends Base {
    use SayWorld;
}
$o = new MyHelloWorld();
$o->sayHello();
?>

以上例程會輸出：Hello World!

從基底類別繼承的成員被插入的SayWorld Trait 中的sayHello 方法所覆蓋。其行為 MyHelloWorld 類別中定義的方法一致。優先順序是目前類別中的方法會覆寫 trait 方法，而 trait 方法又覆寫了基底類別中的方法。

另一個優先順序的範例

程式碼如下:

<?php
trait HelloWorld {
    public function sayHello() {
        echo &#39;Hello World!&#39;;
    }
}
class TheWorldIsNotEnough {
    use HelloWorld;
    public function sayHello() {
        echo &#39;Hello Universe!&#39;;
    }
}
$o = new TheWorldIsNotEnough();
$o->sayHello();
?>

以上例程會輸出：Hello Universe!

多個trait

透過逗號分隔，在use 宣告列出多個trait，可以都插入到一個類別中。

多個trait 的用法的範例

程式碼如下:

<?php
trait Hello {
    public function sayHello() {
        echo &#39;Hello &#39;;
    }
}
trait World {
    public function sayWorld() {
        echo &#39;World&#39;;
    }
}
class MyHelloWorld {
    use Hello, World;
    public function sayExclamationMark() {
        echo &#39;!&#39;;
    }
}
$o = new MyHelloWorld();
$o->sayHello();
$o->sayWorld();
$o->sayExclamationMark();
?>

以上例程會輸出：Hello World!

##衝突的解決

如果兩個trait 都插入了一個同名的方法，如果沒有明確解決衝突將會產生一個致命錯誤。

為了解決多個 trait 在同一個類別中的命名衝突，需要使用 insteadof 運算子來明確指定使用衝突方法中的哪一個。

以上方式僅允許排除掉其它方法，as 運算子可以將其中一個衝突的方法以另一個名稱來引入。

衝突解決的範例

程式碼如下：

<?php
trait A {
    public function smallTalk() {
        echo &#39;a&#39;;
    }
    public function bigTalk() {
        echo &#39;A&#39;;
    }
}
trait B {
    public function smallTalk() {
        echo &#39;b&#39;;
    }
    public function bigTalk() {
        echo &#39;B&#39;;
    }
}
class Talker {
    use A, B {
        B::smallTalk insteadof A;
        A::bigTalk insteadof B;
    }
}
class Aliased_Talker {
    use A, B {
        B::smallTalk insteadof A;
        A::bigTalk insteadof B;
        B::bigTalk as talk;
    }
}
?>

在本例中 Talker 使用了 trait A 和 B。由於 A 和 B 有衝突的方法，其定義了使用 trait B 中的 smallTalk 以及 trait A 中的 bigTalk。

Aliased_Talker 使用了 as 運算子來定義了 talk 來作為 B 的 bigTalk 的別名。

修改方法的存取控制

使用 as 語法也可以用來調整方法的存取控制。

修改方法的存取控制的範例

程式碼如下：

<?php
trait HelloWorld {
    public function sayHello() {
        echo &#39;Hello World!&#39;;
    }
}
// 修改 sayHello 的访问控制
class MyClass1 {
    use HelloWorld { sayHello as protected; }
}
// 给方法一个改变了访问控制的别名
// 原版 sayHello 的访问控制则没有发生变化
class MyClass2 {
    use HelloWorld { sayHello as private myPrivateHello; }
}
?>

從trait 來組成trait
##正如類別能夠使用trait 一樣，其它trait 也能夠使用trait。在 trait 定義時透過使用一個或多個 trait，它能夠組合其它 trait 中的部分或全部成員。

從trait 來組成trait的範例

程式碼如下:

<?php
trait Hello {
    public function sayHello() {
        echo &#39;Hello &#39;;
    }
}
trait World {
    public function sayWorld() {
        echo &#39;World!&#39;;
    }
}
trait HelloWorld {
    use Hello, World;
}
class MyHelloWorld {
    use HelloWorld;
}
$o = new MyHelloWorld();
$o->sayHello();
$o->sayWorld();
?>

以上例程會輸出：Hello World!

Trait 的抽象成員

為了對使用的類別施加強制要求，trait 支援抽象方法的使用。

表示透過抽象方法來進行強制要求的範例

程式碼如下:

<?php
trait Hello {
    public function sayHelloWorld() {
        echo &#39;Hello&#39;.$this->getWorld();
    }
    abstract public function getWorld();
}
class MyHelloWorld {
    private $world;
    use Hello;
    public function getWorld() {
        return $this->world;
    }
    public function setWorld($val) {
        $this->world = $val;
    }
}
?>

Trait 的靜態成員

Traits 可以被靜態成員靜態方法定義。

靜態變數的範例

程式碼如下：

<?php
trait Counter {
    public function inc() {
        static $c = 0;
        $c = $c + 1;
        echo "$c\n";
    }
}
class C1 {
    use Counter;
}
class C2 {
    use Counter;
}
$o = new C1(); $o->inc(); // echo 1
$p = new C2(); $p->inc(); // echo 1
?>

靜態方法的範例

#程式碼如下：

<?php
trait StaticExample {
    public static function doSomething() {
        return &#39;Doing something&#39;;
    }
}
class Example {
    use StaticExample;
}
Example::doSomething();
?>

靜​​態變數和靜態方法的範例

程式碼如下:

<?php
trait Counter {
    public static $c = 0;
    public static function inc() {
        self::$c = self::$c + 1;
        echo self::$c . "\n";
    }
}
class C1 {
    use Counter;
}
class C2 {
    use Counter;
}
C1::inc(); // echo 1
C2::inc(); // echo 1
?>

屬性

Trait 同樣可以定義屬性。

定義屬性的例子

程式碼如下:

<?php
trait PropertiesTrait {
    public $x = 1;
}
class PropertiesExample {
    use PropertiesTrait;
}
$example = new PropertiesExample;
$example->x;
?>

如果trait 定義了一個屬性，那類別將不能定義同樣名稱的屬性，否則會產生一個錯誤。如果該屬性在類別中的定義與在 trait 中的定義相容（相同的可見性和初始值）則錯誤的等級是 E_STRICT，否則是一個致命錯誤。

衝突的例子

 程式碼如下:

<?php
trait PropertiesTrait {
    public $same = true;
    public $different = false;
}
class PropertiesExample {
    use PropertiesTrait;
    public $same = true; // Strict Standards
    public $different = true; // 致命错误
}
?>

Use的不同

##不同use的例子

程式碼如下:

<?php
namespace Foo\Bar;
use Foo\Test;  // means \Foo\Test - the initial \ is optional
?>
<?php
namespace Foo\Bar;
class SomeClass {
    use Foo\Test;   // means \Foo\Bar\Foo\Test
}
?>

第一個use是用於namespace 的use Foo\Test，找到的是\Foo\Test，第二個use 是使用一個trait，找到的是
\Foo\Bar\Foo\Test

。

__CLASS__

和

__TRAIT____CLASS__ 傳回use trait 的class name，__TRAIT__傳回trait name
#範例如下

程式碼如下：

<?php
trait TestTrait {
    public function testMethod() {
        echo "Class: " . __CLASS__ . PHP_EOL;
        echo "Trait: " . __TRAIT__ . PHP_EOL;
    }
}
class BaseClass {
    use TestTrait;
}
class TestClass extends BaseClass {
}
$t = new TestClass();
$t->testMethod();
//Class: BaseClass
//Trait: TestTrait

Trait單例

實例如下

程式碼如下:

<?php
trait singleton {    
    /**
     * private construct, generally defined by using class
     */
    //private function __construct() {}
    public static function getInstance() {
        static $_instance = NULL;
        $class = __CLASS__;
        return $_instance ?: $_instance = new $class;
    }
    public function __clone() {
        trigger_error(&#39;Cloning &#39;.__CLASS__.&#39; is not allowed.&#39;,E_USER_ERROR);
    }
    public function __wakeup() {
        trigger_error(&#39;Unserializing &#39;.__CLASS__.&#39; is not allowed.&#39;,E_USER_ERROR);
    }
}
/**
* Example Usage
*/
class foo {
    use singleton;
    private function __construct() {
        $this->name = &#39;foo&#39;;
    }
}
class bar {
    use singleton;
    private function __construct() {
        $this->name = &#39;bar&#39;;
    }
}
$foo = foo::getInstance();
echo $foo->name;
$bar = bar::getInstance();
echo $bar->name;

呼叫trait方法

雖然不很明顯，但是如果Trait的方法可以被定義為在普通類別的靜態方法，就可以被呼叫

实例如下

代码如下:

<?php 
trait Foo { 
    function bar() { 
        return &#39;baz&#39;; 
    } 
} 
echo Foo::bar(),"\\n"; 
?>

相关学习推荐：PHP编程从入门到精通

以上是PHP實作程式碼復用的traits新特性的方法的詳細內容。更多資訊請關注PHP中文網其他相關文章！