PHP Yii Framework_php 기술의 이벤트 메커니즘에 대한 심층 분석

이벤트
이벤트는 기존 코드의 특정 실행 지점에 사용자 정의 코드를 "주입"할 수 있습니다. 이벤트에 사용자 정의 코드를 첨부하면 이벤트가 트리거될 때 코드가 자동으로 실행됩니다. 예를 들어, 메일러 객체가 성공적으로 메시지를 보내면 messageSent 이벤트가 시작될 수 있습니다. 성공적으로 전송된 메시지를 추적하려면 해당 추적 코드를 messageSent 이벤트에 첨부하면 됩니다.
Yii는 이벤트를 지원하기 위해 yiibaseComponent라는 기본 클래스를 도입합니다. 클래스가 이벤트를 트리거해야 하는 경우 yiibaseComponent 또는 해당 하위 클래스를 상속해야 합니다.

Yii의 이벤트 메커니즘
YII의 이벤트 메커니즘은 고유한 기능입니다. 이벤트 메커니즘을 적절하게 사용하면 구성 요소 간의 연결이 느슨해져 팀 협업과 개발에 도움이 됩니다.
이벤트를 사용해야 할 때 이벤트 처리 기능을 이벤트에 바인딩하는 방법, 이벤트를 트리거하는 방법은 다른 언어와 상당히 다릅니다. 예를 들어 Javascript에서는
을 사용할 수 있습니다.

