Discuz 插件设计
一、Discuz介绍
Discuz是国内比较知名的开源论坛了,后来被腾讯收购,Discuz在设计时就考虑了生态体系的建设,支持插件设计,可以让广大开发者朋友来一起建设生态,不得不说设计者是很有商业头脑的。
回到话题,我们为什么要学习Discuz的插件设计呢,因为假如我们哪天自己想做一套系统,也要支持插件,可以借鉴下相关的设计。
源代码:
https://gitee.com/ComsenzDiscuz/DiscuzX/tree/v3.4-20190917/
插件市场:https://addon.dismall.com/
具体如何安装就不在这里说明了,可以参考官网的说明。
二、插件系统的需 求和场景
在分析Discuz的插件设计之前,我们还是要大概分析下如果设计一个支持插件的系统,系统应该支持哪些功能。
1、安装和反安装
插件安装的过程可能是Mysql中加一些表、将插件的代码覆盖放置到系统可以调用到的地方;
反安装是反过来,如何干净地将插件从系统中删除自己。
2、插件的启用和禁用
这个就不用说了,有些插件可能有些bug,或者和其它插件冲突了,需要临时禁用掉,后面修复问题再启用。
3、插件的加载顺序
因为插件之间可能有加载先后顺序,或者说一个插件依赖另一个插件,就需要设置插件的加载顺序了,这个应该算是用的比较少的场景。
4、插件的自我描述
提供插件名称等信息来描述自己。
5、可以在某个地方以可视化的方式设置插件的参数
插件一般来说是比较通用的,有一些自定义的参数配置,需要在一个地方设置这些插件。
6、能够将自己的接口注入到系统中
插件可能会提供一些接口,这些接口能够被前台的页面调用到,即在浏览器中可以访问。
7、模版的渲染能力
插件必须能渲染自己的页面,可以直接生成页面让前台用户访问。
8、傻瓜式的安装
因为使用网站的人不一定都懂代码,尽量简单、傻瓜式安装,不要有太多安装和运维成本。
9、完善的扩展点
一个设计好的插件应该提供很多扩展点,让插件能够在系统的原有流程上扩充一些能力。
举个例子,支付方式,可以一个插件提供微信,另一个插件提供支付宝的。
在发布帖子后,系统应该要有一种机制让插件捕捉到这个事件,以便做一些操作,像提高用户活跃度,增加积分等操作。
做的更灵活的,甚至可以提供一种机制替换系统的默认实现。
三、Discuz插件机制分析
Discuz插件都是放在 upload/source/plugin目录下,我们一个个来分析实现机制。
以下是其中一个插件的代码目录截图:
1、安装和反安装
2、插件配置
主要是以xml的方式提供。
xml中可以对插件加以说明,关键参数是identifier,这个是插件唯一标识,不能重复。
并且提供参数配置的能力,所有这些符合相应的规范,Discuz自动会加载相应的参数,并且提供保存参数和获取参数的能力。
3、接口注入及页面访问
https://www.xxx.com/plugin.php?id=wechat:sign&operation=qiandao&infloat=1&inajax=1
上面是访问插件 wechat中sign模块,模块以.inc.php结尾,即在插件中查找 sign.inc.php,然后把请求转由该文件处理。
至于如何代码中引入其它文件,系统根目录通过 DISCUZ_ROOT 引用,plugin的目录也确定了,所以只要加上插件自己的目录就可以引用了。
4、模板渲染
模板名以.htm结束,里面可以用PHP代码。
5、插件安装
Discuz安装插件有2种方式,1种是在线安装,1种是下载代码到本地安装。
在线安装通过在后台应用中心操作,前提是你必须登录相应的账号,因为有的插件是必须付费的。
版权声明: 本文为 InfoQ 作者【心平气和】的原创文章。
原文链接:【http://xie.infoq.cn/article/55508a948e0e0e26bcecd93b4】。文章转载请联系作者。
评论