PHP中插件机制的1种实现方案
核心提示:这篇文章的动身点是我对插件机制的理解,及其在PHP中的实现。此方案仅是插件机制在PHP中的实现方案之1,写下来和大家分享,欢迎大家1起讨论。
这篇文章的动身点是我对插件机制的理解,及其在PHP中的实现。此方案仅是插件机制在PHP中的实现方案之1,写下来和大家分享,欢迎大家1起讨论。
插件,亦即Plug-in,是指1类特定的功能模块(通常由第3方开发者实现),它的特点是:当你需要它的时候激活它,不需要它的时候禁用/删除它;且不论是激活还是禁用都不影响系统核心模块的运行,也就是说插件是1种非侵进式的模块化设计,实现了核心程序与插件程序的疏松耦合。1个典型的例子就是Wordpress中众多的第3方插件,比如Akimet插件用于对用户的评论进行Spam过滤。
1个硬朗的插件机制,我以为必须具有以下特点:
插件的动态监听和加载(Lookup)
插件的动态触发
以上两点的实现均不影响核心程序的运行
要在程序中实现插件,我们首先应当想到的就是定义不同的钩子(Hooks);“钩子”是1个很形象的逻辑概念,你可以以为它是系统预留的插件触发条件。它的逻辑原理以下:当系统履行到某个钩子时,会判定这个钩子的条件是否是满足;假设满足,会转而先往调用钩子所制定的功能,然后返回继续履行余下的程序;假设不满足,跳过即可。这有点像汇编中的“中断保护”逻辑。
某些钩子多是系统事前就设计好的,比如之前我举的关于评论Spam过滤的钩子,通常它已过核心系统开发职员设计进了评论的处理逻辑中;另外1类钩子则多是由用户自行定制的(由第3方开发职员制定),通常存在于表现层,比如1个普通的PHP表单显示页面中。
可能你感觉上面的话比较无聊,让人昏昏欲睡;但是要看懂下面我写的代码,理解以上的原理是必不可少的。
下面进行PHP中插件机制的核心实现,全部机制核心分为3大块:
1个插件经理类:这是核心之核心。它是1个利用程序全局Global对象。它主要有3个职责:
负责监听已注册了的所有插件,并实例化这些插件对象。
负责注册所有插件。
当钩子条件满足时,触发对应的对象方法。
插件的功能实现:这大多由第3方开发职员完成,但需要遵守1定的规则,这个规则是插件机制所规定的,因插件机制的不同而不同,下面的显示代码你会看到这个规则。
插件的触发:也就是钩子的触发条件。具体来讲这是1小段代码,放置在你需要插件实现的地方,用于触发这个钩子。
原理讲了1大堆,下面看看我的实现方案:
插件经理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) {//假定每个插件文件夹中包括1个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); #此处做些日志记录方面的东西 } /** * 触发1个钩子 * * @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行,就完成了全部插件机制的核心。需要再次说明的是,你必须将它设置玉成局类,在所有需要用到插件的地方,优先加载。用#注释的地方是你需要自行完成的部份,包括插件的获得和日志记录等等。
1
2
下1页
核心提示:这篇文章的动身点是我对插件机制的理解,及其在PHP中的实现。此方案仅是插件机制在PHP中的实现方案之1,写下来和大家分享,欢迎大家1起讨论。
下面是1个简单插件的实现。
以下为援用的内容:
/** * 这是1个Hello World简单插件的实现 * * @package DEMO * @subpackage DEMO * @category Plugins * @author Saturn * @link http://www.cnsaturn.com/ */ /** *需要留意的几个默许规则: * 1. 本插件类的文件名必须是action * 2. 插件类的名称必须是{插件名_actions} */ class DEMO_actions { //解析函数的参数是pluginManager的援用 function __construct(&$pluginManager) { //注册这个插件 //第1个参数是钩子的名称 //第2个参数是pluginManager的援用 //第3个是插件所履行的方法 $pluginManager->register('demo', $this, 'say_hello'); } function say_hello() { echo 'Hello World'; } } ?>
|
这是1个简单的Hello World插件,用于输出1句话。在实际情况中,say_hello可能包括对数据库的操纵,或是其他1些特定的逻辑,比如调用Akimet API。
插件实现的默许规则由核心系统开发者自行肯定。比如本例的1些默许规则我在注释中已写的很清楚,在此不在赘述。需要特别留意的是钩子名称不要重复。
最后1步,就是定义钩子的触发,你将钩子放在哪里,上面这个插件的方法就会在哪里动身。比如我要将say_hello放到我博客首页Index.php,那末你在index.php中的某个位置写下:
以下为援用的内容:
$pluginManager->trigger('demo','');
|
第1个参数表示钩子的名字,在本例中它是demo;第2个参数是插件对应方法的进口参数,由于这个例子中没有输进参数,所以为空。
总结
本篇文章先容了插件机制在PHP中实现的1种方法和思路,和我本人对插件机制的理解。初次接触这个东西,可能会比较生涩,难以理解。但是当你结合真实的例子,再想想程序的运行流程,思路可能会更清楚1些。
本文链接:http://www.blueidea.com/tech/program/2009/7153.asp
上1页
1
2
唐山网站建设www.fw8.net
TAG:
方法,
钩子,
机制,
插件,
核心