PHP实现代码复用的traits新特性的方法

在阅读yii2源码的时候接触到了trait,就学习了一下,写下博客记录一下。

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

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

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

Trait 示例,代码如下:

  1. <?php
  2. trait ezcReflectionReturnInfo {
  3. function getReturnType() { /*1*/ }
  4. function getReturnDescription() { /*2*/ }
  5. }
  6. class ezcReflectionMethod extends ReflectionMethod {
  7. use ezcReflectionReturnInfo;
  8. /* ... */
  9. }
  10. class ezcReflectionFunction extends ReflectionFunction {
  11. use ezcReflectionReturnInfo;
  12. /* ... */
  13. }
  14. ?>
优先级

从基类继承的成员被 trait 插入的成员所覆盖。优先顺序是来自当前类的成员覆盖了 trait 的方法,而 trait 则覆盖了被继承的方法。

优先顺序示例,代码如下:

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

以上例程会输出:Hello World!

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

另一个优先级顺序的例子,代码如下:

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

以上例程会输出:Hello Universe!

多个 trait

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

多个 trait 的用法的例子,代码如下:

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

以上例程会输出:Hello World!

冲突的解决

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

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

以上方式仅允许排除掉其它方法,as 操作符可以将其中一个冲突的方法以另一个名称来引入。

冲突解决的例子,代码如下:

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

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

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

修改方法的访问控制

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

修改方法的访问控制的例子,代码如下:

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

从 trait 来组成 trait

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

从 trait 来组成 trait的例子,代码如下:

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

以上例程会输出:Hello World!

Trait 的抽象成员

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

表示通过抽象方法来进行强制要求的例子,代码如下:

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

Trait 的静态成员

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

静态变量的例子,代码如下:

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

静态方法的例子,代码如下:

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

静态变量和静态方法的例子,代码如下:

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

属性

Trait 同样可以定义属性。

定义属性的例子,代码如下:

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

如果 trait 定义了一个属性,那类将不能定义同样名称的属性,否则会产生一个错误。如果该属性在类中的定义与在 trait 中的定义兼容(同样的可见性和初始值)则错误的级别是 E_STRICT,否则是一个致命错误。

冲突的例子,代码如下:

  1. <?php
  2. trait PropertiesTrait {
  3. public $same = true;
  4. public $different = false;
  5. }
  6. class PropertiesExample {
  7. use PropertiesTrait;
  8. public $same = true; // Strict Standards
  9. public $different = true; // 致命错误
  10. }
  11. ?>

Use的不同

不同use的例子,代码如下:

  1. <?php
  2. namespace Foo\Bar;
  3. use Foo\Test; // means \Foo\Test - the initial \ is optional
  4. ?>
  5. <?php
  6. namespace Foo\Bar;
  7. class SomeClass {
  8. use Foo\Test; // means \Foo\Bar\Foo\Test
  9. }
  10. ?>

第一个use是用于 namespace 的 use Foo\Test,找到的是 \Foo\Test,第二个 use 是使用一个trait,找到的是\Foo\Bar\Foo\Test。

__CLASS__和__TRAIT__

__CLASS__ 返回 use trait 的 class name,__TRAIT__返回 trait name

示例如下,代码如下:

  1. <?php
  2. trait TestTrait {
  3. public function testMethod() {
  4. echo "Class: " . __CLASS__ . PHP_EOL;
  5. echo "Trait: " . __TRAIT__ . PHP_EOL;
  6. }
  7. }
  8. class BaseClass {
  9. use TestTrait;
  10. }
  11. class TestClass extends BaseClass {
  12. }
  13. $t = new TestClass();
  14. $t->testMethod();
  15. //Class: BaseClass
  16. //Trait: TestTrait

Trait单例,实例如下:

  1. <?php
  2. trait singleton {
  3. /**
  4. * private construct, generally defined by using class
  5. */
  6. //private function __construct() {}
  7. public static function getInstance() {
  8. static $_instance = NULL;
  9. $class = __CLASS__;
  10. return $_instance ?: $_instance = new $class;
  11. }
  12. public function __clone() {
  13. trigger_error('Cloning '.__CLASS__.' is not allowed.',E_USER_ERROR);
  14. }
  15. public function __wakeup() {
  16. trigger_error('Unserializing '.__CLASS__.' is not allowed.',E_USER_ERROR);
  17. }
  18. }
  19. /**
  20. * Example Usage
  21. */
  22. class foo {
  23. use singleton;
  24. private function __construct() {
  25. $this->name = 'foo';
  26. }
  27. }
  28. class bar {
  29. use singleton;
  30. private function __construct() {
  31. $this->name = 'bar';
  32. }
  33. }
  34. $foo = foo::getInstance();
  35. echo $foo->name;
  36. $bar = bar::getInstance();
  37. echo $bar->name;

调用trait方法

虽然不很明显,但是如果Trait的方法可以被定义为在普通类的静态方法,就可以被调用,实例如下:

  1. <?php
  2. trait Foo {
  3. function bar() {
  4. return 'baz';
  5. }
  6. }
  7. echo Foo::bar(),"\\n";
  8. ?>