淺談 Trait 類

逍遙俠發表於2019-01-16

自 PHP 5.4.0 起,PHP 實現了一種程式碼複用的方法,稱為 trait。 Trait 是為類似 PHP 的單繼承語言而準備的一種程式碼複用機制。Trait 為了減少單繼承語言的限制,使開發人員能夠自由地在不同層次結構內獨立的類中複用 method。Trait 和 Class 組合的語義定義了一種減少複雜性的方式。

以下的事例程式碼均從參考php官方手冊中的事例

<?php
trait Make {
    function MakeCar() { /*1*/ }
    function MakeAirplane() { /*2*/ }
}

class China extends BaseController {
    use Make;
    /* ... */
}

class America extends BaseController {
    use Make;
    /* ... */
}
?>
複製程式碼

我們以上述為例子,有兩個類,一個為中國類,一個為美國類。他們都已經繼承了一個基礎的控制器。我們結合實際的業務去思考。世界上雖然有很多國家,但不是每個國家都有能力自己造車和造飛機。因此造飛機和造車不能作為基礎控制器的公共方法。因此為了解決類似單繼承的問題,我們可以使用trait類,單獨構造,造飛機與汽車的類。在需要使用的地方直接通過在類的內部通過關鍵字use使用即可。

關於優先順序

從基類繼承的成員會被 trait 插入的成員所覆蓋。優先順序:是來自當前類的成員> trait >繼承。

當前類成員的優先順序大於trait:

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

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

$o = new TheWorldIsNotEnough();
$o->sayHello();
?>
輸出:Hello Universe!複製程式碼

trait優先順序大於繼承:

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

trait SayWorld {
    public function sayHello() {
        parent::sayHello();//複用父類sayHello方法
        echo 'World!';
    }
}

class MyHelloWorld extends Base {
    use SayWorld;
}

$o = new MyHelloWorld();
$o->sayHello();
?>
輸出結果:Hello World!複製程式碼

關於多個 trait 

通過逗號分隔,在 use 宣告列出多個 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();
?>
輸出結果:Hello World!複製程式碼

關於衝突的解決

如果兩個 trait 都插入了一個同名的方法,如果沒有明確解決衝突將會產生一個致命錯誤。 為了解決多個 trait 在同一個類中的命名衝突,需要使用 insteadof 操作符來明確指定使用衝突方法中的哪一個。以上方式僅允許排除掉其它方法,as 操作符可以 為某個方法引入別名。 注意,as 操作符不會對方法進行重新命名,也不會影響其方法

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

Aliased_Talker 使用了 as 操作符來定義了 talk 來作為 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;
    }
}
?>
複製程式碼

修改方法的訪問控制

使用 as 語法還可以用來調整方法的訪問控制

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

// 修改 sayHello 的訪問控制
class MyClass1 {
    use HelloWorld { sayHello as protected; }
}

// 給方法一個改變了訪問控制的別名
// 原版 sayHello 的訪問控制則沒有發生變化
class MyClass2 {
    use HelloWorld { sayHello as private myPrivateHello; }
}
?>
複製程式碼

從 trait 來組成 trait 

正如 class 能夠使用 trait 一樣,其它 trait 也能夠使用 trait。在 trait 定義時通過使用一個或多個 trait,能夠組合其它 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();
?>
輸出結果:Hello World!複製程式碼

Trait 的抽象成員

為了對使用的類施加強制要求,trait 支援抽象方法的使用
<?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 的靜態成員 

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 'Doing something';
    }
}

class Example {
    use StaticExample;
}

Example::doSomething();
?>
複製程式碼

屬性

Trait 同樣可以定義屬性
<?php
trait PropertiesTrait {
    public $x = 1;
}

class PropertiesExample {
    use PropertiesTrait;
}

$example = new PropertiesExample;
$example->x;
?>
複製程式碼

Trait 定義了一個屬性後,類就不能定義同樣名稱的屬性,否則會產生 fatal error。 有種情況例外:屬性是相容的(同樣的訪問可見度、初始預設值)。 在 PHP 7.0 之前,屬性是相容的,則會有 E_STRICT 的提醒。

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

class PropertiesExample {
    use PropertiesTrait;
    public $same = true; // PHP 7.0.0 後沒問題,之前版本是 E_STRICT 提醒
    public $different = true; // 致命錯誤
}
?>
複製程式碼

以上,就是關於trait的一些相關知識。雖然程式碼片段大部分都是屬於官方案例。但是隻要細心去體會,你就能會知道以後在開發中如何使用類似的東西了。