浅谈PHP中如何实现Hook机制


Posted in PHP onNovember 14, 2017

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

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

hook插件机制的基本思想:

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

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

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

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

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

    2>注册所有插件。

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

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

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

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

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

<?php
/**
*
* 插件机制的实现核心类

*/
class PluginManager
{
  /**
   * 监听已注册的插件
   *
   * @access private
   * @var array
   */
  private $_listeners = array();
   /**
   * 构造函数
   *
   * @access public
   * @return void
   */
  public function __construct()
  {
    #这里$plugin数组包含我们获取已经由用户激活的插件信息
   #为演示方便,我们假定$plugin中至少包含
   #$plugin = array(
    #  'name' => '插件名称',
    #  'directory'=>'插件安装目录'
    #);
    $plugins = get_active_plugins();#这个函数请自行实现
    if($plugins)
    {
      foreach($plugins as $plugin)
      {//假定每个插件文件夹中包含一个actions.php文件,它是插件的具体实现
        if (@file_exists(STPATH .'plugins/'.$plugin['directory'].'/actions.php'))
        {
          include_once(STPATH .'plugins/'.$plugin['directory'].'/actions.php');
          $class = $plugin['name'].'_actions';
          if (class_exists($class))
          {
            //初始化所有插件
            new $class($this);
          }
        }
      }
    }
    #此处做些日志记录方面的东西
  }

  /**
   * 注册需要监听的插件方法(钩子)
   *
   * @param string $hook
   * @param object $reference
   * @param string $method
   */
  function register($hook, &$reference, $method)
  {
    //获取插件要实现的方法
    $key = get_class($reference).'->'.$method;
    //将插件的引用连同方法push进监听数组中
    $this->_listeners[$hook][$key] = array(&$reference, $method);
    #此处做些日志记录方面的东西
  }
  /**
   * 触发一个钩子
   *
   * @param string $hook 钩子的名称
   * @param mixed $data 钩子的入参
   *  @return mixed
   */
  function trigger($hook, $data='')
  {
    $result = '';
    //查看要实现的钩子,是否在监听数组之中
    if (isset($this->_listeners[$hook]) && is_array($this->_listeners[$hook]) && count($this->_listeners[$hook]) > 0)
    {
      // 循环调用开始
      foreach ($this->_listeners[$hook] as $listener)
      {
        // 取出插件对象的引用和方法
        $class =& $listener[0];
        $method = $listener[1];
        if(method_exists($class,$method))
        {
          // 动态调用插件的方法
          $result .= $class->$method($data);
        }
      }
    }
    #此处做些日志记录方面的东西
    return $result;
  }
}

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

<?php
/**
* 这是一个Hello World简单插件的实现
*/
/**
*需要注意的几个默认规则:
*  1. 本插件类的文件名必须是action
*  2. 插件类的名称必须是{插件名_actions}
*/
class DEMO_actions
{
  //解析函数的参数是pluginManager的引用
  function __construct(&$pluginManager)
  {
    //注册这个插件
    //第一个参数是钩子的名称
    //第二个参数是pluginManager的引用
    //第三个是插件所执行的方法
    $pluginManager->register('demo', $this, 'say_hello');
  }

  function say_hello()
  {
    echo 'Hello World';
  }
}

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

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

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

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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

PHP 相关文章推荐
繁体中文转换为简体中文的PHP函数
Oct 09 PHP
php表单提交问题的解决方法
Apr 12 PHP
浅析php插件 Simple HTML DOM 用DOM方式处理HTML
Jul 01 PHP
PHP的PSR规范中文版
Sep 28 PHP
php获取数组长度的方法(有实例)
Oct 27 PHP
用Zend Studio+PHPnow+Zend Debugger搭建PHP服务器调试环境步骤
Jan 19 PHP
PHP实现AES256加密算法实例
Sep 22 PHP
ThinkPHP有变量的where条件分页实例
Nov 03 PHP
jQuery Mobile + PHP实现文件上传
Dec 12 PHP
php验证码的制作思路和实现方法
Nov 12 PHP
thinkphp,onethink和thinkox中验证码不显示的解决方法分析
Jun 06 PHP
Yii CFileCache 获取不到值的原因分析
Feb 08 PHP
PHP实现将几张照片拼接到一起的合成图片功能【便于整体打印输出】
Nov 14 #PHP
PHP封装的XML简单操作类完整实例
Nov 13 #PHP
PHP开发中解决并发问题的几种实现方法分析
Nov 13 #PHP
三个思路解决laravel上传文件报错:413 Request Entity Too Large问题
Nov 13 #PHP
kindeditor 加入七牛云上传的实例讲解
Nov 12 #PHP
Thinkphp5 微信公众号token验证不成功的原因及解决方法
Nov 12 #PHP
PHP 断点续传实例详解
Nov 11 #PHP
You might like
PHP下操作Linux消息队列完成进程间通信的方法
2010/07/24 PHP
php计算两个文件相对路径的方法
2015/03/14 PHP
PHP基于自定义类随机生成姓名的方法示例
2017/08/05 PHP
js中根据字数截取字符串,不能截断url
2012/01/12 Javascript
JS 实现图片直接下载示例代码
2013/07/22 Javascript
js实现目录定位正文示例
2013/11/14 Javascript
点击页面其它地方隐藏该div的两种思路
2013/11/18 Javascript
js 实现的可折叠留言板(附源码下载)
2014/07/01 Javascript
js图片模糊切换显示特效的方法
2015/02/17 Javascript
浅析JavaScript中的对象类型Object
2016/05/26 Javascript
JavaScript事件详细讲解
2016/06/27 Javascript
javascript简单进制转换实现方法
2016/11/24 Javascript
jquery append与appendTo方法比较
2017/05/24 jQuery
BootStrap 动态表单效果
2017/06/02 Javascript
详解基于Angular4+ server render(服务端渲染)开发教程
2017/08/28 Javascript
linux 后台运行node服务指令方法
2018/05/23 Javascript
js实现动态添加上传文件页面
2018/10/22 Javascript
微信小程序实现多选删除列表数据功能示例
2019/01/15 Javascript
配置node服务器并且链接微信公众号接口配置步骤详解
2019/06/21 Javascript
JS实现的排列组合算法示例
2019/07/16 Javascript
vue全局使用axios的操作
2020/09/08 Javascript
JavaScript 声明私有变量的两种方式
2021/02/05 Javascript
详解js创建对象的几种方式和对象方法
2021/03/01 Javascript
[01:33:07]VGJ.T vs Newbee Supermajor 败者组 BO3 第一场 6.6
2018/06/07 DOTA
Python正则替换字符串函数re.sub用法示例
2017/01/19 Python
Python实现爬虫抓取与读写、追加到excel文件操作示例
2018/06/27 Python
WxPython建立批量录入框窗口
2019/02/27 Python
详解Python设计模式之策略模式
2020/06/15 Python
自荐信格式的六要素
2013/09/21 职场文书
装潢设计专业推荐信模板
2013/11/26 职场文书
法人身份证明书
2014/10/08 职场文书
思想作风建设心得体会
2014/10/22 职场文书
市场部岗位职责
2015/02/12 职场文书
2015年度绩效考核工作总结
2015/05/27 职场文书
2016大学生社会实践单位评语
2015/12/01 职场文书
CSS 还能这样玩?奇思妙想渐变的艺术
2021/04/27 HTML / CSS