搜尋
首頁後端開發php教程PHP鉤子機制原理及詳解

PHP鉤子機制原理及詳解

藏色散人
藏色散人
Jan 23, 2020 am 10:37 AM
php

PHP鉤子機制原理及詳解

什麼是鉤子？

大家想必聽過插件，wordpress插件特別多，這個就是用鉤子機制實現的。

當程式碼在運行的過程中，我們預先在運行的幾個特殊點裡執行一些特殊方法：例如在運行方法（例如Blog::add的add方法）之前記錄輸入參數、運行方法之後記錄處理結果，這個運行方法之前、運行方法之後就是簡單的鉤子(掛載點)，我們在這個鉤子上放置鉤子函數（記錄輸入參數、記錄處理結果），執行一些和程序運行不相關的任務。 

<?php
class Blog extends Controller{
    
    public function add(){
        
        //some code
        $res = $data;
        
        return $res;
    }
}
$obj = new Blog();
Log::write($_REQUEST);
$res =  $obj->add();
Log::write(json_encode($res));

如果在運行方法之前放置的是一個OnBeforeRunActionCallback()的方法，這個方法可能最開始的時候是空的，但我們以後就可以不去修改原有程式碼，直接在OnBeforeRunActionCallback()裡面加程式碼邏輯就可以了，例如記錄日誌、參數過濾等等。 

<?php
class Blog extends Controller{
    
    public function add(){
        
        //some code
        $res = $data;
        
        return $res;
    }
}
$obj = new Blog();
OnBeforeRunActionCallback($_REQUEST);
$obj->add();
OnAfterRunActionCallback($res);
function OnBeforeRunActionCallback($param){
    Log::write($param);
        FilterParams($param);
}
function OnAfterRunActionCallback($res){
    Log::write(json_encode($res));
}

在專案程式碼中，你認為要擴充（暫時不擴充）的地方放置一個鉤子函數，等需要擴充的時候，把需要實作的類別和函數掛載到這個鉤子上，就可以實現擴展了。

原理

實際的鉤子一般設計為一個類別Hook，該類別提供註冊插件到鉤子(add_hook)、觸發鉤子方法(trigger_hook)。註冊插件的時候將插件所要運行的可執行方法儲存到鉤子對應的陣列裡面。 

$_listeners = array(
    &#39;OnBeforeRunAction&#39; => array(
        &#39;callback1&#39;,
        &#39;callback2&#39;,
        &#39;callback3&#39;,
    ),
);
//提前注册插件到钩子
add_hook(&#39;OnBeforeRunAction&#39;, &#39;callback4&#39;);
//特定地方执行钩子
trigger_hook(&#39;OnBeforeRunAction&#39;);

當觸發鉤子的時候，將遍歷OnBeforeRunAction裡註冊的回調方法，執行對應的回調方法，實現動態擴充功能。註冊的鉤子方法一般是匿名函數:

function trigger_hook($hook, $data=&#39;&#39;){
    //查看要实现的钩子，是否在监听数组之中
    if (isset($this->_listeners[$hook]) && is_array($this->_listeners[$hook]) && count($this->_listeners[$hook]) > 0)
    {
        // 循环调用开始
        foreach ($this->_listeners[$hook] as $listener)
        {
            if(is_callable()){
                call_user_func($listener, $data);
            }elseif(is_array($listener)){
                // 取出插件对象的引用和方法
                $class =& $listener[0];
                $method = $listener[1];
                if(method_exists($class,$method))
                {
                    // 动态调用插件的方法
                    $class->$method($data);
                }
            }
        }
    }
}

如何實作？

簡單的

1、外掛程式類別Hook:提供註冊外掛程式和執行外掛程式的方法，實際上是往一個陣列裡存掛載點對應的可執行方法。

2、在某個設定檔或函數裡統一註冊外掛程式。 

class Hook
{
    //action hooks array  
    private static $actions = array();
    /**
     * ads a function to an action hook
     * @param $hook
     * @param $function
     */
    public static function add_action($hook,$function)
    {   
        $hook=mb_strtolower($hook,CHARSET);
        // create an array of function handlers if it doesn&#39;t already exist
        if(!self::exists_action($hook))
        {
            self::$actions[$hook] = array();
        }
        // append the current function to the list of function handlers
        if (is_callable($function))
        {
            self::$actions[$hook][] = $function;
            return TRUE;
        }
        return FALSE ;
    }
    /**
     * executes the functions for the given hook
     * @param string $hook
     * @param array $params
     * @return boolean true if a hook was setted
     */
    public static function do_action($hook,$params=NULL)
    {
        $hook=mb_strtolower($hook,CHARSET);
        if(isset(self::$actions[$hook]))
        {
            // call each function handler associated with this hook
            foreach(self::$actions[$hook] as $function)
            {
                if (is_array($params))
                {
                    call_user_func_array($function,$params);
                }
                else
                {
                    call_user_func($function);
                }
                //cant return anything since we are in a loop! dude!
            }
            return TRUE;
        }
        return FALSE;
    }
    /**
     * gets the functions for the given hook
     * @param string $hook
     * @return mixed
     */
    public static function get_action($hook)
    {
        $hook=mb_strtolower($hook,CHARSET);
        return (isset(self::$actions[$hook]))? self::$actions[$hook]:FALSE;
    }
    /**
     * check exists the functions for the given hook
     * @param string $hook
     * @return boolean
     */
    public static function exists_action($hook)
    {
        $hook=mb_strtolower($hook,CHARSET);
        return (isset(self::$actions[$hook]))? TRUE:FALSE;
    }
}
 
    /**
     * Hooks Shortcuts not in class
     */
    function add_action($hook,$function)
    {
        return Hook::add_action($hook,$function);
    }
 
    function do_action($hook)
    {
        return Hook::do_action($hook);
    }

用法範例：

//添加钩子
Hook::add_action(&#39;unique_name_hook&#39;,&#39;some_class::hook_test&#39;);
//或使用快捷函数添加钩子:
add_action(&#39;unique_name_hook&#39;,&#39;other_class::hello&#39;);
add_action(&#39;unique_name_hook&#39;,&#39;some_public_function&#39;);
//执行钩子
do_action(&#39;unique_name_hook&#39;);//也可以使用 Hook::do_action();

帶有安裝/卸載的

鉤子類別初始化的時候去註冊已經開啟的插件（如資料庫記錄） ；全域適當的時候設定掛載點；運行到適當的時候觸發掛載點註冊的事件。

1、外掛程式類別Hook:提供註冊外掛程式和執行外掛程式的方法，實際上是往一個陣列裡存掛載點對應的可執行方法。

2、插件類別增加一個初始化的方法，去資料尋找已經安裝的插件，運行插件必須執行的註冊方法(reg)，註冊插件方法註冊鉤子到掛載點。

3、固定把插件放在某個目錄，並安照一定規範寫設定檔。後台有插件清單頁面，遍歷指定目錄下的插件。安裝的時候，將插件資訊記錄到資料庫，卸載的時候刪除資料庫記錄資訊。 

<?php
/**
 * @file plugin.php
 * @brief 插件核心类
 * @note 观察者模式，注册事件，触发事件
 */
class plugin extends IInterceptorBase
{
    //默认开启的插件列表
    private static $defaultList = array("_verification","_goodsCategoryWidget","_authorization","_userInfo","_initData");
    //已经注册监听
    private static $_listen = array();
    //加载插件
    public static function init()
    {
        $pluginDB    = new IModel(&#39;plugin&#39;);
        $pluginList  = $pluginDB->query("is_open = 1","class_name","sort asc");
        //加载默认插件
        foreach(self::$defaultList as $val)
        {
            $pluginList[]= array(&#39;class_name&#39; => $val);
        }
        foreach($pluginList as $key => $val)
        {
            $className = $val[&#39;class_name&#39;];
            $classFile = self::path().$className."/".$className.".php";
            if(is_file($classFile))
            {
                include_once($classFile);
                $pluginObj = new $className();
                $pluginObj->reg();
            }
        }
    }
    /**
     * @brief 注册事件
     * @param string $event 事件
     * @param object ro function $classObj 类实例 或者 匿名函数
     * @param string $method 方法名字
     */
    public static function reg($event,$classObj,$method = "")
    {
        if(!isset(self::$_listen[$event]))
        {
            self::$_listen[$event] = array();
        }
        self::$_listen[$event][] = array($classObj,$method);
    }
    /**
     * @brief 显示已注册事件
     * @param string $event 事件名称
     * @return array
     */
    public static function get($event = &#39;&#39;)
    {
        if($event)
        {
            if( isset(self::$_listen[$event]) )
            {
                return self::$_listen[$event];
            }
            return null;
        }
        return self::$_listen;
    }
    /**
     * @brief 触发事件
     * @param string $event 事件
     * @param mixed  $data  数据
     * @notice 可以调用匿名函数和方法
     */
    public static function trigger($event,$data = null)
    {
        $result = array();
        if(isset(self::$_listen[$event]))
        {
            foreach(self::$_listen[$event] as $key => $val)
            {
                list($pluginObj,$pluginMethod) = $val;
                $result[$key] = is_callable($pluginObj) ? call_user_func($pluginObj,$data):call_user_func(array($pluginObj,$pluginMethod),$data);
            }
        }
        return isset($result[1]) ? $result : current($result);
    }
    /**
     * @brief 插件物理路径
     * @return string 路径字符串
     */
    public static function path()
    {
        return IWeb::$app->getBasePath()."plugins/";
    }
    /**
     * @brief 插件WEB路径
     * @return string 路径字符串
     */
    public static function webPath()
    {
        return IUrl::creatUrl(&#39;&#39;)."plugins/";
    }
    /**
     * @brief 获取全部插件
     * @param string $name 插件名字，如果为空则获取全部插件信息
     * @return array 插件信息 array(
        "name"        => 插件名字,
        "description" => 插件描述,
        "explain"     => 使用说明,
        "class_name"  => 插件ID,
        "is_open"     => 是否开启,
        "is_install"  => 是否安装,
        "config_name" => 默认插件参数结构,
        "config_param"=> 已经保存的插件参数,
        "sort"        => 排序,
     )
     */
    public static function getItems($name = &#39;&#39;)
    {
        $result = array();
        $dirRes = opendir(self::path());
        //遍历目录读取配置文件
        $pluginDB = new IModel(&#39;plugin&#39;);
        while($dir = readdir($dirRes))
        {
            if($dir[0] == "." || $dir[0] == "_")
            {
                continue;
            }
            if($name && $result)
            {
                break;
            }
            if($name && $dir != $name)
            {
                continue;
            }
            $pluginIndex = self::path().$dir."/".$dir.".php";
            if(is_file($pluginIndex))
            {
                include_once($pluginIndex);
                if(get_parent_class($dir) == "pluginBase")
                {
                    $class_name   = $dir;
                    $pluginRow    = $pluginDB->getObj(&#39;class_name = "&#39;.$class_name.&#39;"&#39;);
                    $is_open      = $pluginRow ? $pluginRow[&#39;is_open&#39;] : 0;
                    $is_install   = $pluginRow ? 1                     : 0;
                    $sort         = $pluginRow ? $pluginRow[&#39;sort&#39;]    : 99;
                    $config_param = array();
                    if($pluginRow && $pluginRow[&#39;config_param&#39;])
                    {
                        $config_param = JSON::decode($pluginRow[&#39;config_param&#39;]);
                    }
                    $result[$dir] = array(
                        "name"        => $class_name::name(),
                        "description" => $class_name::description(),
                        "explain"     => $class_name::explain(),
                        "class_name"  => $class_name,
                        "is_open"     => $is_open,
                        "is_install"  => $is_install,
                        "config_name" => $class_name::configName(),
                        "config_param"=> $config_param,
                        "sort"        => $sort,
                    );
                }
            }
        }
        if(!$name)
        {
            return $result;
        }
        return isset($result[$name]) ? $result[$name] : array();
    }
    /**
     * @brief 系统内置的所有事件触发
     */
    public static function onCreateApp(){plugin::init();plugin::trigger("onCreateApp");}
    public static function onFinishApp(){plugin::trigger("onFinishApp");}
    public static function onBeforeCreateController($ctrlId){plugin::trigger("onBeforeCreateController",$ctrlId);plugin::trigger("onBeforeCreateController@".$ctrlId);}
    public static function onCreateController($ctrlObj){plugin::trigger("onCreateController");plugin::trigger("onCreateController@".$ctrlObj->getId());}
    public static function onFinishController($ctrlObj){plugin::trigger("onFinishController");plugin::trigger("onFinishController@".$ctrlObj->getId());}
    public static function onBeforeCreateAction($ctrlObj,$actionId){plugin::trigger("onBeforeCreateAction",$actionId);plugin::trigger("onBeforeCreateAction@".$ctrlObj->getId());plugin::trigger("onBeforeCreateAction@".$ctrlObj->getId()."@".$actionId);}
    public static function onCreateAction($ctrlObj,$actionObj){plugin::trigger("onCreateAction");plugin::trigger("onCreateAction@".$ctrlObj->getId());plugin::trigger("onCreateAction@".$ctrlObj->getId()."@".$actionObj->getId());}
    public static function onFinishAction($ctrlObj,$actionObj){plugin::trigger("onFinishAction");plugin::trigger("onFinishAction@".$ctrlObj->getId());plugin::trigger("onFinishAction@".$ctrlObj->getId()."@".$actionObj->getId());}
    public static function onCreateView($ctrlObj,$actionObj){plugin::trigger("onCreateView");plugin::trigger("onCreateView@".$ctrlObj->getId());plugin::trigger("onCreateView@".$ctrlObj->getId()."@".$actionObj->getId());}
    public static function onFinishView($ctrlObj,$actionObj){plugin::trigger("onFinishView");plugin::trigger("onFinishView@".$ctrlObj->getId());plugin::trigger("onFinishView@".$ctrlObj->getId()."@".$actionObj->getId());}
    public static function onPhpShutDown(){plugin::trigger("onPhpShutDown");}
}
/**
 * @brief 插件基类，所有插件必须继承此类
 * @notice 必须实现3个抽象方法： reg(),name(),description()
 */
abstract class pluginBase extends IInterceptorBase
{
    //错误信息
    protected $error = array();
    //注册事件接口，内部通过调用payment::reg(事件,对象实例,方法);
    public function reg(){}
    /**
     * @brief 默认插件参数信息，写入到plugin表config_param字段
     * @return array("字段名" => array(
         "name"    => "文字显示",
         "type"    => "数据类型【text,radio,checkbox,select】",
         "pattern" => "数据校验【int,float,date,datetime,require,正则表达式】",
         "value"   => "1,数组：枚举数据【radio,checkbox,select】的预设值,array(名字=>数据); 2,字符串：【text】默认数据",
        ))
     */
    public static function configName()
    {
        return array();
    }
    /**
     * @brief 插件安装
     * @return boolean
     */
    public static function install()
    {
        return true;
    }
    /**
     * @brief 插件卸载
     * @return boolean
     */
    public static function uninstall()
    {
        return true;
    }
    /**
     * @brief 插件名字
     * @return string
     */
    public static function name()
    {
        return "插件名称";
    }
    /**
     * @brief 插件功能描述
     * @return string
     */
    public static function description()
    {
        return "插件描述";
    }
    /**
     * @brief 插件使用说明
     * @return string
     */
    public static function explain()
    {
        return "";
    }
    /**
     * @brief 获取DB中录入的配置参数
     * @return array
     */
    public function config()
    {
        $className= get_class($this);
        $pluginDB = new IModel(&#39;plugin&#39;);
        $dataRow  = $pluginDB->getObj(&#39;class_name = "&#39;.$className.&#39;"&#39;);
        if($dataRow && $dataRow[&#39;config_param&#39;])
        {
            return JSON::decode($dataRow[&#39;config_param&#39;]);
        }
        return array();
    }
    /**
     * @brief 返回错误信息
     * @return array
     */
    public function getError()
    {
        return $this->error ? join("\r\n",$this->error) : "";
    }
    /**
     * @brief 写入错误信息
     * @return array
     */
    public function setError($error)
    {
        $this->error[] = $error;
    }
    /**
     * @brief 插件视图渲染有布局
     * @param string $view 视图名字
     * @param array  $data 视图里面的数据
     */
    public function redirect($view,$data = array())
    {
        if($data === true)
        {
            $this->controller()->redirect($view);
        }
        else
        {
            $__className      = get_class($this);
            $__pluginViewPath = plugin::path().$__className."/".$view;
            $result = self::controller()->render($__pluginViewPath,$data);
            if($result === false)
            {
                IError::show($__className."/".$view."插件视图不存在");
            }
        }
    }
    /**
     * @brief 插件视图渲染去掉布局
     * @param string $view 视图名字
     * @param array  $data 视图里面的数据
     */
    public function view($view,$data = array())
    {
        self::controller()->layout = "";
        $this->redirect($view,$data);
    }
    /**
     * @brief 插件物理目录
     * @param string 插件路径地址
     */
    public function path()
    {
        return plugin::path().get_class($this)."/";
    }
    /**
     * @brief 插件WEB目录
     * @param string 插件路径地址
     */
    public function webPath()
    {
        return plugin::webPath().get_class($this)."/";
    }
}

更多相關php知識，請造訪php教學！

以上是PHP鉤子機制原理及詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！

陳述
本文轉載於：cnblogs。如有侵權，請聯絡admin@php.cn刪除
相關文章
PHP：服務器端腳本語言的簡介PHP：服務器端腳本語言的簡介Apr 16, 2025 am 12:18 AM

PHP是一種服務器端腳本語言，用於動態網頁開發和服務器端應用程序。 1.PHP是一種解釋型語言，無需編譯，適合快速開發。 2.PHP代碼嵌入HTML中，易於網頁開發。 3.PHP處理服務器端邏輯，生成HTML輸出，支持用戶交互和數據處理。 4.PHP可與數據庫交互，處理表單提交，執行服務器端任務。

PHP和網絡：探索其長期影響PHP和網絡：探索其長期影響Apr 16, 2025 am 12:17 AM

PHP在過去幾十年中塑造了網絡，並將繼續在Web開發中扮演重要角色。 1)PHP起源於1994年，因其易用性和與MySQL的無縫集成成為開發者首選。 2)其核心功能包括生成動態內容和與數據庫的集成，使得網站能夠實時更新和個性化展示。 3)PHP的廣泛應用和生態系統推動了其長期影響，但也面臨版本更新和安全性挑戰。 4)近年來的性能改進，如PHP7的發布，使其能與現代語言競爭。 5)未來，PHP需應對容器化、微服務等新挑戰，但其靈活性和活躍社區使其具備適應能力。

為什麼要使用PHP？解釋的優點和好處為什麼要使用PHP？解釋的優點和好處Apr 16, 2025 am 12:16 AM

PHP的核心優勢包括易於學習、強大的web開發支持、豐富的庫和框架、高性能和可擴展性、跨平台兼容性以及成本效益高。 1)易於學習和使用，適合初學者；2)與web服務器集成好，支持多種數據庫；3)擁有如Laravel等強大框架；4)通過優化可實現高性能；5)支持多種操作系統；6)開源，降低開發成本。

揭穿神話：PHP真的是一種死語嗎？揭穿神話：PHP真的是一種死語嗎？Apr 16, 2025 am 12:15 AM

PHP沒有死。 1)PHP社區積極解決性能和安全問題，PHP7.x提升了性能。 2)PHP適合現代Web開發，廣泛用於大型網站。 3)PHP易學且服務器表現出色，但類型系統不如靜態語言嚴格。 4)PHP在內容管理和電商領域仍重要，生態系統不斷進化。 5)通過OPcache和APC等優化性能，使用OOP和設計模式提升代碼質量。

PHP與Python辯論：哪個更好？PHP與Python辯論：哪個更好？Apr 16, 2025 am 12:03 AM

PHP和Python各有優劣，選擇取決於項目需求。 1)PHP適合Web開發，易學，社區資源豐富，但語法不夠現代，性能和安全性需注意。 2)Python適用於數據科學和機器學習，語法簡潔，易學，但執行速度和內存管理有瓶頸。

PHP的目的：構建動態網站PHP的目的：構建動態網站Apr 15, 2025 am 12:18 AM

PHP用於構建動態網站，其核心功能包括：1.生成動態內容，通過與數據庫對接實時生成網頁；2.處理用戶交互和表單提交，驗證輸入並響應操作；3.管理會話和用戶認證，提供個性化體驗；4.優化性能和遵循最佳實踐，提升網站效率和安全性。

PHP：處理數據庫和服務器端邏輯PHP：處理數據庫和服務器端邏輯Apr 15, 2025 am 12:15 AM

PHP在數據庫操作和服務器端邏輯處理中使用MySQLi和PDO擴展進行數據庫交互，並通過會話管理等功能處理服務器端邏輯。 1）使用MySQLi或PDO連接數據庫，執行SQL查詢。 2）通過會話管理等功能處理HTTP請求和用戶狀態。 3）使用事務確保數據庫操作的原子性。 4）防止SQL注入，使用異常處理和關閉連接來調試。 5）通過索引和緩存優化性能，編寫可讀性高的代碼並進行錯誤處理。

您如何防止PHP中的SQL注入？ （準備的陳述，PDO）您如何防止PHP中的SQL注入？ （準備的陳述，PDO）Apr 15, 2025 am 12:15 AM

在PHP中使用預處理語句和PDO可以有效防範SQL注入攻擊。 1)使用PDO連接數據庫並設置錯誤模式。 2)通過prepare方法創建預處理語句，使用佔位符和execute方法傳遞數據。 3)處理查詢結果並確保代碼的安全性和性能。

See all articles

熱AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智慧驅動的應用程序，用於創建逼真的裸體照片

AI Clothes Remover

AI Clothes Remover

用於從照片中去除衣服的線上人工智慧工具。

Undress AI Tool

Undress AI Tool

免費脫衣圖片

Clothoff.io

Clothoff.io

AI脫衣器

AI Hentai Generator

AI Hentai Generator

免費產生 AI 無盡。

顯示更多

熱門文章

R.E.P.O.能量晶體解釋及其做什麼（黃色晶體）
4 週前By尊渡假赌尊渡假赌尊渡假赌
R.E.P.O.最佳圖形設置
4 週前By尊渡假赌尊渡假赌尊渡假赌
刺客信條陰影：貝殼謎語解決方案
2 週前ByDDD
R.E.P.O.如果您聽不到任何人，如何修復音頻
1 個月前By尊渡假赌尊渡假赌尊渡假赌
R.E.P.O.聊天命令以及如何使用它們
1 個月前By尊渡假赌尊渡假赌尊渡假赌
顯示更多

熱工具

Atom編輯器mac版下載

Atom編輯器mac版下載

最受歡迎的的開源編輯器

MinGW - Minimalist GNU for Windows

MinGW - Minimalist GNU for Windows

這個專案正在遷移到osdn.net/projects/mingw的過程中，你可以繼續在那裡關注我們。 MinGW：GNU編譯器集合（GCC）的本機Windows移植版本，可自由分發的導入函式庫和用於建置本機Windows應用程式的頭檔；包括對MSVC執行時間的擴展，以支援C99功能。 MinGW的所有軟體都可以在64位元Windows平台上運作。

EditPlus 中文破解版

EditPlus 中文破解版

體積小，語法高亮，不支援程式碼提示功能

Dreamweaver Mac版

Dreamweaver Mac版

視覺化網頁開發工具

記事本++7.3.1

記事本++7.3.1

好用且免費的程式碼編輯器

顯示更多

熱門話題

gmail信箱登陸入口在哪裡
7529
15
CakePHP 教程
1378
52
steam的賬戶名稱是什麼格式
81
11
win11激活密鑰永久
54
19
NYT連接提示和答案
21
75
顯示更多