Trait

PHP 實(shí)現(xiàn)了一種代碼復(fù)用的方法，稱為 trait。

Trait 是為類似 PHP 的單繼承語(yǔ)言而準(zhǔn)備的一種代碼復(fù)用機(jī)制。Trait 為了減少單繼承語(yǔ)言的限制，使開發(fā)人員能夠自由地在不同層次結(jié)構(gòu)內(nèi)獨(dú)立的類中復(fù)用 method。Trait 和 Class 組合的語(yǔ)義定義了一種減少?gòu)?fù)雜性的方式，避免傳統(tǒng)多繼承和 Mixin 類相關(guān)典型問(wèn)題。

Trait 和 Class 相似，但僅僅旨在用細(xì)粒度和一致的方式來(lái)組合功能。無(wú)法通過(guò) trait 自身來(lái)實(shí)例化。它為傳統(tǒng)繼承增加了水平特性的組合；也就是說(shuō)，應(yīng)用的幾個(gè) Class 之間不需要繼承。

示例 #1 Trait 示例


<?php
trait ezcReflectionReturnInfo {
    function getReturnType() { /*1*/ }
    function getReturnDescription() { /*2*/ }
}

class ezcReflectionMethod extends ReflectionMethod {
    use ezcReflectionReturnInfo;
    /* ... */
}

class ezcReflectionFunction extends ReflectionFunction {
    use ezcReflectionReturnInfo;
    /* ... */
}
?>

優(yōu)先級(jí)

從基類繼承的成員會(huì)被 trait 插入的成員所覆蓋。優(yōu)先順序是來(lái)自當(dāng)前類的成員覆蓋了 trait 的方法，而 trait 則覆蓋了被繼承的方法。

示例 #2 優(yōu)先順序示例

從基類繼承的成員被插入的 SayWorld Trait 中的 MyHelloWorld 方法所覆蓋。其行為 MyHelloWorld 類中定義的方法一致。優(yōu)先順序是當(dāng)前類中的方法會(huì)覆蓋 trait 方法，而 trait 方法又覆蓋了基類中的方法。


<?php
class Base {
    public function sayHello() {
        echo 'Hello ';
    }
}

trait SayWorld {
    public function sayHello() {
        parent::sayHello();
        echo 'World!';
    }
}

class MyHelloWorld extends Base {
    use SayWorld;
}

$o = new MyHelloWorld();
$o->sayHello();
?>

以上例程會(huì)輸出：

Hello World!

示例 #3 另一個(gè)優(yōu)先級(jí)順序的例子


<?php
trait HelloWorld {
    public function sayHello() {
        echo 'Hello World!';
    }
}

class TheWorldIsNotEnough {
    use HelloWorld;
    public function sayHello() {
        echo 'Hello Universe!';
    }
}

$o = new TheWorldIsNotEnough();
$o->sayHello();
?>

以上例程會(huì)輸出：

Hello Universe!

多個(gè) trait

通過(guò)逗號(hào)分隔，在 use 聲明列出多個(gè) trait，可以都插入到一個(gè)類中。

示例 #4 多個(gè) trait 的用法


<?php
trait Hello {
    public function sayHello() {
        echo 'Hello ';
    }
}

trait World {
    public function sayWorld() {
        echo 'World';
    }
}

class MyHelloWorld {
    use Hello, World;
    public function sayExclamationMark() {
        echo '!';
    }
}

$o = new MyHelloWorld();
$o->sayHello();
$o->sayWorld();
$o->sayExclamationMark();
?>

以上例程會(huì)輸出：

Hello World!

沖突的解決

如果兩個(gè) trait 都插入了一個(gè)同名的方法，如果沒有明確解決沖突將會(huì)產(chǎn)生一個(gè)致命錯(cuò)誤。

為了解決多個(gè) trait 在同一個(gè)類中的命名沖突，需要使用 insteadof 操作符來(lái)明確指定使用沖突方法中的哪一個(gè)。

以上方式僅允許排除掉其它方法，as 操作符可以為某個(gè)方法引入別名。注意，as 操作符不會(huì)對(duì)方法進(jìn)行重命名，也不會(huì)影響其方法。

示例 #5 沖突的解決

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

Aliased_Talker 使用了 as 操作符來(lái)定義了 talk 來(lái)作為 B 的 bigTalk 的別名。


<?php
trait A {
    public function smallTalk() {
        echo 'a';
    }
    public function bigTalk() {
        echo 'A';
    }
}

trait B {
    public function smallTalk() {
        echo 'b';
    }
    public function bigTalk() {
        echo 'B';
    }
}

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

修改方法的訪問(wèn)控制

使用 as 語(yǔ)法還可以用來(lái)調(diào)整方法的訪問(wèn)控制。

示例 #6 修改方法的訪問(wèn)控制


<?php
trait HelloWorld {
    public function sayHello() {
        echo 'Hello World!';
    }
}

// 修改 sayHello 的訪問(wèn)控制
class MyClass1 {
    use HelloWorld { sayHello as protected; }
}

// 給方法一個(gè)改變了訪問(wèn)控制的別名
// 原版 sayHello 的訪問(wèn)控制則沒有發(fā)生變化
class MyClass2 {
    use HelloWorld { sayHello as private myPrivateHello; }
}
?>

從 trait 來(lái)組成 trait

正如 class 能夠使用 trait 一樣，其它 trait 也能夠使用 trait。在 trait 定義時(shí)通過(guò)使用一個(gè)或多個(gè) trait，能夠組合其它 trait 中的部分或全部成員。

示例 #7 從 trait 來(lái)組成 trait


<?php
trait Hello {
    public function sayHello() {
        echo 'Hello ';
    }
}

trait World {
    public function sayWorld() {
        echo 'World!';
    }
}

trait HelloWorld {
    use Hello, World;
}

class MyHelloWorld {
    use HelloWorld;
}

$o = new MyHelloWorld();
$o->sayHello();
$o->sayWorld();
?>

以上例程會(huì)輸出：

Hello World!

Trait 的抽象成員

為了對(duì)使用的類施加強(qiáng)制要求，trait 支持抽象方法的使用。支持 public 、protected 和 private 方法。PHP 8.0.0 之前，僅支持 public 和 protected 抽象方法。

警告

一個(gè)可繼承實(shí)體類，可以通過(guò)定義同名非抽象方法來(lái)滿足要求；方法的簽名可以不同。

示例 #8 表示通過(guò)抽象方法來(lái)進(jìn)行強(qiáng)制要求


<?php
trait Hello {
    public function sayHelloWorld() {
        echo 'Hello'.$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 的靜態(tài)成員

Traits 可以定義靜態(tài)變量、靜態(tài)方法和靜態(tài)屬性。

注意:
自 PHP 8.1.0 起，棄用直接在 trait 上調(diào)用靜態(tài)方法或者訪問(wèn)靜態(tài)屬性。靜態(tài)方法和屬性應(yīng)該僅在使用了 trait 的 class 中訪問(wèn)。

示例 #9 靜態(tài)變量


<?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
?>

示例 #10 靜態(tài)方法


<?php
trait StaticExample {
    public static function doSomething() {
        return 'Doing something';
    }
}

class Example {
    use StaticExample;
}

Example::doSomething();
?>

示例 #11 靜態(tài)屬性


<?php
trait StaticExample {
    public static $static = 'foo';
}

class Example {
    use StaticExample;
}

echo Example::$static;
?>

屬性

Trait 同樣可以定義屬性。

示例 #12 定義屬性


<?php
trait PropertiesTrait {
    public $x = 1;
}

class PropertiesExample {
    use PropertiesTrait;
}

$example = new PropertiesExample;
$example->x;
?>

Trait 定義了一個(gè)屬性后，類就不能定義同樣名稱的屬性，否則會(huì)產(chǎn)生 fatal error。有種情況例外：屬性是兼容的（同樣的訪問(wèn)可見度、初始默認(rèn)值）。

示例 #13 解決沖突


<?php
trait PropertiesTrait {
    public $same = true;
    public $different = false;
}

class PropertiesExample {
    use PropertiesTrait;
    public $same = true;
    public $different = true; // 致命錯(cuò)誤
}
?>