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 'hello ';
    }
}
trait sayworld {
    public function sayhello() {
        parent::sayhello();
        echo 'world!';
    }
}
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 'hello world!';
    }
}
class theworldisnotenough {
    use helloworld;
    public function sayhello() {
        echo 'hello universe!';
    }
}
$o = new theworldisnotenough();
$o->sayhello();
?>

以上例程会输出：hello universe!

多个 trait

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

多个 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 操作符可以将其中一个冲突的方法以另一个名称来引入。

冲突解决的例子

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

在本例中 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 'hello world!';
    }
}
// 修改 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 '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();
?>

静态变量和静态方法的例子

<?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('cloning '.__class__.' is not allowed.',e_user_error);
    }
    public function __wakeup() {
        trigger_error('unserializing '.__class__.' is not allowed.',e_user_error);
    }
}
/**
* example usage
*/
class foo {
    use singleton;
    private function __construct() {
        $this->name = 'foo';
    }
}
class bar {
    use singleton;
    private function __construct() {
        $this->name = 'bar';
    }
}
$foo = foo::getinstance();
echo $foo->name;
$bar = bar::getinstance();
echo $bar->name;

调用trait方法

虽然不很明显，但是如果trait的方法可以被定义为在普通类的静态方法，就可以被调用

实例如下

<?php
trait foo {
    function bar() {
        return 'baz';
    }
}
echo foo::bar(),"\\n";
?>

小伙伴们对于traits的新特性是否熟悉了呢，希望本文能对大家有所帮助。