浅谈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编写PDF文档生成器
Oct 09 PHP
自动分页的不完整解决方案
Jan 12 PHP
表单复选框向PHP传输数据的代码
Nov 13 PHP
PHP utf-8编码问题,utf8编码,数据库乱码,页面显示输出乱码
Apr 08 PHP
如何利用PHP执行.SQL文件
Jul 05 PHP
2个自定义的PHP in_array 函数,解决大量数据判断in_array的效率问题
Apr 08 PHP
php简单实现快速排序的方法
Apr 04 PHP
详解WordPress开发中wp_title()函数的用法
Jan 07 PHP
PHP制作登录异常ip检测功能的实例代码
Nov 16 PHP
thinkPHP中session()方法用法详解
Dec 08 PHP
PHP使用ActiveMQ实例
Feb 05 PHP
PHP实现断点续传乱序合并文件的方法
Sep 06 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中使用XML
2006/10/09 PHP
PHP实现微信图片上传到服务器的方法示例
2017/06/29 PHP
PHP封装的XML简单操作类完整实例
2017/11/13 PHP
JS类定义原型方法的两种实现的区别评论很多
2007/09/12 Javascript
Jquery 实现Tab效果 思路是js思路
2010/03/02 Javascript
javascript css styleFloat和cssFloat
2010/03/15 Javascript
JavaScript 异步方法队列链实现代码分析
2010/06/05 Javascript
JQuery each打印JS对象的方法
2013/11/13 Javascript
node.js中的fs.readSync方法使用说明
2014/12/17 Javascript
浅谈javascript中字符串String与数组Array
2014/12/31 Javascript
js实现可输入可选择的select下拉框
2016/12/21 Javascript
node vue项目开发之前后端分离实战记录
2017/12/13 Javascript
Vue源码探究之虚拟节点的实现
2019/04/17 Javascript
了解javascript中的Dom操作
2019/05/27 Javascript
layui扩展上传组件模拟进度条的方法
2019/09/23 Javascript
BootStrap前端框架使用方法详解
2020/02/26 Javascript
Python新手实现2048小游戏
2015/03/31 Python
python 实时遍历日志文件
2016/04/12 Python
python样条插值的实现代码
2018/12/17 Python
Python多线程处理实例详解【单进程/多进程】
2019/01/30 Python
python Tkinter版学生管理系统
2019/02/20 Python
django有外键关系的两张表如何相互查找
2020/02/10 Python
Python paramiko使用方法代码汇总
2020/11/20 Python
解决pycharm导入numpy包的和使用时报错:RuntimeError: The current Numpy installation (‘D:\\python3.6\\lib\\site-packa的问题
2020/12/08 Python
HTML5使用Audio标签实现歌词同步的效果
2016/03/17 HTML / CSS
如何让pre和textarea等HTML元素去掉滚动条自动换行自适应文本内容高度
2019/08/01 HTML / CSS
CAT鞋英国官网:坚固耐用的靴子和鞋
2016/10/21 全球购物
美国卡车、吉普车和SUV零件网站:4 Wheel Parts
2016/11/24 全球购物
美丽的现代设计家具:2Modern
2018/07/26 全球购物
解释一下ruby中的特殊方法与特殊类
2013/02/26 面试题
学习型班组申报材料
2014/05/31 职场文书
员工保密协议书
2014/09/27 职场文书
商场营业员岗位职责
2015/04/14 职场文书
篮球比赛通讯稿
2015/07/18 职场文书
2016年师德学习心得体会
2016/01/12 职场文书
Sql-Server数据库单表查询 4.3实验课
2021/04/05 SQL Server