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

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

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

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

Trait 示例，代码如下：

1. <?php 
2.  
3. trait ezcReflectionReturnInfo { 
4.  
5.     function getReturnType() { /*1*/ } 
6.  
7.     function getReturnDescription() { /*2*/ } 
8.  
9. } 
10.  
11. class ezcReflectionMethod extends ReflectionMethod { 
12.  
13.     use ezcReflectionReturnInfo; 
14.  
15.     /* ... */ 
16.  
17. } 
18.  
19. class ezcReflectionFunction extends ReflectionFunction { 
20.  
21.     use ezcReflectionReturnInfo; 
22.  
23.     /* ... */ 
24.  
25. } 
26.  
27. ?> 

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

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

1. <?php 
2.  
3. class Base { 
4.  
5.     public function sayHello() { 
6.  
7.         echo 'Hello '; 
8.  
9.     } 
10.  
11. } 
12.  
13. trait SayWorld { 
14.  
15.     public function sayHello() { 
16.  
17.         parent::sayHello(); 
18.  
19.         echo 'World!'; 
20.  
21.     } 
22.  
23. } 
24.  
25. class MyHelloWorld extends Base { 
26.  
27.     use SayWorld; 
28.  
29. } 
30.  
31. $o = new MyHelloWorld(); 
32.  
33. $o->sayHello(); 
34.  
35. ?> 

以上例程会输出：Hello World!

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

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

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

以上例程会输出：Hello Universe!

多个 trait

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

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

1. <?php 
2.  
3. trait Hello { 
4.  
5.     public function sayHello() { 
6.  
7.         echo 'Hello '; 
8.  
9.     } 
10.  
11. } 
12.  
13. trait World { 
14.  
15.     public function sayWorld() { 
16.  
17.         echo 'World'; 
18.  
19.     } 
20.  
21. } 
22.  
23. class MyHelloWorld { 
24.  
25.     use Hello, World; 
26.  
27.     public function sayExclamationMark() { 
28.  
29.         echo '!'; 
30.  
31.     } 
32.  
33. } 
34.  
35. $o = new MyHelloWorld(); 
36.  
37. $o->sayHello(); 
38.  
39. $o->sayWorld(); 
40.  
41. $o->sayExclamationMark(); 
42.  
43. ?> 

以上例程会输出：Hello World!

冲突的解决

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

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

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

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

1. <?php 
2.  
3. trait A { 
4.  
5.     public function smallTalk() { 
6.  
7.         echo 'a'; 
8.  
9.     } 
10.  
11.     public function bigTalk() { 
12.  
13.         echo 'A'; 
14.  
15.     } 
16.  
17. } 
18.  
19. trait B { 
20.  
21.     public function smallTalk() { 
22.  
23.         echo 'b'; 
24.  
25.     } 
26.  
27.     public function bigTalk() { 
28.  
29.         echo 'B'; 
30.  
31.     } 
32.  
33. } 
34.  
35. class Talker { 
36.  
37.     use A, B { 
38.  
39.         B::smallTalk insteadof A; 
40.  
41.         A::bigTalk insteadof B; 
42.  
43.     } 
44.  
45. } 
46.  
47. class Aliased_Talker { 
48.  
49.     use A, B { 
50.  
51.         B::smallTalk insteadof A; 
52.  
53.         A::bigTalk insteadof B; 
54.  
55.         B::bigTalk as talk; 
56.  
57.     } 
58.  
59. } 
60.  
61. ?> 

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

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

修改方法的访问控制

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

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

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

从 trait 来组成 trait

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

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

1. <?php 
2.  
3. trait Hello { 
4.  
5.     public function sayHello() { 
6.  
7.         echo 'Hello '; 
8.  
9.     } 
10.  
11. } 
12.  
13. trait World { 
14.  
15.     public function sayWorld() { 
16.  
17.         echo 'World!'; 
18.  
19.     } 
20.  
21. } 
22.  
23. trait HelloWorld { 
24.  
25.     use Hello, World; 
26.  
27. } 
28.  
29. class MyHelloWorld { 
30.  
31.     use HelloWorld; 
32.  
33. } 
34.  
35. $o = new MyHelloWorld(); 
36.  
37. $o->sayHello(); 
38.  
39. $o->sayWorld(); 
40.  
41. ?> 

以上例程会输出：Hello World!

Trait 的抽象成员

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

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

1. <?php 
2.  
3. trait Hello { 
4.  
5.     public function sayHelloWorld() { 
6.  
7.         echo 'Hello'.$this->getWorld(); 
8.  
9.     } 
10.  
11.     abstract public function getWorld(); 
12.  
13. } 
14.  
15. class MyHelloWorld { 
16.  
17.     private $world; 
18.  
19.     use Hello; 
20.  
21.     public function getWorld() { 
22.  
23.         return $this->world; 
24.  
25.     } 
26.  
27.     public function setWorld($val) { 
28.  
29.         $this->world = $val; 
30.  
31.     } 
32.  
33. } 
34.  
35. ?> 

