PHP trait介绍

Trait

自 PHP 5.4.0 起,PHP 实现了一种代码复用的方法,称为 trait。

Trait 是为类似 PHP 的单继承语言而准备的一种代码复用机制。Trait 为了减少单继承语言的限制,使开发人员能够自由地在不同层次结构内独立的类中复用 method。Trait 和 Class 组合的语义定义了一种减少复杂性的方式,避免传统多继承和 Mixin 类相关典型问题。

Trait 和 Class 相似,但仅仅旨在用细粒度和一致的方式来组合功能。 无法通过 trait 自身来实例化。它为传统继承增加了水平特性的组合;也就是说,应用的几个 Class 之间不需要继承。

Example #1 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 则覆盖了被继承的方法。

Example #2 优先顺序示例

从基类继承的成员被插入的 SayWorld Trait 中的 MyHelloWorld 方法所覆盖。其行为 MyHelloWorld 类中定义的方法一致。优先顺序是当前类中的方法会覆盖 trait 方法,而 trait 方法又覆盖了基类中的方法。

 1 <?php
 2 class Base {
 3     public function sayHello() {
 4         echo 'Hello ';
 5     }
 6 }
 7 
 8 trait SayWorld {
 9     public function sayHello() {
10         parent::sayHello();
11         echo 'World!';
12     }
13 }
14 
15 class MyHelloWorld extends Base {
16     use SayWorld;
17 }
18 
19 $o = new MyHelloWorld();
20 $o->sayHello();
21 ?>

以上例程会输出:

Hello World!

Example #3 另一个优先级顺序的例子

 1 <?php
 2 trait HelloWorld {
 3     public function sayHello() {
 4         echo 'Hello World!';
 5     }
 6 }
 7 
 8 class TheWorldIsNotEnough {
 9     use HelloWorld;
10     public function sayHello() {
11         echo 'Hello Universe!';
12     }
13 }
14 
15 $o = new TheWorldIsNotEnough();
16 $o->sayHello();
17 ?>

以上例程会输出:

Hello Universe!

多个 trait

通过逗号分隔,在 use 声明列出多个 trait,可以都插入到一个类中。

Example #4 多个 trait 的用法

 1 <?php
 2 trait Hello {
 3     public function sayHello() {
 4         echo 'Hello ';
 5     }
 6 }
 7 
 8 trait World {
 9     public function sayWorld() {
10         echo 'World';
11     }
12 }
13 
14 class MyHelloWorld {
15     use Hello, World;
16     public function sayExclamationMark() {
17         echo '!';
18     }
19 }
20 
21 $o = new MyHelloWorld();
22 $o->sayHello();
23 $o->sayWorld();
24 $o->sayExclamationMark();
25 ?>

以上例程会输出:

Hello World!

冲突的解决

如果两个 trait 都插入了一个同名的方法,如果没有明确解决冲突将会产生一个致命错误。

为了解决多个 trait 在同一个类中的命名冲突,需要使用 insteadof 操作符来明确指定使用冲突方法中的哪一个。

以上方式仅允许排除掉其它方法,as 操作符可以 为某个方法引入别名。 注意,as 操作符不会对方法进行重命名,也不会影响其方法。

Example #5 冲突的解决

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

Aliased_Talker 使用了 as 操作符来定义了 talk 来作为 B 的 bigTalk 的别名。

 1 <?php
 2 trait A {
 3     public function smallTalk() {
 4         echo 'a';
 5     }
 6     public function bigTalk() {
 7         echo 'A';
 8     }
 9 }
10 
11 trait B {
12     public function smallTalk() {
13         echo 'b';
14     }
15     public function bigTalk() {
16         echo 'B';
17     }
18 }
19 
20 class Talker {
21     use A, B {
22         B::smallTalk insteadof A;
23         A::bigTalk insteadof B;
24     }
25 }
26 
27 class Aliased_Talker {
28     use A, B {
29         B::smallTalk insteadof A;
30         A::bigTalk insteadof B;
31         B::bigTalk as talk;
32     }
33 }
34 ?>

Note:

