欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Yii Framework框架中事件和行为的区别及应用实例分析

程序员文章站 2022-03-07 07:55:28
本文实例讲述了yii framework框架中事件和行为的区别及应用。分享给大家供大家参考,具体如下:个人觉得,在 yii 里面,最难以明白的就是事件(event)和行为(behavior)了。这不仅...

本文实例讲述了yii framework框架中事件和行为的区别及应用。分享给大家供大家参考,具体如下:

个人觉得,在 yii 里面,最难以明白的就是事件(event)和行为(behavior)了。这不仅仅是因为它们的概念

比较难明,关键是它们的应用场景比较难明,不知道什么时候应该使用事件和行为来开发。

关于 yii 的事件和行为的描述,可参考 http://www.yiiframework.com/doc/api/1.1/ccomponent

本文参考的文章:


事件

事件模型就是设计模式中的“观察者模式”:当对象的状态发生了变化,那么这个对象可以将该事件通知其它对象。
为了使用事件模型,需要实现这三个步骤:1、定义事件;2、注册事件句柄;3、触发事件。

为什么要做这三个步骤呢?因为对于 php 本身,它的执行过程不是以进程化来运行的,
所以 yii 的事件触发机制不会像 actionscript 3+ 那样,直接将触发事件。
有人说,yii 的事件概念跟 js 中的事件概念差不多,因为 yii 是将事件绑定到 yii::app() 的执行过程中。
由于本人对于 js 的事件没有做过深入的了解,这里不敢贸然否定,或者肯定。

费话少说,先看这样的应用场景:

我想在请求过来的时候,先将请求的 ip 的记录到数据库,然后才进行对应的相应的请求处理。

1. 通过编辑 components/controller.php 的构造方法来处理。

如代码:

class controller extends ccontroller
{
  public function __construct()
  {
    parent::__construct();
    //将请求的 ip 记录到数据库
  }
}

2. 通过使用事件来处理。

我们来分析一个 framework/base/capplication.php 的 run() 方法

public function run()
{
  if($this->haseventhandler('onbeginrequest'))
    $this->onbeginrequest(new cevent($this));
  $this->processrequest();
  if($this->haseventhandler('onendrequest'))
    $this->onendrequest(new cevent($this));
}

从代码可以看出来,在处理请求之前,yii 首先会判断一下当前有没有处理 onbeginrequest 的函数或者类的方法绑定了,

如果有这样的函数或者类的方法存在,则先执行了它们,然后再处理请求。

那么,怎样写 onbeginrequest,或者怎样去调用呢?

方法一:修改 index.php

一般来说,我们的 index.php 最后一句是:

yii::createwebapplication($config)->run();

我们在这里将它改造一下,改成:

$app = yii::createwebapplication($config);
yii::app()->onbeginrequest=function($event) {
  //将请求的 ip 记录到数据库
};
yii::app()->onbeginrequest=function($event) {
  //其它的你想要处理的内容,比如说,生成一个文件
  //file_put_contents('onbeginrequest.txt', '阿妈,我得左啦!');
};
$app->run();

方法二:在配置文件 main.php 里面注册事件

如:

/***************************************************
在我们想要的内容的前后出现了这些代码
只是为了说明,我们添加的内容是要放在
这个配置数据的一维里面。
'import'=>array(
  'application.models.*',
  'application.components.*',
  'application.helpers.*',
),
'defaultcontroller'=>'post',
***************************************************/

//其它代码
'import'=>array(
  'application.models.*',
  'application.components.*',
  'application.helpers.*',
),

/************** 这才是我们想要添加的代码 **************/
'onbeginrequest' => array('myeventhandler', 'myeventhandlermethod'),

'defaultcontroller'=>'post',
//其它代码

关于 onbeginrequest 的使用,它必须是一个有效的 php 回调。

即,一个指匿名函数,全局函数名的字符串或一个数组。如果是数组,那么该数组包含两个元素,第一个元素是一个对象,第二个元素是这个对象的方法。
由此可见,方法一和方法二还是有点区别的。使用方法二的时候,只能注册一个 php 回调,而使用方法一,可以是不同的 php 回调。当然,这里说的方法二
只能注册一个 php 回调是指,对整个请求处理过程中肯定会执行的 php 回调,在其它地方需要的时候,也可以加上你想实现的功能。

3. 另一个例子,来说明自己是怎样定义一个事件的。

打开 models/contactform.php,输入

/**
 * 自己定义发送邮件事件
 * @param unknown_type $event
 */
public function onsendmail($event)
{
  $this->raiseevent('onsendmail',$event);
}

