PHP中插件機制的一種實現方案

插件,亦即Plug-in,是指一類特定的功能模塊(通常由第三方開發者實現),它的特點是:當你需要它的時候激活它,不需要它的時候禁用/刪除它;且無 論是激活還是禁用都不影響系統核心模塊的運行,也就是說插件是一種非侵入式的模塊化設計,實現了核心程序與插件程序的松散耦合。一個典型的例子就是 Wordpress中眾多的第三方插件,比如Akimet插件用于對用戶的評論進行Spam過濾。

一個健壯的插件機制,我認為必須具備以下特點:

  • 插件的動態監聽和加載(Lookup)?
  • 插件的動態觸發?
  • 以上兩點的實現均不影響核心程序的運行

?

要在程序中實現插件,我們首先應該想到的就是定義不同的鉤子(Hooks);“鉤子”是一個很形象的邏輯概念,你可以認為它是系統預留的插件觸發條件。它 的邏輯原理如下:當系統執行到某個鉤子時,會判斷這個鉤子的條件是否滿足;如果滿足,會轉而先去調用鉤子所制定的功能,然后返回繼續執行余下的程序;如果 不滿足,跳過即可。這有點像匯編中的“中斷保護”邏輯。

某些鉤子可能是系統事先就設計好的,比如之前我舉的關于評論Spam過濾的鉤子,通常它已經由核心系統開發人員設計進了評論的處理邏輯中;另外一類鉤子則 可能是由用戶自行定制的(由第三方開發人員制定),通常存在于表現層,比如一個普通的PHP表單顯示頁面中。

可能你感覺上面的話比較無聊,讓人昏昏欲睡;但是要看懂下面我寫的代碼,理解以上的原理是必不可少的。

下面進行PHP中插件機制的核心實現,整個機制核心分為三大塊:

  • 一個插件經理類:這是核心之核心。它是一個應用程序全局Global對象。它主要有三個職責:?
    • 負責監聽已經注冊了的所有插件,并實例化這些插件對象。?
    • 負責注冊所有插件。?
    • 當鉤子條件滿足時,觸發對應的對象方法。

         

  • 插件的功能實現:這大多由第三方開發人員完成,但需要遵循一定的規則,這個規則是插件機制所規定的,因插件機制的不同而不同,下面的顯 示代碼你會看到這個規則。?
  • 插件的觸發:也就是鉤子的觸發條件。具體來說這是一小段代碼,放置在你需要插件實現的地方,用于觸發這個鉤子。

?

原理講了一大堆,下面看看我的實現方案:

插件經理PluginManager類:

  1 <?
  2 /**
  3 * STBLOG PluginManager Class
  4 *
  5 * 插件機制的實現核心類
  6 *
  7 * @package        STBLOG
  8 * @subpackage    Libraries
  9 * @category    Libraries
 10 * @author        Saturn
 11 */
 12 class PluginManager
 13 {
 14     /**
 15      * 監聽已注冊的插件
 16      *
 17      * @access private
 18      * @var array
 19      */
 20     private $_listeners = array();
 21      /**
 22      * 構造函數
 23      *  
 24      * @access public
 25      * @return void
 26      */
 27     public function __construct()
 28     {
 29         #這里$plugin數組包含我們獲取已經由用戶激活的插件信息
 30      #為演示方便,我們假定$plugin中至少包含
 31      #$plugin = array(
 32         #    'name' => '插件名稱',
 33         #    'directory'=>'插件安裝目錄'
 34         #);
 35         $plugins = get_active_plugins();#這個函數請自行實現
 36         if($plugins)
 37         {
 38             foreach($plugins as $plugin)
 39             {//假定每個插件文件夾中包含一個actions.php文件,它是插件的具體實現
 40                 if (@file_exists(STPATH .'plugins/'.$plugin['directory'].'/actions.php'))
 41                 {
 42                     include_once(STPATH .'plugins/'.$plugin['directory'].'/actions.php');
 43                     $class = $plugin['name'].'_actions';
 44                     if (class_exists($class))  
 45                     {
 46                         //初始化所有插件
 47                         new $class($this);
 48                     }
 49                 }
 50             }
 51         }
 52         #此處做些日志記錄方面的東西
 53     }
 54      
 55     /**
 56      * 注冊需要監聽的插件方法(鉤子)
 57      *
 58      * @param string $hook
 59      * @param object $reference
 60      * @param string $method
 61      */
 62     function register($hook, &$reference, $method)
 63     {
 64         //獲取插件要實現的方法
 65         $key = get_class($reference).'->'.$method;
 66         //將插件的引用連同方法push進監聽數組中
 67         $this->_listeners[$hook][$key] = array(&$reference, $method);
 68         #此處做些日志記錄方面的東西
 69     }
 70     /**
 71      * 觸發一個鉤子
 72      *
 73      * @param string $hook 鉤子的名稱
 74      * @param mixed $data 鉤子的入參
 75      *    @return mixed
 76      */
 77     function trigger($hook, $data='')
 78     {
 79         $result = '';
 80         //查看要實現的鉤子,是否在監聽數組之中
 81         if (isset($this->_listeners[$hook]) && is_array($this->_listeners[$hook]) && count($this->_listeners[$hook]) > 0)
 82         {
 83             // 循環調用開始
 84             foreach ($this->_listeners[$hook] as $listener)
 85             {
 86                 // 取出插件對象的引用和方法
 87                 $class =& $listener[0];
 88                 $method = $listener[1];
 89                 if(method_exists($class,$method))
 90                 {
 91                     // 動態調用插件的方法
 92                     $result .= $class->$method($data);
 93                 }
 94             }
 95         }
 96         #此處做些日志記錄方面的東西
 97         return $result;
 98     }
 99 }
100 ?>

?

以上代碼加上注釋不超過100行,就完成了整個插件機制的核心。需要再次說明的是,你必須將它設置成全局類,在所有 需要用到插件的地方,優先加載。用#注釋的地方是你需要自行完成的部分,包括插件的獲取和日志記錄等等。

下面是一個簡單插件的實現。    

 1 <?
 2 /**
 3 * 這是一個Hello World簡單插件的實現
 4 *
 5 * @package        DEMO
 6 * @subpackage    DEMO
 7 * @category    Plugins
 8 * @author        Saturn
 9 */
10 /**
11 *需要注意的幾個默認規則:
12 *    1. 本插件類的文件名必須是action
13 *    2. 插件類的名稱必須是{插件名_actions}
14 */
15 class DEMO_actions
16 {
17     //解析函數的參數是pluginManager的引用
18     function __construct(&$pluginManager)
19     {
20         //注冊這個插件
21         //第一個參數是鉤子的名稱
22         //第二個參數是pluginManager的引用
23         //第三個是插件所執行的方法
24         $pluginManager->register('demo', $this, 'say_hello');
25     }
26      
27     function say_hello()
28     {
29         echo 'Hello World';
30     }
31 }
32 ?>  

?

這是一個簡單的Hello World插件,用于輸出一句話。在實際情況中,say_hello可能包括對數據庫的操作,或者是其他一些特定的邏輯,比如調用Akimet API。

插件實現的默認規則由核心系統開發者自行確定。比如本例的一些默認規則我在注釋中已經寫的很清楚,在此不在贅述。需要特別注意的是鉤子名稱不要重復。

最后一步,就是定義鉤子的觸發,你將鉤子放在哪里,上面這個插件的方法就會在哪里出發。比如我要將say_hello放到我博客首頁Index.php, 那么你在index.php中的某個位置寫下:

$pluginManager->trigger('demo','');


第一個參數表示鉤子的名字,在本例中它是demo;第二個參數是插件對應方法的入口參數,由于這個例子中沒有輸入參數,所以為空。

總結?

本篇文章介紹了插件機制在PHP中實現的一種方法和思路,以及我本人對插件機制的理解。初次接觸這個東西,可能會比較生澀,難以理解。但是當你結合真實的 例子,再想想程序的運行流程,思路可能會更清晰一些。

轉載于:https://www.cnblogs.com/tianakong/p/10760839.html

本文來自互聯網用戶投稿,該文觀點僅代表作者本人,不代表本站立場。本站僅提供信息存儲空間服務,不擁有所有權,不承擔相關法律責任。
如若轉載,請注明出處:http://www.pswp.cn/news/449140.shtml
繁體地址,請注明出處:http://hk.pswp.cn/news/449140.shtml
英文地址,請注明出處:http://en.pswp.cn/news/449140.shtml

