浅谈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判断字符以及字符串的包含方法属性
Aug 30 PHP
php 图片上传类代码
Jul 17 PHP
PHP函数之error_reporting(E_ALL ^ E_NOTICE)详细说明
Jul 01 PHP
单一index.php实现PHP任意层级文件夹遍历(Zjmainstay原创)
Jul 31 PHP
php使用异或实现的加密解密实例
Sep 04 PHP
CI框架中redis缓存相关操作文件示例代码
May 17 PHP
ThinkPHP中调用PHPExcel的实现代码
Apr 08 PHP
PHP explode()函数用法讲解
Feb 15 PHP
PHP生成随机码的思路与方法实例探索
Apr 11 PHP
Laravel Eloquent ORM 实现查询表中指定的字段
Oct 17 PHP
Laravel (Lumen) 解决JWT-Auth刷新token的问题
Oct 24 PHP
PHP7新增函数
Mar 09 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
《魔兽争霸3:重制版》更新 多项视觉效果调整
2020/05/04 魔兽争霸
php中使用Imagick实现图像直方图的实现代码
2011/08/30 PHP
PHP实现异步调用方法研究与分享
2011/10/27 PHP
Thinkphp+smarty+uploadify实现无刷新上传
2015/07/30 PHP
Yii框架结合sphinx,Ajax实现搜索分页功能示例
2016/10/18 PHP
一个tab标签切换效果代码
2009/03/27 Javascript
基于JQuery制作的产品广告效果
2010/12/08 Javascript
javascript内存管理详细解析
2013/11/11 Javascript
自己使用js/jquery写的一个定制对话框控件
2014/05/02 Javascript
jquery操作对象数组元素方法详解
2014/11/26 Javascript
AngularJS HTML编译器介绍
2014/12/06 Javascript
AngularJS快速入门
2015/04/02 Javascript
jquery+json实现数据二级联动的方法
2015/11/28 Javascript
js运动应用实例解析
2015/12/28 Javascript
CKEditor无法验证的解决方案(js验证+jQuery Validate验证)
2016/05/09 Javascript
由简入繁实现Jquery树状结构的方法(推荐)
2016/06/10 Javascript
一个简单的JavaScript Map实例(分享)
2016/08/03 Javascript
JavaScript reduce和reduceRight详解
2016/10/24 Javascript
百度搜索框智能提示案例jsonp
2016/11/28 Javascript
简单理解js的prototype属性及使用
2016/12/07 Javascript
详解VueJs异步动态加载块
2017/03/09 Javascript
详解Angular 4.x Injector
2017/05/04 Javascript
解读vue生成的文件目录结构及说明
2017/11/27 Javascript
在vue中根据光标的显示与消失实现下拉列表
2019/09/29 Javascript
线程和进程的区别及Python代码实例
2015/02/04 Python
Linux 修改Python命令的方法示例
2018/12/03 Python
python解析含有重复key的json方法
2019/01/22 Python
Python 转移文件至云对象存储的方法
2021/02/07 Python
The Body Shop美体小铺西班牙官网:天然化妆品
2019/06/21 全球购物
Trip.com澳大利亚:在线旅行社
2019/12/01 全球购物
工作自荐信
2013/12/11 职场文书
财务内勤岗位职责
2014/04/17 职场文书
《画家乡》教学反思
2014/04/22 职场文书
2015年医院护理部工作总结
2015/04/23 职场文书
2015年班组建设工作总结
2015/05/13 职场文书
中学语文教学反思
2016/02/16 职场文书