深入解读PHP插件机制原理

我们在这篇文章中主要向大家讲了一些

插件，亦即Plug-in，是指一类特定的功能模块（通常由第三方开发者实现），它的特点是：当你需要它的时候激活它，不需要它的时候禁用/删除它；且无论是激活还是禁用都不影响系统核心模块的运行，也就是说插件是一种非侵入式的模块化设计，实现了核心程序与插件程序的松散耦合。一个典型的例子就是Wordpress中众多的第三方插件，比如Akimet插件用于对用户的评论进行Spam过滤。

一个健壮的PHP插件机制，我认为必须具备以下特点：

插件的动态监听和加载（Lookup）

插件的动态触发

以上两点的PHP插件机制实现均不影响核心程序的运行

要在程序中实现插件，我们首先应该想到的就是定义不同的钩子（Hooks）；“钩子”是一个很形象的逻辑概念，你可以认为它是系统预留的插件触发条件。它的逻辑原理如下：当系统执行到某个钩子时，会判断这个钩子的条件是否满足；如果满足，会转而先去调用钩子所制定的功能，然后返回继续执行余下的程序；如果不满足，跳过即可。这有点像汇编中的“中断保护”逻辑。

某些钩子可能是系统事先就设计好的，比如之前我举的关于评论Spam过滤的钩子，通常它已经由核心系统开发人员设计进了评论的处理逻辑中；另外一类钩子则可能是由用户自行定制的（由第三方开发人员制定），通常存在于表现层，比如一个普通的PHP表单显示页面中。

可能你感觉上面的话比较无聊，让人昏昏欲睡；但是要看懂下面我写的代码，理解以上PHP插件机制的原理是必不可少的。

下面进行PHP中插件机制的核心实现，整个机制核心分为三大块：

一个插件经理类：这是核心之核心。它是一个应用程序全局Global对象。它主要有三个职责：

负责监听已经注册了的所有插件，并实例化这些插件对象。

负责注册所有插件。

当钩子条件满足时，触发对应的对象方法。

插件的功能实现：这大多由第三方开发人员完成，但需要遵循一定的规则，这个规则是插件机制所规定的，因插件机制的不同而不同，下面的显示代码你会看到这个规则。

插件的触发：也就是钩子的触发条件。具体来说这是一小段代码，放置在你需要插件实现的地方，用于触发这个钩子。

PHP插件机制原理讲了一大堆，下面看看我的实现方案：

插件经理PluginManager类：

以下为PHP插件机制引用的内容：

1. ?
2. class PluginManager
3. {
4. private $_listeners = array();
5. public function __construct()
6. {
7. #这里$plugin数组包含我们获取已经由用户
   激活的插件信息
8. #为演示方便，我们假定$plugin中至少包含
9. #$plugin = array(
10. # 'name' => '插件名称',
11. # 'directory'=>'插件安装目录'
12. #);
13. $plugins = get_active_plugins();
    #这个函数请自行实现
14. if($plugins)
15. {
16. foreach($plugins as $plugin)
17. {//假定每个插件文件夹中包含一个actions.
    php文件，它是插件的具体实现
18. if (@file_exists(STPATH .'plugins/'.
    $plugin['directory'].'/actions.php'))
19. {
20. include_once(STPATH .'plugins/'.
    $plugin['directory'].'/actions.php');
21. $class = $plugin['name'].'_actions';
22. if (class_exists($class))
23. {
24. //初始化所有插件
25. new $class($this);
26. }
27. }
28. }
29. }
30. #此处做些日志记录方面的东西
31. }
32. function register($hook, &$reference,
    $method)
33. {
34. //获取插件要实现的方法
35. $key = get_class($reference).'->'.$method;
36. //将插件的引用连同方法push进监听数组中
37. $this->_listeners[$hook][$key] =
    array(&$reference, $method);
38. #此处做些日志记录方面的东西
39. }
40. function trigger($hook, $data='')
41. {
42. $result = '';
43. //查看要实现的钩子，是否在监听数组之中
44. if (isset($this->_listeners[$hook])
    && is_array($this->_listeners[$hook])
    && count($this->_listeners[$hook]) > 0)
45. {
46. // 循环调用开始
47. foreach ($this->_listeners[$hook] as $listener)
48. {
49. // 取出插件对象的引用和方法
50. $class =& $listener[0];
51. $method = $listener[1];
52. if(method_exists($class,$method))
53. {
54. // 动态调用插件的方法
55. $result .= $class->$method($data);
56. }
57. }
58. }
59. #此处做些日志记录方面的东西
60. return $result;
61. }
62. }
63. ?>

以上代码加上注释不超过100行，就完成了整个插件机制的核心。需要再次说明的是，你必须将它设置成全局类，在所有需要用到插件的地方，优先加载。用#注释的地方是你需要自行完成的部分，包括PHP插件机制的获取和日志记录等等。