如若內容造成侵權/違法違規/事實不符,請聯系多彩編程網進行投訴反饋email:809451989@qq.com,一經查實,立即刪除!

相關文章

python模塊學習之glob模塊

glob模塊 功能描述&#xff1a;glob模塊可以使用Unix shell風格的通配符匹配符合特定格式的文件和文件夾&#xff0c;跟windows的文件搜索功能差不多。glob模塊并非調用一個子shell實現搜索功能&#xff0c;而是在內部調用了os.listdir()和fnmatch.fnmatch()。查看我之前寫的fn…

根據一個屬性,剔除 Json 中重復元素(刪除 JSON 中重復的部分)

前些天發現了一個巨牛的人工智能學習網站&#xff0c;通俗易懂&#xff0c;風趣幽默&#xff0c;忍不住分享一下給大家。點擊跳轉到教程。 [ {"data" : {"code" : "044","post" : "xxx領導", "email" : "…

給生命一個助跑的過程(圖)

在高原的上空&#xff0c;常常可以見到禿鷲在翱翔。 禿鷲又叫座山雕&#xff0c;也被人譽為“神鷹”&#xff0c;是高原上體格最大的猛禽。它們往往棲息在海拔2000-5000多米的高山原上&#xff0c;體重達到7-11公斤。禿鷲張開翅膀后&#xff0c;整個身體有2米多長&#xff0c;…

ELK 構建 MySQL 慢日志收集平臺詳解

ELK 介紹 ELK 最早是 Elasticsearch&#xff08;以下簡稱ES&#xff09;、Logstash、Kibana 三款開源軟件的簡稱&#xff0c;三款軟件后來被同一公司收購&#xff0c;并加入了Xpark、Beats等組件&#xff0c;改名為Elastic Stack&#xff0c;成為現在最流行的開源日志解決方案&…

數據類型轉換規則C語言

一、數據類型 為什么對數據進行分類&#xff1a;節約存儲空間&#xff0c;提高運行速度。整型&#xff1a;signedsigned char 1 -128~127signed short 2 -32678~32767signed int 4 正負20億signed long 4/8 正負20億/9…

Visual Studio 的碼云擴展 V1.0.85 發布

開發四年只會寫業務代碼&#xff0c;分布式高并發都不會還做程序員&#xff1f; >>> Visual Studio 的碼云擴展 V1.0.85 已發布&#xff1a; 針對擴展進行了SDK部分的重寫修正克隆窗體和快捷方式的圖標顏色隨主題變化修正快捷方式 優化用戶登錄和token處理機制調整了…

用 FastJSON 將 JSON 字符串轉換為 Map

前些天發現了一個巨牛的人工智能學習網站&#xff0c;通俗易懂&#xff0c;風趣幽默&#xff0c;忍不住分享一下給大家。點擊跳轉到教程。 本文是利用阿里巴巴封裝的FastJSON來轉換json字符串的。例子如下&#xff1a; import com.alibaba.fastjson.JSON; import com.aliba…

shark恒破解筆記4-API斷點GetPrivateProfileStringA

這小節是通過斷在GetPrivateProfileStringA&#xff0c;然后找到注冊碼的。 1.運行程序輸入假碼111111&#xff0c;提示重啟。通過這判斷這是一個重啟來驗證的&#xff0c;那么它是如何來驗證的呢&#xff1f;觀察程序目錄下會發現有一個名為“config.ini"的文件 那么判斷…

開關語句、循環語句、goto

復習&#xff1a; 1、數據類型&#xff1a;signed char 1 %hhd -128~127signed short 2 %hd -32768~32767signed int 4 %d 正負20億signed long 4 %ldsigned long long 8 %lld 9天開頭的19位數unsigned char …

成功男士的健康心理特征

自信&#xff1a;他們普遍都有很強的自信心&#xff0c;有時有咄咄逼人的感覺。 急迫感&#xff1a;他們通常很急地想見到事物的成果&#xff0c;因此會給別人帶來許多的壓力。他們信仰“時間就是金錢”&#xff0c;不喜歡也不會把寶貴的時間浪費在瑣碎的無聊事情上。 腳踏實…

