php 5.4 全新的代码复用Trait详解

从php的5.4.0版本开始,php提供了一种全新的代码复用的概念,那就是trait。trait其字面意思是"特性"、"特点",我们可以理解为,使用trait关键字,可以为php中的类添加新的特性。

熟悉面向对象的都知道,软件开发中常用的代码复用有继承和多态两种方式。在php中,只能实现单继承。而trait则避免了这点。下面通过简单的额例子来进行对比说明。

1. 继承 vs 多态 vs trait

现在有publish.php和answer.php这两个类。要在其中添加log功能,记录类内部的动作。有以下几种方案:

1. 继承
2. 多态
3. trait

1.1. 继承

如图:

代码结构如下:

// log.php
<?php
class log
{
 public function startlog()
 {
  // echo ...
 }

 public function endlog()
 {
  // echo ...
 }
}

// publish.php
<?php
class publish extends log
{

}

// answer.php
<?php
class answer extends log
{

}

可以看到继承的确满足了要求。但这却违背了面向对象的原则。而发布(publish)和回答(answer)这样的操作和日志(log)之间的关系并不是子类与父类的关系。所以不推荐这样使用。

1.2. 多态

如图:

实现代码:

// log.php
<?php
interface log
{
 public function startlog();
 public function endlog();
}

// publish.php
<?php
class publish implements log
{
 public function startlog()
 {
  // todo: implement startlog() method.
 }
 public function endlog()
 {
  // todo: implement endlog() method.
 }
}

// answer.php
<?php
class answer implements log
{
 public function startlog()
 {
  // todo: implement startlog() method.
 }
 public function endlog()
 {
  // todo: implement endlog() method.
 }
}

记录日志的操作应该都是一样的,因此,发布(publish)和回答(answer)动作中的日志记录实现也是一样的。很明显,这违背了dry(don't repeat yourself)原则。所以是不推荐这样实现的。

1.3. trait

如图:

实现代码如下:

// log.php
<?php
trait log{
 public function startlog() {
  // echo ..
 }
 public function endlog() {
  // echo ..
 }
}

// publish.php
<?php
class publish {
 use log;
}
$publish = new publish();
$publish->startlog();
$publish->endlog();

// answer.php
<?php
class answer {
 use log;
}
$answer = new answer();
$answer->startlog();
$answer->endlog();

可以看到,我们在没有增加代码复杂的情况下,实现了代码的复用。

1.4. 结论

继承的方式虽然也能解决问题,但其思路违背了面向对象的原则,显得很粗暴;多态方式也可行,但不符合软件开发中的dry原则,增加了维护成本。而trait方式则避免了上述的不足之处,相对优雅的实现了代码的复用。

2. trait的作用域

了解了trait的好处,我们还需要了解其实现中的规则,先来说一下作用域。这个比较好证明,实现代码如下:

<?php
class publish {
 use log;
 public function dopublish() {
  $this->publicf();
  $this->protectf();
  $this->privatef();
 }
}
$publish = new publish();
$publish->dopublish();

执行上述代码输出结果如下:

public function
protected function
private function

可以发现,trait的作用域在引用该trait类的内部是都可见的。可以理解为use关键字将trait的实现代码copy了一份到引用该trait的类中。

3. trait中属性的优先级

说到优先级,就必须要有一个对比的参照物,这里的参照对象时引用trait的类及其父类。

通过以下的代码来证明trait应用中的属性的优先级:

<?php
trait log
{
 public function publicf()
 {
  echo __method__ . ' public function' . php_eol;
 }
 protected function protectf()
 {
  echo __method__ . ' protected function' . php_eol;
 }
}

class question
{
 public function publicf()
 {
  echo __method__ . ' public function' . php_eol;
 }
 protected function protectf()
 {
  echo __method__ . ' protected function' . php_eol;
 }
}

class publish extends question
{
 use log;

 public function publicf()
 {
  echo __method__ . ' public function' . php_eol;
 }
 public function dopublish()
 {
  $this->publicf();
  $this->protectf();
 }
}
$publish = new publish();
$publish->dopublish();

上述代码的输出结果如下:

publish::publicf public function
log::protectf protected function

通过上面的例子,可以总结出trait应用中的优先级如下:

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

trait 覆盖了被继承的方法

类成员优先级为:当前类>trait>父类

4. insteadof和as关键字

在一个类中,可以引用多个trait,如下:

<?php
trait log
{
 public function startlog()
 {
  echo __method__ . ' public function' . php_eol;
 }
 protected function endlog()
 {
  echo __method__ . ' protected function' . php_eol;
 }
}

trait check
{
 public function parametercheck($parameters) {
  // do sth
 }
}

class publish extends question
{
 use log,check;
 public function dopublish($para) {
  $this->startlog();
  $this->parametercheck($para);
  $this->endlog();
 }
}

通过上面的方式,我们可以在一个类中引用多个trait。引用多个trait的时候,就容易出问题了,最常见的问题就是两个trait中如果出现了同名的属性或者方法该怎么办呢?这个时候就需要用到insteadof 和 as 这两个关键字了.请看如下实现代码:

<?php

trait log
{
 public function parametercheck($parameters)
 {
  echo __method__ . ' parameter check' . $parameters . php_eol;
 }

 public function startlog()
 {
  echo __method__ . ' public function' . php_eol;
 }
}

trait check
{
 public function parametercheck($parameters)
 {
  echo __method__ . ' parameter check' . $parameters . php_eol;
 }

 public function startlog()
 {
  echo __method__ . ' public function' . php_eol;
 }
}

class publish
{
 use check, log {
  check::parametercheck insteadof log;
  log::startlog insteadof check;
  check::startlog as csl;
 }

 public function dopublish()
 {
  $this->startlog();
  $this->parametercheck('params');
  $this->csl();
 }
}

$publish = new publish();
$publish->dopublish();

执行上述代码,输出结果如下:

log::startlog public function
check::parametercheck parameter checkparams
check::startlog public function

就如字面意思一般,insteadof关键字用前者取代了后者,as 关键字给被取代的方法起了一个别名。

在引用trait时,使用了use关键字,use关键字也用来引用命名空间。两者的区别在于,引用trait时是在class内部使用的。