$(‘#id').on("click",function() {});

메서드는 처리 기능을 DOM 요소에 바인딩합니다. DOM 요소에서 지정된 이벤트(예: 클릭)가 발생하면 설정된 기능이 자동으로 실행됩니다.
그러나 PHP는 서버 측 스크립팅 언어이므로 자동으로 이벤트를 트리거할 수 없습니다. 따라서 Javascript와 비교하여 YII의 이벤트는 수동으로 트리거해야 합니다. 일반적으로 YII 구성 요소의 이벤트 메커니즘을 구현하려면 다음 단계가 필요합니다.

이벤트 이름을 정의하세요. 실제로 레벨 구성 요소는 on으로 시작하는 메서드를 정의하며, 그 안의 코드는 다음과 같이 고정되어 있습니다.

 public function onBeginRequest($event){
 $this->raiseEvent('onBeginRequest',$event);
}

즉, 함수명과 이벤트명이 일치합니다. 이 단계의 기능은 이 이벤트에 바인딩된 처리 기능을 하나씩 실행하는 것입니다. 이 팟캐스트 시리즈를 작성하는 것은 일종의 정리로 간주되므로 좀 더 자세히 작성하고 이제 raiseEvent 메서드의 코드를 게시하겠습니다.

/** * Raises an event. 
  * This method represents the happening of an event. It invokes 
  * all attached handlers for the event. 
  * @param string $name the event name 
  * @param CEvent $event the event parameter 
  * @throws CException if the event is undefined or an event handler is invalid. 
*/

  public function raiseEvent($name,$event){  
       $name=strtolower($name);  
       //_e这个数组用来存所有事件信息
       if(isset($this->_e[$name]))  {   
          foreach($this->_e[$name] as $handler) {     
            if(is_string($handler)) 
              call_user_func($handler,$event);       
            elseif(is_callable($handler,true)){ 
                 if(is_array($handler)){        
                   // an array: 0 - object, 1 - method name  
                   list($object,$method)=$handler;   
                   if(is_string($object)) // static method call 
                    call_user_func($handler,$event); 
                   elseif(method_exists($object,$method))     
                     $object->$method($event);        
                   else         
                     throw new CException(Yii::t('yii','Event "{class}.{event}" is attached with an invalid handler "{handler}".',  array('{class}'=>get_class($this), '{event}'=>$name, '{handler}'=>$handler[1])));      
                  }      
                  else // PHP 5.3: anonymous function 
                     call_user_func($handler,$event);     
            }     
            else      
              throw new CException(Yii::t('yii','Event "{class}.{event}" is attached with an invalid handler "{handler}".', array('{class}'=>get_class($this), '{event}'=>$name, '{handler}'=>gettype($handler))));     
           // stop further handling if param.handled is set true 
            if(($event instanceof CEvent) && $event->handled) 
              return;   
          } 
        }  elseif(YII_DEBUG && !$this->hasEvent($name))   
          throw new CException(Yii::t('yii','Event "{class}.{event}" is not defined.',     array('{class}'=>get_class($this), '{event}'=>$name)));
 }

이벤트 핸들러

이벤트 핸들러는 연결된 이벤트가 트리거될 때 실행되는 PHP 콜백 함수입니다. 다음 콜백 함수 중 하나를 사용할 수 있습니다:

• 'trim'과 같이 문자열 형식으로 지정된 PHP 전역 함수;
• [$object, $method]와 같이 객체 이름과 메소드 이름의 배열 형식으로 지정된 객체 메소드
• [$class, $method]와 같이 클래스 이름과 메소드 이름의 배열 형식으로 지정된 정적 클래스 메소드;
• function ($event) { ... } 와 같은 익명 함수.

이벤트 핸들러의 형식은 다음과 같습니다.

function ($event) {
  // $event 是 yii\base\Event 或其子类的对象
}

$event 매개변수를 통해 이벤트 핸들러는 이벤트에 대해 다음 정보를 얻습니다.

• yiibaseEvent::name: 이벤트 이름
• yiibaseEvent::sender: Trigger() 메소드를 호출하는 객체
• yiibaseEvent::data: 이벤트 핸들러를 연결할 때 전달되는 데이터, 기본값은 비어 있으며 아래에 자세히 설명되어 있습니다

부속된 이벤트 핸들러

yiibaseComponent::on() 메서드를 호출하여 이벤트에 핸들러를 연결합니다. 예:

$foo = new Foo;

// 处理器是全局函数
$foo->on(Foo::EVENT_HELLO, 'function_name');

// 处理器是对象方法
$foo->on(Foo::EVENT_HELLO, [$object, 'methodName']);

// 处理器是静态类方法
$foo->on(Foo::EVENT_HELLO, ['app\components\Bar', 'methodName']);

// 处理器是匿名函数
$foo->on(Foo::EVENT_HELLO, function ($event) {
  //事件处理逻辑
});
附加事件处理器时可以提供额外数据作为 yii\base\Component::on() 方法的第三个参数。数据在事件被触发和处理器被调用时能被处理器使用。如：

// 当事件被触发时以下代码显示 "abc"
// 因为 $event->data 包括被传递到 "on" 方法的数据
$foo->on(Foo::EVENT_HELLO, function ($event) {
  echo $event->data;
}, 'abc');

이벤트 핸들러 순서

하나 이상의 핸들러를 이벤트에 연결할 수 있습니다. 이벤트가 트리거되면 연결된 핸들러가 연결된 순서대로 호출됩니다. 프로세서가 후속 프로세서 호출을 중지해야 하는 경우 다음과 같이 $event 매개변수의 [yiibaseEvent::handled]] 속성을 true로 설정할 수 있습니다.

$foo->on(Foo::EVENT_HELLO, function ($event) {
  $event->handled = true;
});

기본적으로 새로 연결된 이벤트 핸들러는 기존 핸들러 큐의 끝에 배치됩니다. 따라서 이 핸들러는 이벤트가 트리거될 때 마지막으로 호출됩니다. 프로세서 대기열 앞에 새 프로세서를 삽입하면 프로세서가 먼저 호출됩니다. 네 번째 매개변수 $append를 false로 전달하고 yiibaseComponent::on() 메서드를 호출하면 됩니다.

$foo->on(Foo::EVENT_HELLO, function ($event) {
  // 这个处理器将被插入到处理器队列的第一位...
}, $data, false);

이벤트 발생

이벤트는 yiibaseComponent::trigger() 메소드를 호출하여 트리거됩니다. 이 메소드는 이벤트 핸들러에 매개변수를 전달하기 위해 이벤트 이름과 이벤트 객체를 전달해야 합니다. 예:

namespace app\components;

use yii\base\Component;
use yii\base\Event;

class Foo extends Component
{
  const EVENT_HELLO = 'hello';

  public function bar()
  {
    $this->trigger(self::EVENT_HELLO);
  }
}

위 코드가 bar()를 호출하면 hello라는 이벤트가 트리거됩니다.

팁: 이벤트 이름을 나타내려면 클래스 상수를 사용하는 것이 좋습니다. 위의 예에서 EVENT_HELLO 상수는 안녕하세요를 나타내는 데 사용됩니다. 여기에는 두 가지 이점이 있습니다. 첫째, 오타를 방지하고 IDE 자동 완성을 지원합니다. 둘째, 상수 선언을 검사하여 클래스가 어떤 이벤트를 지원하는지 알아볼 수 있습니다.
이벤트가 트리거될 때 이벤트 핸들러에 몇 가지 추가 정보를 전달하려는 경우가 있습니다. 예를 들어, 메일 프로그램은 messageSent 이벤트 핸들러에 메시지 정보를 전달하여 핸들러가 어떤 메시지가 전송되었는지 알 수 있도록 해야 합니다. 이를 위해 yiibaseComponent::trigger() 메소드의 두 번째 매개변수로 이벤트 객체를 제공할 수 있습니다. 이 이벤트 객체는 yiibaseEvent 클래스 또는 해당 하위 클래스의 인스턴스여야 합니다. 예:

namespace app\components;

use yii\base\Component;
use yii\base\Event;

class MessageEvent extends Event
{
  public $message;
}

class Mailer extends Component
{
  const EVENT_MESSAGE_SENT = 'messageSent';

  public function send($message)
  {
    // ...发送 $message 的逻辑...

    $event = new MessageEvent;
    $event->message = $message;
    $this->trigger(self::EVENT_MESSAGE_SENT, $event);
  }
}

yiibaseComponent::trigger() 메서드가 호출되면 명명된 이벤트(트리거 메서드의 첫 번째 매개변수)에 연결된 모든 이벤트 핸들러가 호출됩니다.

이벤트 핸들러 제거

이벤트에서 핸들러를 제거하려면 yiibaseComponent::off() 메서드를 호출하세요. 예:

// 处理器是全局函数
$foo->off(Foo::EVENT_HELLO, 'function_name');

// 处理器是对象方法
$foo->off(Foo::EVENT_HELLO, [$object, 'methodName']);

// 处理器是静态类方法
$foo->off(Foo::EVENT_HELLO, ['app\components\Bar', 'methodName']);

// 处理器是匿名函数
$foo->off(Foo::EVENT_HELLO, $anonymousFunction);

注意当匿名函数附加到事件后一般不要尝试移除匿名函数，除非你在某处存储了它。以上示例中，假设匿名函数存储为变量$anonymousFunction 。

移除事件的全部处理器，简单调用 yii\base\Component::off() 即可，不需要第二个参数：

$foo->off(Foo::EVENT_HELLO);

类级别的事件处理器

以上部分，我们叙述了在实例级别如何附加处理器到事件。有时想要一个类的所有实例而不是一个指定的实例都响应一个被触发的事件，并不是一个个附加事件处理器到每个实例，而是通过调用静态方法 yii\base\Event::on() 在类级别附加处理器。

例如，活动记录对象要在每次往数据库新增一条新记录时触发一个 yii\db\BaseActiveRecord::EVENT_AFTER_INSERT 事件。要追踪每个活动记录对象的新增记录完成情况，应如下写代码：

use Yii;
use yii\base\Event;
use yii\db\ActiveRecord;

Event::on(ActiveRecord::className(), ActiveRecord::EVENT_AFTER_INSERT, function ($event) {
  Yii::trace(get_class($event->sender) . ' is inserted');
});

每当 yii\db\BaseActiveRecord 或其子类的实例触发 yii\db\BaseActiveRecord::EVENT_AFTER_INSERT 事件时，这个事件处理器都会执行。在这个处理器中，可以通过 $event->sender 获取触发事件的对象。

当对象触发事件时，它首先调用实例级别的处理器，然后才会调用类级别处理器。

可调用静态方法yii\base\Event::trigger()来触发一个类级别事件。类级别事件不与特定对象相关联。因此，它只会引起类级别事件处理器的调用。如：

use yii\base\Event;

Event::on(Foo::className(), Foo::EVENT_HELLO, function ($event) {
  echo $event->sender; // 显示 "app\models\Foo"
});

Event::trigger(Foo::className(), Foo::EVENT_HELLO);

注意这种情况下 $event->sender 指向触发事件的类名而不是对象实例。

注意：因为类级别的处理器响应类和其子类的所有实例触发的事件，必须谨慎使用，尤其是底层的基类，如 yii\base\Object。
移除类级别的事件处理器只需调用yii\base\Event::off()，如：

// 移除 $handler
Event::off(Foo::className(), Foo::EVENT_HELLO, $handler);

// 移除 Foo::EVENT_HELLO 事件的全部处理器
Event::off(Foo::className(), Foo::EVENT_HELLO);

全局事件

所谓全局事件实际上是一个基于以上叙述的事件机制的戏法。它需要一个全局可访问的单例，如应用实例。

事件触发者不调用其自身的 trigger() 方法，而是调用单例的 trigger() 方法来触发全局事件。类似地，事件处理器被附加到单例的事件。如：

use Yii;
use yii\base\Event;
use app\components\Foo;

Yii::$app->on('bar', function ($event) {
  echo get_class($event->sender); // 显示 "app\components\Foo"
});

Yii::$app->trigger('bar', new Event(['sender' => new Foo]));

全局事件的一个好处是当附加处理器到一个对象要触发的事件时，不需要产生该对象。相反，处理器附加和事件触发都通过单例（如应用实例）完成。

然而，因为全局事件的命名空间由各方共享，应合理命名全局事件，如引入一些命名空间（例："frontend.mail.sent", "backend.mail.sent"）。

给组件对象绑定事件处理函数

$component->attachEventHandler($name, $handler);
$component->onBeginRequest = $handler ;

yii支持一个事件绑定多个回调函数，上述的两个方法都会在已有的事件上增加新的回调函数，而不会覆盖已有回调函数。
$handler即是一个PHP回调函数，关于回调函数的形式，本文的最后会附带说明。如CLogRouter组件的init事件中，有以下代码：

Yii::app()->attachEventHandler('onEndRequest',array($this,'processLogs'));

这就是给CApplication对象的onEndRequest绑定了CLogRouter::processLogs()回调函数。而CApplication组件确实存在名为onEndRequest的方法（即onEndRequest事件）,它之中的代码就是激活了相应的回调函数，即CLogRouter::processLogs()方法。所以从这里可以得出，日志的记录其实是发生在CApplication组件的正常退出时。

在需要触发事件的时候，直接激活组件的事件，即调用事件即可，如：比如CApplication组件的run方法中：

if($this->hasEventHandler('onBeginRequest'))
  $this->onBeginRequest(new CEvent($this));

这样即触发了事件处理函数。如果没有第一行的判断，那么在调试模式下（YII_DEBUG常量被定义为true），会抛出异常，而在非调试模式下（YII_DEBUG常量定义为false或没有定义YII_DEBUG常量），则不会产生任何异常。
回调函数的形式：

普通全局函数（内置的或用户自定义的）

call_user_func(‘print', $str);

类的静态方法，使用数组形式传递

call_user_func(array(‘className', ‘print'), $str );

对象方法，使用数组形式传递

$obj = new className();
call_user_func(array($obj, ‘print'), $str );

匿名方法，类似javascript的匿名函数

call_user_func(function($i){echo $i++;},4);

或使用以下形式：

$s = function($i) {
  echo $i++;
};
call_user_func($s,4);

总结

关于Yii的事件机制其实就是提供了一种用于解耦的方式，在需要调用event的地方之前，只要你提供了事件的实现并注册在之后的地方需要的时候即可调用。