在 PHP 7.0 之前,在类里定义和 trait 同名的属性,哪怕是完全兼容的也会抛出 E_STRICT(完全兼容的意思:具有相同的访问可见性、初始默认值)。

修改方法的访问控制

使用 as 语法还可以用来调整方法的访问控制。

Example #6 修改方法的访问控制

 1 <?php
 2 trait HelloWorld {
 3     public function sayHello() {
 4         echo 'Hello World!';
 5     }
 6 }
 7 
 8 // 修改 sayHello 的访问控制
 9 class MyClass1 {
10     use HelloWorld { sayHello as protected; }
11 }
12 
13 // 给方法一个改变了访问控制的别名
14 // 原版 sayHello 的访问控制则没有发生变化
15 class MyClass2 {
16     use HelloWorld { sayHello as private myPrivateHello; }
17 }
18 ?>

从 trait 来组成 trait

正如 class 能够使用 trait 一样,其它 trait 也能够使用 trait。在 trait 定义时通过使用一个或多个 trait,能够组合其它 trait 中的部分或全部成员。

Example #7 从 trait 来组成 trait

 1 <?php
 2 trait Hello {
 3     public function sayHello() {
 4         echo 'Hello ';
 5     }
 6 }
 7 
 8 trait World {
 9     public function sayWorld() {
10         echo 'World!';
11     }
12 }
13 
14 trait HelloWorld {
15     use Hello, World;
16 }
17 
18 class MyHelloWorld {
19     use HelloWorld;
20 }
21 
22 $o = new MyHelloWorld();
23 $o->sayHello();
24 $o->sayWorld();
25 ?>

以上例程会输出:

Hello World!

Trait 的抽象成员

为了对使用的类施加强制要求,trait 支持抽象方法的使用。

Example #8 表示通过抽象方法来进行强制要求

 1 <?php
 2 trait Hello {
 3     public function sayHelloWorld() {
 4         echo 'Hello'.$this->getWorld();
 5     }
 6     abstract public function getWorld();
 7 }
 8 
 9 class MyHelloWorld {
10     private $world;
11     use Hello;
12     public function getWorld() {
13         return $this->world;
14     }
15     public function setWorld($val) {
16         $this->world = $val;
17     }
18 }
19 ?>

Trait 的静态成员

Traits 可以被静态成员静态方法定义。

Example #9 静态变量

 1 <?php
 2 trait Counter {
 3     public function inc() {
 4         static $c = 0;
 5         $c = $c + 1;
 6         echo "$c\n";
 7     }
 8 }
 9 
10 class C1 {
11     use Counter;
12 }
13 
14 class C2 {
15     use Counter;
16 }
17 
18 $o = new C1(); $o->inc(); // echo 1
19 $p = new C2(); $p->inc(); // echo 1
20 ?>

Example #10 静态方法

 1 <?php
 2 trait StaticExample {
 3     public static function doSomething() {
 4         return 'Doing something';
 5     }
 6 }
 7 
 8 class Example {
 9     use StaticExample;
10 }
11 
12 Example::doSomething();
13 ?>

属性

Trait 同样可以定义属性。

Example #11 定义属性

 1 <?php
 2 trait PropertiesTrait {
 3     public $x = 1;
 4 }
 5 
 6 class PropertiesExample {
 7     use PropertiesTrait;
 8 }
 9 
10 $example = new PropertiesExample;
11 $example->x;
12 ?>

Trait 定义了一个属性后,类就不能定义同样名称的属性,否则会产生 fatal error。 有种情况例外:属性是兼容的(同样的访问可见度、初始默认值)。 在 PHP 7.0 之前,属性是兼容的,则会有 E_STRICT 的提醒。

Example #12 解决冲突

 1 <?php
 2 trait PropertiesTrait {
 3     public $same = true;
 4     public $different = false;
 5 }
 6 
 7 class PropertiesExample {
 8     use PropertiesTrait;
 9     public $same = true; // PHP 7.0.0 后没问题,之前版本是 E_STRICT 提醒
10     public $different = true; // 致命错误
11 }
12 ?>

原文地址:https://www.php.net/traits