模块开发概述

微粤宝模块开发指南

阅读本章内容之前请确定已了解微粤宝工作流程.

本章内容主要介绍如何编写及发布微粤宝功能模块. 微粤宝功能模块是微粤宝系统中扩展的独立功能, 微粤宝系统提供了相应的机制来安装, 卸载和更新模块.

描述及配置 目录结构 基本模块(WeModule) 处理器(WeProcessor) 订阅器(WeReceiver) 页面及微站(WeSite) 发布模块

模块开发

开发者可以以模块插件的方式来任意扩展微粤宝系统的功能供公众号使用.

模块开发流程

开始编写微粤宝模块,您应当首先对模块实现的流程有一个大致的了解,以下是我们推荐的模块编写流程:

您应该对微粤宝系统运行原理有一个大概的了解,推荐您查看微粤宝执行主流程介绍。 对模块做一个概括性的设计,例如:需要使用什么后台菜单、配置哪些选项、数据结构如何设计、是否需要嵌入规则、是否需要前台微站展示、是否需要订阅系统消息。 利用 模块设计器 来生成模块的基本目录及manifest.xml配置文件。 编写相应程序代码和模板语句,实现所需的功能并进行代码测试、兼容性测试和代码改进。 开发完成后,您需要完善模块目录下的 manifest.xml 文件中的 <install><![CDATA[模块安装脚本]]></install>

<uninstall><![CDATA[卸载脚本]]></uninstall>

<upgrade><![CDATA[模块升级脚本]]></upgrade>节点。

如果需要公开您的插件,您可以将模块目录打包发布(微粤宝论坛)。同时,编写一个适合新手的插件的说明书也是必不可少的,其中包括:插件适用的微粤宝版本、功能概述、使用方法等等。 将模块提供给他人,或自己使用,根据使用者反馈,对模块进行完善。

模块开发规范

编写微粤宝模块,您应该保持一个良好的代码书写及文件命名规范,以下是几点需要注意的地方:

您可以查看模块目录结构,对模块文件结构有一个大概的了解。 模块的{identifie}(唯一标识)推荐您使用有意义的英文单词来命名。为了避免冲突,您可以加前缀,例如:wdl_photomaker。 模块内的文件名以英文小写命名,设计模块时我们推荐您使用模块设计器(http://localhost/web/index.php?c=extension&a=module&do=designer&)自动生成目录结构。 如果模块中您存放了Css、Js等资源,我们推荐您引用时使用 ../addons/模块目录名 /template/ 中 如果微粤宝页面功能定义类(site.php)中代码过多,我们推荐您分散到 inc 目录中来组织代码结构。文件皆以英文小写命名、以 .inc.php 结尾。doMobileXxx对应在 inc/mobile/xxx.inc.php 中,doWebXxx存放在inc/web/xxx.inc.php中。 在开发微粤宝界面文件的时候,均以.html结尾,页面头尾需要包含系统的头尾文件,{template 'common/header'}正文内容{template 'common/footer'}。您可以查看模板机制

您还需要了解的一些事情

看过以上的文档,应该会对微粤宝开发有一个比较直观的认识,接下来如果您要深入的开发功能,还需要查下以下文档:

全局变量和预定义常量 辅助函数 Js库、页面设计规范

一些简单的范例 模块 *便利店模块实例 风格 第三方服务

联系我们

公司地址: 广州市黄埔区黄埔东路5号东城国际2502

邮箱地址:gzzy@020ziyu.com

公众号:微粤宝

官网网站: http://www.020ziyu.com

服务热线: 020-29883380