對"鉤子"這個概念其實不熟悉,最近看到一個php框架中用到這種機制來擴展項目,所以大概來了解下。
所謂Hook機制,是從Windows編程中流行開的一種技術(shù)。其主要思想是提前在可能增加功能的地方埋好(預(yù)設(shè))一個鉤子,這個鉤子并沒有實際的意義,當我們需要重新修改或者增加這個地方的邏輯的時候,把擴展的類或者方法掛載到這個點即可。
hook插件機制的基本思想:
在項目代碼中,你認為要擴展(暫時不擴展)的地方放置一個鉤子函數(shù),等需要擴展的時候,把需要實現(xiàn)的類和函數(shù)掛載到這個鉤子上,就可以實現(xiàn)擴展了。
思想就是這樣聽起來比較籠統(tǒng),看一個網(wǎng)上的實現(xiàn)的例子。
整個插件機制包含三個部分:
1.hook插件經(jīng)理類:這個是核心文件,是一個應(yīng)用程序全局Global對象。它主要有三個職責
1>監(jiān)聽已經(jīng)注冊了的所有插件,并實例化這些插件對象。
2>注冊所有插件。
3>當鉤子條件滿足時,觸發(fā)對應(yīng)的對象方法。
2.插件的功能實現(xiàn):這大多由第三方開發(fā)人員完成,但需要遵循我們(經(jīng)理類定義)的規(guī)則,這個規(guī)則是插件機制所規(guī)定的,因插件機制的不同而不同。
3.插件的觸發(fā):也就是鉤子的觸發(fā)條件。這是一小段代碼,放置在你需要調(diào)用插件的地方,用于觸發(fā)這個鉤子。
----------------------------------看一看別人實現(xiàn)的方案--------------------------------
首先是插件經(jīng)理類PluginManager,這個類要放在全局引用里面,在所有需要用到插件的地方,優(yōu)先加載。
<?php /** * * 插件機制的實現(xiàn)核心類 */ class PluginManager { /** * 監(jiān)聽已注冊的插件 * * @access private * @var array */ private $_listeners = array(); /** * 構(gòu)造函數(shù) * * @access public * @return void */ public function __construct() { #這里$plugin數(shù)組包含我們獲取已經(jīng)由用戶激活的插件信息 #為演示方便,我們假定$plugin中至少包含 #$plugin = array( # 'name' => '插件名稱', # 'directory'=>'插件安裝目錄' #); $plugins = get_active_plugins();#這個函數(shù)請自行實現(xiàn) if($plugins) { foreach($plugins as $plugin) {//假定每個插件文件夾中包含一個actions.php文件,它是插件的具體實現(xiàn) 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); } } } } #此處做些日志記錄方面的東西 } /** * 注冊需要監(jiān)聽的插件方法(鉤子) * * @param string $hook * @param object $reference * @param string $method */ function register($hook, &$reference, $method) { //獲取插件要實現(xiàn)的方法 $key = get_class($reference).'->'.$method; //將插件的引用連同方法push進監(jiān)聽數(shù)組中 $this->_listeners[$hook][$key] = array(&$reference, $method); #此處做些日志記錄方面的東西 } /** * 觸發(fā)一個鉤子 * * @param string $hook 鉤子的名稱 * @param mixed $data 鉤子的入?yún)? * @return mixed */ function trigger($hook, $data='') { $result = ''; //查看要實現(xiàn)的鉤子,是否在監(jiān)聽數(shù)組之中 if (isset($this->_listeners[$hook]) && is_array($this->_listeners[$hook]) && count($this->_listeners[$hook]) > 0) { // 循環(huán)調(diào)用開始 foreach ($this->_listeners[$hook] as $listener) { // 取出插件對象的引用和方法 $class =& $listener[0]; $method = $listener[1]; if(method_exists($class,$method)) { // 動態(tài)調(diào)用插件的方法 $result .= $class->$method($data); } } } #此處做些日志記錄方面的東西 return $result; } }
接下來是一個簡單插件的實現(xiàn)DEMO_actions。這是一個簡單的Hello World插件,用于輸出一句話。在實際情況中,say_hello可能包括對數(shù)據(jù)庫的操作,或者是其他一些特定的邏輯。
<?php /** * 這是一個Hello World簡單插件的實現(xiàn) */ /** *需要注意的幾個默認規(guī)則: * 1. 本插件類的文件名必須是action * 2. 插件類的名稱必須是{插件名_actions} */ class DEMO_actions { //解析函數(shù)的參數(shù)是pluginManager的引用 function __construct(&$pluginManager) { //注冊這個插件 //第一個參數(shù)是鉤子的名稱 //第二個參數(shù)是pluginManager的引用 //第三個是插件所執(zhí)行的方法 $pluginManager->register('demo', $this, 'say_hello'); } function say_hello() { echo 'Hello World'; } }