Yii2之事件

Posted 2020-10-06 编程人，在天涯

　　众所周知，yii的三大特性是：属性、事件、行为，上一篇博文简单讲解了yii中的属性，本文接着讲讲yii的事件。

　　事件是代码解耦的一种方式，设计业务流程的一种模式。在yii2.0中，通过Yii\base\Component继承yii\base\Object，

重载__get()、__set()方法，引入了事件和行为，使得开发变得十分方便。然而，在方便开发的同时也牺牲了一定的效率，

所以若不需要使用事件和行为，可不必继承Component而选择继承Object，Object的效率更接近原生的php类。

　　首先说说yii事件的使用，由于Yii\base\Component类已经实现了事件，所以只要某个类继承了Component类，它的对象

就可以调用on()方法来绑定事件，然后在需要的地方调用trigger()方法触发指定事件。下面举一个简单的例子来说明。

　　例如，在博客系统中，博文数据表中有created_at（发表时间）和updated_at（更新时间）两个字段，现在我想通过事

件来在更新数据表之前给这两个字段赋值。我们知道，yii的AR模型在数据表插入或更新数据之前会调用beforeSave()方法，

现在就在博文AR模型中重写这个方法去绑定并触发事件给这两个字段赋值，代码如下：

public function beforeSave($insert) {
	if(parent::beforeSave($insert)) {
		$this->on(‘haha‘, [$this, ‘setTime‘], $insert);
		$this->trigger(‘haha‘);
		return true;
	}
	return false;
}

（这个例子中，事件的绑定和触发在同一个地方进行）

　　以上代码将[$this, ‘setTime’]这个处理器绑定在名为’haha’的事件上，这个处理器其实就是博文AR模型的setTime()方法，

第三个参数表示是否插入数据，将会在事件触发的时候传递给setTime()方法。setTime()方法代码如下：

public function setTime($event) {
	if($event->data) {
		$this->uid = User::getUid();
		$this->created_at = time();
	}
	$this->updated_at = time();
}

其中$event->data就是on()函数的第三个参数了。setTime方法的参数$event在yii中是yii\base\Event类的对象，若在事件

触发之时需要传递一些参数给处理器函数，可以写一个子类继承yii\base\Event类，设置一些成员变量，然后创建该类的

一个对象，把需要传递的参数赋值给这个对象的成员变量，接着把这个对象赋值给事件触发方法trigger()的第二个参数，

在处理器函数中就可以接收到这些参数值了。

　　没错，在yii中使用事件就是这么简单！可以看到，其实事件的本质就是把一段代码抽出来单独写成一个方法，然后把

它绑定在某个事件上，最后在需要调用这个方法的地方触发这个事件就ok了。个人理解，设计事件主要是为了代码解耦与

重用吧。

　　Yii的事件到底是怎么实现的呢？说到底其实就是一个数组和三个方法就能搞定的事情，且听我细细道来。首先，使用

一个数组（下文称为事件队列）来保存所有的事件，数组的键为各个事件名称，数组的元素值则是各个事件触发时需要调

用的函数以及需要传递给函数的参数（下文称为事件处理器），可以有一个或多个，所以也是使用数组来存储，下文称为

处理器队列，一个事件对应一个处理器队列。为一个事件绑定一个事件处理器则是在事件队列中找到这个事件对应的处理

器队列并添加一个处理器，把一个处理器从某个事件解绑则是在事件队列中找到这个事件指定的处理器并从它的处理器队

列中删除，触发一个事件则是在事件队列中找到这个事件然后按顺序调用它对应的处理器队列中的所有处理器。

　　下面让我们从Yii\base\Component类的源码来看看具体的实现细节，我根据自己的理解在代码适当位置中加上了一些注释：

/**
 *
 * @var 存储事件列表的数组，形式：事件名称 => 对应的事件处理器列表
 */
private $_events = [];

/**
 * 为某个事件绑定一个事件处理器
 * @param $name：事件名称，字符串形式
 * @param $handler：事件处理器，指定事件触发时调用的函数，有4种形式：
 *                  1.全局php函数名，字符串形式
 *                  2.[类名, 方法名]，数组形式
 *                  3.[对象, 方法名]，数组形式
 *                  4.匿名函数，形式：function($event){ ... }
 * @param $data：事件触发时传递给事件处理器函数的参数，在事件处理器函数调用形式：$event->data
 * @param $append：为true时表示将绑定的事件处理器添加在事件处理器列表的最后，为false则添加在最前面
 */
public function on($name, $handler, $data = null, $append = true)
{
	$this->ensureBehaviors();
	if ($append || empty($this->_events[$name])) {//添加到列表后面
		$this->_events[$name][] = [$handler, $data];
	} else {//添加到列表前面
		array_unshift($this->_events[$name], [$handler, $data]);
	}
}

/**
 * 解绑事件处理器
 * @param $name：事件名称
 * @param $handler：要解绑的事件处理器，为null表示解绑这个事件的所有处理器，即删除整个事件
 * @return boolean
 */
public function off($name, $handler = null)
{
	$this->ensureBehaviors();
	if (empty($this->_events[$name])) {//事件不存在
		return false;
	}
	if ($handler === null) {//删除事件
		unset($this->_events[$name]);
		return true;
	}

	$removed = false;
	foreach ($this->_events[$name] as $i => $event) {
		if ($event[0] === $handler) {
			unset($this->_events[$name][$i]);//删除指定的事件处理器
			$removed = true;
		}
	}
	if ($removed) {
		$this->_events[$name] = array_values($this->_events[$name]);
	}
	return $removed;
}

/**
 * 触发一个事件
 * @param $name：事件名称
 * @param $event：\yii\base\Event类对象，作为传递给事件处理器的参数
 * @return type
 */
public function trigger($name, Event $event = null)
{
	$this->ensureBehaviors();
	if (!empty($this->_events[$name])) {
		if ($event === null) {//没有$event参数则创建一个默认对象
			$event = new Event;
		}
		if ($event->sender === null) {//指定触发事件的对象
			$event->sender = $this;
		}
		$event->handled = false;//事件是否处理完毕
		$event->name = $name;//事件名称
		foreach ($this->_events[$name] as $handler) {//遍历事件对应的处理器，逐个调用
			$event->data = $handler[1];//这里把on()方法绑定事件处理器时传递的$data参数传递给事件处理器
			call_user_func($handler[0], $event);//调用事件处理器方法
			if ($event->handled) {//若在某个事件处理器中将$event->handled置为true，表示事件处理完毕，后面的处理器不再被调用
				return;
			}
		}
	}
	//触发类级别事件
	Event::trigger($this, $name, $event);
}

　　理解了事件的实现原理之后，我们就会发现，其实我们自己也可以实现事件的！

 

 

 额，说了这么多也不知道说清楚了没有，反正我自己觉得挺清楚的，哈哈。。。