PHP中的Trait

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

class Base {
    public function sayHello() {
        echo '=== Base  sayHello()  data ===;  ' . PHP_EOL;
    }
}

// trait
trait SayWorld {
    public function sayHello() {
        parent::sayHello();
        echo 'trait - sayHello() - data ...;' . PHP_EOL;
    }

}

class MyHelloWorld extends Base {
    use SayWorld;
}

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

#打印结果：

=== Base sayHello() data ===;
trait - sayHello() - data ...;

trait 则覆盖了被继承的方法

# ---------------------------------------------------------------------------------------------------

// 基类
class Base {
    public function sayHello() {
        echo '=== Base  sayHello()  data ===;  ' . PHP_EOL;
    }
}

// trait
trait SayWorld {
    public function sayHello() {
        echo 'trait - sayHello() - data ...;' . PHP_EOL;
    }
}

class MyHelloWorld extends Base {
    use SayWorld;

    public function sayHello() {
        echo 'my - say Hello!' . PHP_EOL;
    }
}

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

# 打印结果：
my - say Hello!

当前类的成员覆盖了 trait 的方法;

Example #2 优先顺序示例

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

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

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

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

Example #4 多个 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 操作符不会对方法进行重命名，也不会影响其方法。

Example #5 冲突的解决

在本例中 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 Aliased_Talker
{
    use A, B {
        B::smallTalk insteadof A;
        A::bigTalk insteadof B;
        B::bigTalk as talk;
    }
}

$obj = new Aliased_Talker();
$obj->bigTalk();
$obj->smallTalk();

打印输出：Ab


# 修改方法的访问控制

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

Example #6 修改方法的访问控制<?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; }
}

echo "------------------------------" . PHP_EOL;

$obj2 = new MyClass2();
$obj2->sayHello();



# 从 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 支持抽象方法的使用。 支持 public 、protected 和 private 方法。PHP 8.0.0 之前， 仅支持 public 和 protected 抽象方法。    

<?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()
    {
        echo 'Doing something';
    }
}

class Example
{
    use StaticExample;
}

Example::doSomething(); // Doing something

Example #11 静态属性

<?php


trait StaticExample
{
    public static $static = 'foo-2023';
}

class Example
{
    use StaticExample;
}

echo Example::$static; // foo-2023


# Trait 同样可以定义属性

<?php

trait PropertiesTrait
{
    public $x = 1;  // 定义属性
}

class PropertiesExample
{
    use PropertiesTrait;
}

$example = new PropertiesExample;
echo $example->x; // 1

# Trait 定义了一个属性后，类就不能定义同样名称的属性，否则会产生 fatal error。 有种情况例外：属性是兼容的（同样的访问可见度、初始默认值）。    

<?php

trait PropertiesTrait
{
    public $same = true;
    public $different = 'false';
}

class PropertiesExample
{
    use PropertiesTrait;

    public $same = true;
    // public $different = true; // 致命错误
}

$obj = new PropertiesExample();
echo $obj->same; // 1
echo $obj->different; // false