這篇文章的出發點是我對插件機制的理解,及其在PHP中的實現。此方案僅是插件機制在PHP中的實現方案之一,寫下來和大家分享,歡迎大家一起討論。
插件,亦即Plug-in,是指一類特定的功能模塊(通常由第三方開發者實現),它的特點是:當你需要它的時候激活它,不需要它的時候禁用/刪除它;且無論是激活還是禁用都不影響系統核心模塊的運行,也就是說插件是一種非侵入式的模塊化設計,實現了核心程序與插件程序的松散耦合。一個典型的例子就是Wordpress中眾多的第三方插件,比如Akimet插件用于對用戶的評論進行Spam過濾。
一個健壯的插件機制,我認為必須具備以下特點:
插件的動態監聽和加載(Lookup)
插件的動態觸發
以上兩點的實現均不影響核心程序的運行
要在程序中實現插件,我們首先應該想到的就是定義不同的鉤子(Hooks);“鉤子”是一個很形象的邏輯概念,你可以認為它是系統預留的插件觸發條件。它的邏輯原理如下:當系統執行到某個鉤子時,會判斷這個鉤子的條件是否滿足;如果滿足,會轉而先去調用鉤子所制定的功能,然后返回繼續執行余下的程序;如果不滿足,跳過即可。這有點像匯編中的“中斷保護”邏輯。
某些鉤子可能是系統事先就設計好的,比如之前我舉的關于評論Spam過濾的鉤子,通常它已經由核心系統開發人員設計進了評論的處理邏輯中;另外一類鉤子則可能是由用戶自行定制的(由第三方開發人員制定),通常存在于表現層,比如一個普通的PHP表單顯示頁面中。
可能你感覺上面的話比較無聊,讓人昏昏欲睡;但是要看懂下面我寫的代碼,理解以上的原理是必不可少的。
下面進行PHP中插件機制的核心實現,整個機制核心分為三大塊:
一個插件經理類:這是核心之核心。它是一個應用程序全局Global對象。它主要有三個職責:
負責監聽已經注冊了的所有插件,并實例化這些插件對象。
負責注冊所有插件。
當鉤子條件滿足時,觸發對應的對象方法。
插件的功能實現:這大多由第三方開發人員完成,但需要遵循一定的規則,這個規則是插件機制所規定的,因插件機制的不同而不同,下面的顯示代碼你會看到這個規則。
插件的觸發:也就是鉤子的觸發條件。具體來說這是一小段代碼,放置在你需要插件實現的地方,用于觸發這個鉤子。
原理講了一大堆,下面看看我的實現方案:
插件經理PluginManager類:
以下為引用的內容: <? /** * STBLOG PluginManager Class * * 插件機制的實現核心類 * * @package STBLOG * @subpackage Libraries * @category Libraries * @author Saturn * @link http://www.cnsaturn.com/ */ 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; } } ?> |
以上代碼加上注釋不超過100行,就完成了整個插件機制的核心。需要再次說明的是,你必須將它設置成全局類,在所有需要用到插件的地方,優先加載。用#注釋的地方是你需要自行完成的部分,包括插件的獲取和日志記錄等等。