浅谈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中++i 与 i++ 的区别
Aug 08 PHP
PHP APC的安装与使用详解
Jun 13 PHP
php连接Access数据库错误及解决方法
Jun 20 PHP
php命令行使用方法和命令行参数说明
Apr 08 PHP
dvwa+xampp搭建显示乱码的问题及解决方案
Aug 23 PHP
php+mysql实现无限级分类
Nov 11 PHP
linux下php上传文件注意事项
Jun 11 PHP
Yii 2.0实现联表查询加搜索分页的方法示例
Aug 02 PHP
PHP设计模式之装饰器模式实例详解
Feb 07 PHP
thinkPHP中U方法加密传递参数功能示例
May 29 PHP
Laravel 5.1 框架Blade模板引擎用法实例分析
Jan 04 PHP
PHP解决高并发问题
Apr 01 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
水质对咖图啡风味的影响具体有哪些
2021/03/03 冲泡冲煮
php中jpgraph类库的使用介绍
2013/08/08 PHP
PHP输入输出流学习笔记
2015/05/12 PHP
解决nginx不支持thinkphp中pathinfo的问题
2015/07/21 PHP
header与缓冲区之间的深层次分析
2016/07/30 PHP
javascript TextArea动态显示剩余字符
2008/10/22 Javascript
js报错 Object doesn't support this property or method的原因分析
2011/03/31 Javascript
javascript针对DOM的应用分析(三)
2012/04/15 Javascript
Js中获取frames中的元素示例代码
2013/07/30 Javascript
textarea 控制输入字符字节数(示例代码)
2013/12/27 Javascript
javascript去除字符串中所有标点符号和提取纯文本的正则
2014/06/07 Javascript
js判断浏览器版本以及浏览器内核的方法
2015/01/20 Javascript
js如何打印object对象
2015/10/16 Javascript
JS &amp; JQuery 动态添加 select option
2016/06/08 Javascript
AngularJS 单元测试(一)详解
2016/09/21 Javascript
Jquery循环截取字符串的方法(多出的字符串处理成&quot;...&quot;)
2016/11/28 Javascript
JS实现页面进入和返回定位到具体位置
2016/12/08 Javascript
Vue 页面切换效果之 BubbleTransition(推荐)
2018/04/08 Javascript
vue实现商品加减计算总价的实例代码
2018/08/12 Javascript
微信小程序接入腾讯云验证码的方法步骤
2020/01/07 Javascript
python实现修改固定模式的字符串内容操作示例
2019/12/30 Python
使用python计算三角形的斜边例子
2020/04/15 Python
解决reload(sys)后print失效的问题
2020/04/25 Python
宝塔面板出现“open_basedir restriction in effect. ”的解决方法
2021/03/14 PHP
HTML5 visibilityState属性详细介绍和使用实例
2014/05/03 HTML / CSS
以下的初始化有什么区别
2013/12/16 面试题
大专自我鉴定范文
2013/10/23 职场文书
法人授权委托书
2014/04/03 职场文书
治庸问责心得体会
2014/09/12 职场文书
男方婚礼答谢词
2015/01/20 职场文书
小学英语教学经验交流材料
2015/11/02 职场文书
十二月早安励志心语大全
2019/12/03 职场文书
springboot 启动如何排除某些bean的注入
2021/08/02 Java/Android
Python matplotlib绘制条形统计图 处理多个实验多组观测值
2022/04/21 Python
SQL bool盲注和时间盲注详解
2022/07/23 SQL Server