/**
 * 验证成功,执行
 * @see cmodel::aftervalidate()
 */
public function aftervalidate() 
{
  if($this->haseventhandler('onsendmail'))
    $this->onsendmail(new cevent($this));
}

这里我们定义了一个 onsendmail 事件,并在 validate 验证后,触发此事件。

打开 controllers/sitecontroller.php,将修改actioncontact修改为以下内容

public function actioncontact()
{
  $model=new contactform;

  $model->onsendmail=function($event) {
    $headers="from: {$event->sender->email}\r\nreply-to: {$event->sender->email}";
    mail(yii::app()->params['adminemail'],$event->sender->subject,$event->sender->body,$headers);
  };

  if(isset($_post['contactform']))
  {
    $model->attributes=$_post['contactform'];
    if($model->validate())
    {

      yii::app()->user->setflash('contact','thank you for contacting us. we will respond to you as soon as possible.');
      $this->refresh();
    }
  }
  $this->render('contact',array('model'=>$model));
}

上面的 3 点,虽然通过绑定事件来做一些额外的处理,但同时已经暴露了一个问题,就是协同开发的时候,我不一定知道,

其他开发人员写了哪些事件的 php 回调,在处理过程中到底会调用哪些事件的 php 回调。或者说,这个 php 回调在什么时候创建的,

或者说你在为组件添加事件处理函数时,找不到合适的时候,如果添加早了,组件还没创建,如果添加晚了,事件不被执行,有可能组件已经执行完了。

我们需要一个类似于配置文件的东西,将存在的事件处理组织起来,统一管理。这个时候,行为可以用上了。

行为

这里先重新描述一下为什么要使用行为。

有两种办法可以对类添加特性:

1、直接修改这个类的代码,添加一些成员函数和成员变量;
2、派生,通过子类来扩展。

很明显第二种方法更加易维护、易扩展。但是如果需要对一个类添加多个特性(多人在不同时期),那么需要进行多级派生,这显然加大了维护成本。

在 yii 里面,通过行为类绑定,组件将一个或多个 cbehavior 类的成员方法和成员变量添加到自己身上,并且在不需要的时候载掉某些 cbehavior 类。

同时,可以通过重写 cbehavior::events 的方法,来实现对目标类的多个事件绑定。这些事件将会在当前行为绑定到目标类的时候,一起被绑定上。

下面我们以代码来具体看一下这个行为特性。

在 protected 创建目录 behaviors,并在protected/behaviors目录下创建applicationbehavior.php,输入如下代码:

<?php
class applicationbehavior extends cbehavior 
{

  public function events()
  {
    return array_merge(parent::events(),array(
        'onbeginrequest'=>'beginrequest'
    ));
  }

  public function beginrequest($event) 
  {
    echo "我已经将 onbeginrequest 的事件处理通过行为绑定了";
  }
}

此行为文件,是要为 capplication 服务,仔细查看这个行为文件,我们可以看到,events 方法定义了些行为可以处理的事件,

上面的类,可以处理 onbeginrequest 事件,当然如果你自己定义的组件也有一个叫做 onbeginrequest 方法,你也可以使用此行为

后面的 beginrequest 就是事件的处理函数,这个处理函数必须要有行为类中定义。

跟上面的事件一样,也有两种方法将此行为类附加到 capplication。

方法一:

打开 index.php,输入下面代码

$app = yii::createwebapplication($config);
yii::app()->onbeginrequest=function($event) {
  //将请求的 ip 记录到数据库
};
yii::app()->onbeginrequest=function($event) {
  //file_put_contents('onbeginrequest.txt', '阿妈,我又得左啦!');
};
/****** 这句才是我们想要的东东 *********/
$app->attachbehavior('app', 'application.behaviors.applicationbehavior');
$app->run();

刷新页面,你将会在头部看到一行 “我已经将 onbeginrequest 的事件处理通过行为绑定了”

方法二:

如果对 yii 的组件定义了解的话,应该知道每一个组件,都有一个behaviors方法,该方法中定义的相关行为,在组件初始化时,会自动附件,

下面我们就为 capplication 定义 behaviors,由于 capplication 是系统级类,我们可以扩展此类,并添加behaviors方法。这里补充一下,

capplication 是会根据 config/main.php 配置进行初始化,那么我们就可以将 behaviors 定义在 main.php。

打开 protected/config/main.php,加入如下代码:

'behaviors' => array(
  'app' => 'application.behaviors.applicationbehavior',
),

刷新页面,你也会在头部看到一行 “我已经将 onbeginrequest 的事件处理通过行为绑定了”

通过以上的例子,希望相关读者对 yii 的事件和行为有一定的了解。