Trait 的静态成员

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

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

1. <?php 
2.  
3. trait Counter { 
4.  
5.     public function inc() { 
6.  
7.         static $c = 0; 
8.  
9.         $c = $c + 1; 
10.  
11.         echo "$c\n"; 
12.  
13.     } 
14.  
15. } 
16.  
17. class C1 { 
18.  
19.     use Counter; 
20.  
21. } 
22.  
23. class C2 { 
24.  
25.     use Counter; 
26.  
27. } 
28.  
29. $o = new C1(); $o->inc(); // echo 1 
30.  
31. $p = new C2(); $p->inc(); // echo 1 
32.  
33. ?> 

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

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

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

1. <?php 
2.  
3. trait Counter { 
4.  
5.     public static $c = 0; 
6.  
7.     public static function inc() { 
8.  
9.         self::$c = self::$c + 1; 
10.  
11.         echo self::$c . "\n"; 
12.  
13.     } 
14.  
15. } 
16.  
17. class C1 { 
18.  
19.     use Counter; 
20.  
21. } 
22.  
23. class C2 { 
24.  
25.     use Counter; 
26.  
27. } 
28.  
29. C1::inc(); // echo 1 
30.  
31. C2::inc(); // echo 1 
32.  
33. ?> 

属性

Trait 同样可以定义属性。

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

1. <?php 
2.  
3. trait PropertiesTrait { 
4.  
5.     public $x = 1; 
6.  
7. } 
8.  
9. class PropertiesExample { 
10.  
11.     use PropertiesTrait; 
12.  
13. } 
14.  
15. $example = new PropertiesExample; 
16.  
17. $example->x; 
18.  
19. ?> 

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

冲突的例子，代码如下:

1. <?php 
2.  
3. trait PropertiesTrait { 
4.  
5.     public $same = true; 
6.  
7.     public $different = false; 
8.  
9. } 
10.  
11. class PropertiesExample { 
12.  
13.     use PropertiesTrait; 
14.  
15.     public $same = true; // Strict Standards 
16.  
17.     public $different = true; // 致命错误 
18.  
19. } 
20.  
21. ?> 

Use的不同

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

1. <?php 
2.  
3. namespace Foo\Bar; 
4.  
5. use Foo\Test;  // means \Foo\Test - the initial \ is optional 
6.  
7. ?> 
8.  
9. <?php 
10.  
11. namespace Foo\Bar; 
12.  
13. class SomeClass { 
14.  
15.     use Foo\Test;   // means \Foo\Bar\Foo\Test 
16.  
17. } 
18.  
19. ?> 

第一个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.  
3. trait TestTrait { 
4.  
5.     public function testMethod() { 
6.  
7.         echo "Class: " . __CLASS__ . PHP_EOL; 
8.  
9.         echo "Trait: " . __TRAIT__ . PHP_EOL; 
10.  
11.     } 
12.  
13. } 
14.  
15. class BaseClass { 
16.  
17.     use TestTrait; 
18.  
19. } 
20.  
21. class TestClass extends BaseClass { 
22.  
23. } 
24.  
25. $t = new TestClass(); 
26.  
27. $t->testMethod(); 
28.  
29. //Class: BaseClass 
30.  
31. //Trait: TestTrait 

Trait单例，实例如下:

1. <?php 
2.  
3. trait singleton {     
4.  
5.     /** 
6.  
7.      * private construct, generally defined by using class 
8.  
9.      */ 
10.  
11.     //private function __construct() {} 
12.  
13.     public static function getInstance() { 
14.  
15.         static $_instance = NULL; 
16.  
17.         $class = __CLASS__; 
18.  
19.         return $_instance ?: $_instance = new $class; 
20.  
21.     } 
22.  
23.     public function __clone() { 
24.  
25.         trigger_error('Cloning '.__CLASS__.' is not allowed.',E_USER_ERROR); 
26.  
27.     } 
28.  
29.     public function __wakeup() { 
30.  
31.         trigger_error('Unserializing '.__CLASS__.' is not allowed.',E_USER_ERROR); 
32.  
33.     } 
34.  
35. } 
36.  
37. /** 
38.  
39. * Example Usage 
40.  
41. */ 
42.  
43. class foo { 
44.  
45.     use singleton; 
46.  
47.     private function __construct() { 
48.  
49.         $this->name = 'foo'; 
50.  
51.     } 
52.  
53. } 
54.  
55. class bar { 
56.  
57.     use singleton; 
58.  
59.     private function __construct() { 
60.  
61.         $this->name = 'bar'; 
62.  
63.     } 
64.  
65. } 
66.  
67. $foo = foo::getInstance(); 
68.  
69. echo $foo->name; 
70.  
71. $bar = bar::getInstance(); 
72.  
73. echo $bar->name; 

调用trait方法

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

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

Tags: PHP新特性 traits

分享到：