DBlink的創建與刪除

創建方式一&#xff1a; create [public] database link link名稱 connect to 對方數據庫用戶identified by 對方數據庫用戶密碼 using 對方數據庫ip:端口/服務名; 創建方式二&#xff1a; create [public] database link link名稱 connect to 對方數據庫用戶identified by 對…

kong 啟動報錯 could not retrieve server_version: timeout

前些天發現了一個巨牛的人工智能學習網站&#xff0c;通俗易懂&#xff0c;風趣幽默&#xff0c;忍不住分享一下給大家。點擊跳轉到教程。 報錯&#xff1a; nginx: [error] init_by_lua error: /usr/local/share/lua/5.1/kong/init.lua:169: [postgres error] could not ret…

2-STM32物聯網開發WIFI(ESP8266)+GPRS(Air202)系統方案安全篇(監聽Wi-Fi和APP的數據)

1-STM32物聯網開發WIFI(ESP8266)GPRS(Air202)系統方案安全篇(來看一下怎么樣監聽網絡數據,監聽電腦上位機軟件的數據) 因為那個軟件只能監聽咱自己電腦上的數據,所以咱就用電腦開個熱點,然后讓Wi-Fi和APP連接咱電腦的熱點,這樣就能監聽數據了 電腦開個熱點 手機APP連接這個熱點…

數組越界的后果

數組&#xff1a; 什么是數組&#xff1a;變量的組合&#xff0c;是一種批量定義變量的方式。 定義&#xff1a;類型 數組名[數量];int arr[5]; 使用&#xff1a;數組名[下標];下標&#xff1a;從零開始&#xff0c;范圍&#xff1a;0~數量-1。 遍歷&#xff1a;與for循環配合…

職場心理:12個建議或許能改變你的一生(圖)

心理引言&#xff1a;如何更好實現自我的職業目標&#xff1f;聽起來很簡單&#xff0c;回答也很簡短&#xff0c;就是你必須清楚你最終想要實現什么&#xff1f;只要你這樣做&#xff0c;你就已經開始從看的見和看不見的兩條路徑來實現你的目標。職場是一種特殊的環境&#xf…

python—包

1.模塊 可以增加代碼的重復利用的方式 避免命名沖突 如何定義模塊 模塊就是一個普通文件&#xff0c;所以任何代碼可以直接書寫規范 函數&#xff08;單一的功能&#xff09;類&#xff08;相似功能的組合&#xff0c;或者類似業務模塊&#xff09;測試代碼 如何使用模塊 模塊…

Docker Installation : Docker 中安裝并啟動 Kong

前些天發現了一個巨牛的人工智能學習網站&#xff0c;通俗易懂&#xff0c;風趣幽默&#xff0c;忍不住分享一下給大家。點擊跳轉到教程。 Details about how to use Kong in Docker can be found on the DockerHub repository hosting the image: kong. We also have a Docke…

tomcat是否有必要配置環境變量(摘)

之前發表了一篇關于如何安裝和配置Tomcat的文章&#xff0c;而最近在開發項目的時候總是報錯。后來被公司的大神問了一句&#xff1a;是誰告訴你Tomcat是需要配置環境變量的&#xff1f; 作為新手的我瞬間整個人都不好了&#xff01;于是偷偷百度了一下&#xff0c;終于找到了關…

走迷宮+推箱子

兩個小游戲的大致邏輯 走迷宮: 1、定義二維字符數組作為迷宮 2、定義變量記錄老鼠的位置 3、獲取游戲開始時間 3、進入循環 1、清理屏幕&#xff0c;使用system調用系統命令。 2、顯示迷宮(遍歷二維字符數組) 3、檢查是否到達出口 獲取游戲結束時間&#xff0c;計算出走出迷宮用…

Facebook開源ptr:在Python環境中并行運行單元測試

Facebook開源了一個名為Python Test Runner&#xff08;ptr&#xff09;的新項目&#xff0c;允許開發人員運行Python單元測試套件。ptr和現有測試運行器之間的主要區別在于ptr通過爬取存儲庫查找一定的Python項目&#xff0c;這些項目帶有的單元測試在安裝文件中已經定義過。 …