1.钩子是什么 ?
钩子实际上是一个处理消息的程序段,通过系统调用,把它挂入系统。每当特定的消息发出,在没有到达目的窗口前,钩子程序就先捕获该消息,亦即钩子函数先得到控制权。这时钩子函数即可以加工处理(改变)该消息,也可以不作处理而继续传递该消息,还可以强制结束消息的传递。
上面是百度百科对钩子的定义。
从这段话可以看出,钩子是事件驱动模式。
2. CI中钩子的使用
上面我们说到钩子是事件驱动模式,既然是事件驱动,那么必然包含以下几个步骤:
(1)定义一个事件处理程序
(2)注册事件
(3)触发事件
那么回想一下CI的钩子是如何使用的。
(1)定义一个钩子,相当于定义一个事件处理程序,CI中自定义的钩子都在config/hooks.php的配置文件中,那么CI是如何将这些钩子加载的?之后再分析。
$hook['pre_controller'] = array(
'class' => 'MyClass',
'function' => 'Myfunction',
'filename' => 'Myclass.php',
'filepath' => 'hooks',
'params' => array('beer', 'wine', 'snacks')
);
(2)CI提供了以下挂钩点,相当于注册事件,这一步是CI系统做好了的,不需要开发者自己注册。
- pre_system 在系统执行的早期调用,这个时候只有 基准测试类 和 钩子类 被加载了, 还没有执行到路由或其他的流程
- pre_controller 在你的控制器调用之前执行,所有的基础类都已加载,路由和安全检查也已经完成。
- post_controller_constructor 在你的控制器实例化之后立即执行,控制器的任何方法都还尚未调用。
- post_controller 在你的控制器完全运行结束时执行。
- display_override 覆盖 _display() 方法,该方法用于在系统执行结束时向浏览器发送最终的页面结果。 这可以让你有自己的显示页面的方法。
- cache_override 使用你自己的方法来替代 输出类 中的 _display_cache() 方法,这让你有自己的缓存显示机制。
- post_system 在最终的页面发送到浏览器之后、在系统的最后期被调用。
(3)第三步,触发事件,这一步是在hooks.php中发生的。
3.Hooks的实现
class CI_Hooks {
//是否启用钩子的标记
public $enabled = FALSE;
//存储config/hooks.php中定义的所有钩子
public $hooks = array();
//保存所有实例化过的钩子
protected $_objects = array();
//防止钩子互相调用造成死锁的标记
protected $_in_progress = FALSE;
//构造函数,主要是初始化hooks组件
public function __construct()
{
$CFG =& load_class('Config', 'core');
log_message('info', 'Hooks Class Initialized');
//如果钩子未启用,直接返回
if ($CFG->item('enable_hooks') === FALSE)
{
return;
}
//config/hooks.php文件存在引入配置文件
if (file_exists(APPPATH.'config/hooks.php'))
{
include(APPPATH.'config/hooks.php');
}
//引入生产环境配置文件
if (file_exists(APPPATH.'config/'.ENVIRONMENT.'/hooks.php'))
{
include(APPPATH.'config/'.ENVIRONMENT.'/hooks.php');
}
//没有定义的钩子,返回
if ( ! isset($hook) OR ! is_array($hook))
{
return;
}
//使hooks指向$hook(保存所有预定义的钩子的数组)
$this->hooks =& $hook;
//启用钩子
$this->enabled = TRUE;
}
//调用一个特定的钩子,外部调用的就是这个方法
public function call_hook($which = '')
{
//钩子没有启用,或者调用的钩子不村子,返回FALSE
if ( ! $this->enabled OR ! isset($this->hooks[$which]))
{
return FALSE;
}
//预定义的钩子是一个数组且未设置function参数,即是说这个挂钩点添加了多个脚本。
if (is_array($this->hooks[$which]) &&
! isset($this->hooks[$which]['function']))
{
foreach ($this->hooks[$which] as $val)
{
$this->_run_hook($val);
}
}
else
{
//这个挂钩点只有一个钩子直接运行钩子
$this->_run_hook($this->hooks[$which]);
}
//执行成功,返回TRUE
return TRUE;
}
//运行指定的钩子
protected function _run_hook($data)
{
//是否可以直接调用
if (is_callable($data))
{
//可以直接调用的函数,就直接调用
is_array($data)
? $data[0]->{$data[1]}()
: $data();
return TRUE;
}
elseif ( ! is_array($data))
{
//不可以直接调用又不是数组,返回FALSE
return FALSE;
}
//此函数正在被调用,直接返回,防止死锁
if ($this->_in_progress === TRUE)
{
return;
}
//没有设置文件路径和文件名称,返回FALSE
if ( ! isset($data['filepath'], $data['filename']))
{
return FALSE;
}
//拼接出完整的文件路径,这里可以看出系统钩子要放在APPPATH这个路径下。
$filepath = APPPATH.$data['filepath'].'/'.$data['filename'];
//文件不存在,返回FALSE
if ( ! file_exists($filepath))
{
return FALSE;
}
//将类名,函数名,参数名分别保存到变量中。
$class = empty($data['class']) ? FALSE : $data['class'];
$function = empty($data['function']) ? FALSE : $data['function'];
$params = isset($data['params']) ? $data['params'] : '';
//方法名为空,返回FALSE
if (empty($function))
{
return FALSE;
}
//将正在调用钩子的标记改为TRUE
$this->_in_progress = TRUE;
// 调用类和函数
if ($class !== FALSE)
{
//调用的类如果已经实例化
if (isset($this->_objects[$class]))
{
//函数是否可调用
if (method_exists($this->_objects[$class], $function))
{
//调用钩子
$this->_objects[$class]->$function($params);
}
else
{
//函数不可以调用,正在调用钩子标记改为FALSE,返回FALSE
return $this->_in_progress = FALSE;
}
}
else
{
//该类尚未进行实例化,引入该文件
class_exists($class, FALSE) OR require_once($filepath);
//类或者方法不可以调用,_in_progress标记改成FALSE,返回FALSE
if ( ! class_exists($class, FALSE) OR
! method_exists($class, $function))
{
return $this->_in_progress = FALSE;
}
//实例化类,并调用函数
$this->_objects[$class] = new $class();
$this->_objects[$class]->$function($params);
}
}
else
{
//函数存在则引入对应文件
function_exists($function) OR require_once($filepath);
//函数不可调用,或不存在
if ( ! function_exists($function))
{
//_in_progress标记改成FALSE,返回FALSE
return $this->_in_progress = FALSE;
}
//调用钩子
$function($params);
}
//到这里说明钩子正常调用了额,_in_progress标记改成FALSE,返回TRUE
$this->_in_progress = FALSE;
return TRUE;
}
}