對"鉤子"這個概念其實不熟悉,最近看到一個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自學中心。
感謝閱讀!