插件,亦即Plug-in,是指一類特定的功能模塊(一般由第三方開發者實現),它的特色是:當你須要它的時候激活它,不須要它的時候禁用/刪除它;且無 論是激活仍是禁用都不影響系統核心模塊的運行,也就是說插件是一種非侵入式的模塊化設計,實現了核心程序與插件程序的鬆散耦合。一個典型的例子就是 Wordpress中衆多的第三方插件,好比Akimet插件用於對用戶的評論進行Spam過濾。
一個健壯的插件機制,我認爲必須具有如下特色:php
- 插件的動態監聽和加載(Lookup)
- 插件的動態觸發
- 以上兩點的實現均不影響核心程序的運行
要在程序中實現插件,咱們首先應該想到的就是定義不一樣的鉤子(Hooks);「鉤子」是一個很形象的邏輯概念,你能夠認爲它是系統預留的插件觸發條件。它 的邏輯原理以下:當系統執行到某個鉤子時,會判斷這個鉤子的條件是否知足;若是知足,會轉而先去調用鉤子所制定的功能,而後返回繼續執行餘下的程序;若是 不知足,跳過便可。這有點像彙編中的「中斷保護」邏輯。
某些鉤子多是系統事先就設計好的,好比以前我舉的關於評論Spam過濾的鉤子,一般它已經由核心系統開發人員設計進了評論的處理邏輯中;另一類鉤子則 多是由用戶自行定製的(由第三方開發人員制定),一般存在於表現層,好比一個普通的PHP表單顯示頁面中。
可能你感受上面的話比較無聊,讓人昏昏欲睡;可是要看懂下面我寫的代碼,理解以上的原理是必不可少的。
下面進行PHP中插件機制的核心實現,整個機制核心分爲三大塊:面試
- 一個插件經理類:這是核心之核心。它是一個應用程序全局Global對象。它主要有三個職責:
- 負責監聽已經註冊了的全部插件,並實例化這些插件對象。
- 負責註冊全部插件。
- 當鉤子條件知足時,觸發對應的對象方法。
- 插件的功能實現:這大多由第三方開發人員完成,但須要遵循必定的規則,這個規則是插件機制所規定的,因插件機制的不一樣而不一樣,下面的顯 示代碼你會看到這個規則。
- 插件的觸發:也就是鉤子的觸發條件。具體來講這是一小段代碼,放置在你須要插件實現的地方,用於觸發這個鉤子。
原理講了一大堆,下面看看個人實現方案:
插件經理PluginManager類:數據庫
<? /** * STBLOG PluginManager Class * * 插件機制的實現核心類 * * @package STBLOG * @subpackage Libraries * @category Libraries * @author Saturn */ 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行,就完成了整個插件機制的核心。須要再次說明的是,你必須將它設置成全局類,在全部 須要用到插件的地方,優先加載。用#註釋的地方是你須要自行完成的部分,包括插件的獲取和日誌記錄等等。數組
下面是一個簡單插件的實現。 微信
<? /** * 這是一個Hello World簡單插件的實現 * * @package DEMO * @subpackage DEMO * @category Plugins * @author Saturn */ /** *須要注意的幾個默認規則: * 1. 本插件類的文件名必須是action * 2. 插件類的名稱必須是{插件名_actions} */ class DEMO_actions { //解析函數的參數是pluginManager的引用 function __construct(&$pluginManager) { //註冊這個插件 //第一個參數是鉤子的名稱 //第二個參數是pluginManager的引用 //第三個是插件所執行的方法 $pluginManager->register('demo', $this, 'say_hello'); } function say_hello() { echo 'Hello World'; } } ?>
這是一個簡單的Hello World插件,用於輸出一句話。在實際狀況中,say_hello可能包括對數據庫的操做,或者是其餘一些特定的邏輯,好比調用Akimet API。架構
插件實現的默認規則由核心系統開發者自行肯定。好比本例的一些默認規則我在註釋中已經寫的很清楚,在此不在贅述。須要特別注意的是鉤子名稱不要重複。併發
最後一步,就是定義鉤子的觸發,你將鉤子放在哪裏,上面這個插件的方法就會在哪裏出發。好比我要將say_hello放到我博客首頁Index.php, 那麼你在index.php中的某個位置寫下:框架
$pluginManager->trigger('demo','');
第一個參數表示鉤子的名字,在本例中它是demo;第二個參數是插件對應方法的入口參數,因爲這個例子中沒有輸入參數,因此爲空。分佈式
總結模塊化
本篇文章介紹了插件機制在PHP中實現的一種方法和思路,以及我本人對插件機制的理解。初次接觸這個東西,可能會比較生澀,難以理解。可是當你結合真實的 例子,再想一想程序的運行流程,思路可能會更清晰一些。
以上內容但願幫助到你們,更多PHP大廠PDF面試文檔,PHP進階架構視頻資料,PHP精彩好文免費獲取能夠微信搜索關注公衆號:PHP開源社區,或者訪問: