深入解讀PHP插件機(jī)制原理
我們?cè)谶@篇文章中主要向大家講了一些PHP插件機(jī)制的實(shí)現(xiàn)方法。希望大家可以通過(guò)本問(wèn)介紹的內(nèi)容初步了解對(duì)PHP插件機(jī)制的認(rèn)識(shí)。#t#
插件,亦即Plug-in,是指一類特定的功能模塊(通常由第三方開(kāi)發(fā)者實(shí)現(xiàn)),它的特點(diǎn)是:當(dāng)你需要它的時(shí)候激活它,不需要它的時(shí)候禁用/刪除它;且無(wú)論是激活還是禁用都不影響系統(tǒng)核心模塊的運(yùn)行,也就是說(shuō)插件是一種非侵入式的模塊化設(shè)計(jì),實(shí)現(xiàn)了核心程序與插件程序的松散耦合。一個(gè)典型的例子就是Wordpress中眾多的第三方插件,比如Akimet插件用于對(duì)用戶的評(píng)論進(jìn)行Spam過(guò)濾。
一個(gè)健壯的PHP插件機(jī)制,我認(rèn)為必須具備以下特點(diǎn):
插件的動(dòng)態(tài)監(jiān)聽(tīng)和加載(Lookup)
插件的動(dòng)態(tài)觸發(fā)
以上兩點(diǎn)的PHP插件機(jī)制實(shí)現(xiàn)均不影響核心程序的運(yùn)行
要在程序中實(shí)現(xiàn)插件,我們首先應(yīng)該想到的就是定義不同的鉤子(Hooks);“鉤子”是一個(gè)很形象的邏輯概念,你可以認(rèn)為它是系統(tǒng)預(yù)留的插件觸發(fā)條件。它的邏輯原理如下:當(dāng)系統(tǒng)執(zhí)行到某個(gè)鉤子時(shí),會(huì)判斷這個(gè)鉤子的條件是否滿足;如果滿足,會(huì)轉(zhuǎn)而先去調(diào)用鉤子所制定的功能,然后返回繼續(xù)執(zhí)行余下的程序;如果不滿足,跳過(guò)即可。這有點(diǎn)像匯編中的“中斷保護(hù)”邏輯。
某些鉤子可能是系統(tǒng)事先就設(shè)計(jì)好的,比如之前我舉的關(guān)于評(píng)論Spam過(guò)濾的鉤子,通常它已經(jīng)由核心系統(tǒng)開(kāi)發(fā)人員設(shè)計(jì)進(jìn)了評(píng)論的處理邏輯中;另外一類鉤子則可能是由用戶自行定制的(由第三方開(kāi)發(fā)人員制定),通常存在于表現(xiàn)層,比如一個(gè)普通的PHP表單顯示頁(yè)面中。
可能你感覺(jué)上面的話比較無(wú)聊,讓人昏昏欲睡;但是要看懂下面我寫的代碼,理解以上PHP插件機(jī)制的原理是必不可少的。
下面進(jìn)行PHP中插件機(jī)制的核心實(shí)現(xiàn),整個(gè)機(jī)制核心分為三大塊:
一個(gè)插件經(jīng)理類:這是核心之核心。它是一個(gè)應(yīng)用程序全局Global對(duì)象。它主要有三個(gè)職責(zé):
負(fù)責(zé)監(jiān)聽(tīng)已經(jīng)注冊(cè)了的所有插件,并實(shí)例化這些插件對(duì)象。
負(fù)責(zé)注冊(cè)所有插件。
當(dāng)鉤子條件滿足時(shí),觸發(fā)對(duì)應(yīng)的對(duì)象方法。
插件的功能實(shí)現(xiàn):這大多由第三方開(kāi)發(fā)人員完成,但需要遵循一定的規(guī)則,這個(gè)規(guī)則是插件機(jī)制所規(guī)定的,因插件機(jī)制的不同而不同,下面的顯示代碼你會(huì)看到這個(gè)規(guī)則。
插件的觸發(fā):也就是鉤子的觸發(fā)條件。具體來(lái)說(shuō)這是一小段代碼,放置在你需要插件實(shí)現(xiàn)的地方,用于觸發(fā)這個(gè)鉤子。
PHP插件機(jī)制原理講了一大堆,下面看看我的實(shí)現(xiàn)方案:
插件經(jīng)理PluginManager類:
以下為PHP插件機(jī)制引用的內(nèi)容:
- < ?
- class PluginManager
- {
- private $_listeners = array();
- public function __construct()
- {
- #這里$plugin數(shù)組包含我們獲取已經(jīng)由用戶
激活的插件信息 - #為演示方便,我們假定$plugin中至少包含
- #$plugin = array(
- # 'name' => '插件名稱',
- # 'directory'=>'插件安裝目錄'
- #);
- $plugins = get_active_plugins();
#這個(gè)函數(shù)請(qǐng)自行實(shí)現(xiàn) - if($plugins)
- {
- foreach($plugins as $plugin)
- {//假定每個(gè)插件文件夾中包含一個(gè)actions.
php文件,它是插件的具體實(shí)現(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);
- }
- }
- }
- }
- #此處做些日志記錄方面的東西
- }
- function register($hook, &$reference,
$method) - {
- //獲取插件要實(shí)現(xiàn)的方法
- $key = get_class($reference).'->'.$method;
- //將插件的引用連同方法push進(jìn)監(jiān)聽(tīng)數(shù)組中
- $this->_listeners[$hook][$key] =
array(&$reference, $method); - #此處做些日志記錄方面的東西
- }
- function trigger($hook, $data='')
- {
- $result = '';
- //查看要實(shí)現(xiàn)的鉤子,是否在監(jiān)聽(tīng)數(shù)組之中
- if (isset($this->_listeners[$hook])
&& is_array($this->_listeners[$hook])
&& count($this->_listeners[$hook]) > 0) - {
- // 循環(huán)調(diào)用開(kāi)始
- foreach ($this->_listeners[$hook] as $listener)
- {
- // 取出插件對(duì)象的引用和方法
- $class =& $listener[0];
- $method = $listener[1];
- if(method_exists($class,$method))
- {
- // 動(dòng)態(tài)調(diào)用插件的方法
- $result .= $class->$method($data);
- }
- }
- }
- #此處做些日志記錄方面的東西
- return $result;
- }
- }
- ?>
以上代碼加上注釋不超過(guò)100行,就完成了整個(gè)插件機(jī)制的核心。需要再次說(shuō)明的是,你必須將它設(shè)置成全局類,在所有需要用到插件的地方,優(yōu)先加載。用#注釋的地方是你需要自行完成的部分,包括PHP插件機(jī)制的獲取和日志記錄等等。