当前位置:首页 > PHP教程 > php应用 > 列表

浅谈PHP中如何实现Hook机制

发布:smiling 来源: PHP粉丝网  添加日期:2021-08-19 10:35:28 浏览: 评论:0 

本篇文章主要介绍了浅谈PHP中如何实现Hook机制,详细的介绍了Hook机制的原理和实现过程,具有一定的参考价值,有兴趣的可以了解一下。

对"钩子"这个概念其实不熟悉,最近看到一个php框架中用到这种机制来扩展项目,所以大概来了解下。

所谓Hook机制,是从Windows编程中流行开的一种技术。其主要思想是提前在可能增加功能的地方埋好(预设)一个钩子,这个钩子并没有实际的意义,当我们需要重新修改或者增加这个地方的逻辑的时候,把扩展的类或者方法挂载到这个点即可。

hook插件机制的基本思想:

在项目代码中,你认为要扩展(暂时不扩展)的地方放置一个钩子函数,等需要扩展的时候,把需要实现的类和函数挂载到这个钩子上,就可以实现扩展了。

思想就是这样听起来比较笼统,看一个网上的实现的例子。

整个插件机制包含三个部分:

1.hook插件经理类:这个是核心文件,是一个应用程序全局Global对象。它主要有三个职责

1>监听已经注册了的所有插件,并实例化这些插件对象。

2>注册所有插件。

3>当钩子条件满足时,触发对应的对象方法。

2.插件的功能实现:这大多由第三方开发人员完成,但需要遵循我们(经理类定义)的规则,这个规则是插件机制所规定的,因插件机制的不同而不同。

3.插件的触发:也就是钩子的触发条件。这是一小段代码,放置在你需要调用插件的地方,用于触发这个钩子。

----------------------------------看一看别人实现的方案------------------------------

首先是插件经理类PluginManager,这个类要放在全局引用里面,在所有需要用到插件的地方,优先加载。

  1. <?php 
  2. /** 
  3. * 
  4. * 插件机制的实现核心类 
  5.  
  6. */ 
  7. class PluginManager 
  8. { 
  9.   /** 
  10.    * 监听已注册的插件 
  11.    * 
  12.    * @access private 
  13.    * @var array 
  14.    */ 
  15.   private $_listeners = array(); 
  16.    /** 
  17.    * 构造函数 
  18.    * 
  19.    * @access public 
  20.    * @return void 
  21.    */ 
  22.   public function __construct() 
  23.   { 
  24.     #这里$plugin数组包含我们获取已经由用户激活的插件信息 
  25.    #为演示方便,我们假定$plugin中至少包含 
  26.    #$plugin = array( 
  27.     #  'name' => '插件名称', 
  28.     #  'directory'=>'插件安装目录' 
  29.     #); 
  30.     $plugins = get_active_plugins();#这个函数请自行实现 
  31.     if($plugins) 
  32.     { 
  33.       foreach($plugins as $plugin) 
  34.       {//假定每个插件文件夹中包含一个actions.php文件,它是插件的具体实现 
  35.         if (@file_exists(STPATH .'plugins/'.$plugin['directory'].'/actions.php')) 
  36.         { 
  37.           include_once(STPATH .'plugins/'.$plugin['directory'].'/actions.php'); 
  38.           $class = $plugin['name'].'_actions'; 
  39.           if (class_exists($class)) 
  40.           { 
  41.             //初始化所有插件 
  42.             new $class($this); 
  43.           } 
  44.         } 
  45.       } 
  46.     } 
  47.     #此处做些日志记录方面的东西 
  48.   } 
  49.  
  50.   /** 
  51.    * 注册需要监听的插件方法(钩子) 
  52.    * 
  53.    * @param string $hook 
  54.    * @param object $reference 
  55.    * @param string $method 
  56.    */ 
  57.   function register($hook, &$reference, $method) 
  58.   { 
  59.     //获取插件要实现的方法 
  60.     $key = get_class($reference).'->'.$method; 
  61.     //将插件的引用连同方法push进监听数组中 
  62.     $this->_listeners[$hook][$key] = array(&$reference, $method); 
  63.     #此处做些日志记录方面的东西 
  64.   } 
  65.   /** 
  66.    * 触发一个钩子 
  67.    * 
  68.    * @param string $hook 钩子的名称 
  69.    * @param mixed $data 钩子的入参 
  70.    *  @return mixed 
  71.    */ 
  72.   function trigger($hook, $data='') 
  73.   { 
  74.     $result = ''; 
  75.     //查看要实现的钩子,是否在监听数组之中 
  76.     if (isset($this->_listeners[$hook]) && is_array($this->_listeners[$hook]) && count($this->_listeners[$hook]) > 0) 
  77.     { 
  78.       // 循环调用开始 
  79.       foreach ($this->_listeners[$hook] as $listener) 
  80.       { 
  81.         // 取出插件对象的引用和方法 
  82.         $class =& $listener[0]; 
  83.         $method = $listener[1]; 
  84.         if(method_exists($class,$method)) 
  85.         { 
  86.           // 动态调用插件的方法 
  87.           $result .= $class->$method($data); 
  88.         } 
  89.       } 
  90.     } 
  91.     #此处做些日志记录方面的东西 
  92.     return $result; 
  93.   } 
  94. } 

接下来是一个简单插件的实现DEMO_actions。这是一个简单的Hello World插件,用于输出一句话,在实际情况中,say_hello可能包括对数据库的操作,或者是其他一些特定的逻辑。

  1. <?php 
  2. /** 
  3. * 这是一个Hello World简单插件的实现 
  4. */ 
  5. /** 
  6. *需要注意的几个默认规则: 
  7. *  1. 本插件类的文件名必须是action 
  8. *  2. 插件类的名称必须是{插件名_actions} 
  9. */ 
  10. class DEMO_actions 
  11. { 
  12.   //解析函数的参数是pluginManager的引用 
  13.   function __construct(&$pluginManager) 
  14.   { 
  15.     //注册这个插件 
  16.     //第一个参数是钩子的名称 
  17.     //第二个参数是pluginManager的引用 
  18.     //第三个是插件所执行的方法 
  19.     $pluginManager->register('demo', $this, 'say_hello'); 
  20.   } 
  21.  
  22.   function say_hello() 
  23.   { 
  24.     echo 'Hello World'; 
  25.   } 
  26. } 

再接下来就是插件的调用触发的地方,比如我要将say_hello放到我博客首页Index.php, 那么你在index.php中的某个位置写下:

$pluginManager->trigger('demo','');

第一个参数表示钩子的名字,第二个参数是插件对应方法的入口参数,由于这个例子中没有输入参数,所以为空。

这样一个例子基本上很明确的表达了"钩子"插件机制的实现方式和逻辑。

Tags: Hook

分享到: