《开发文档》
1.二次开发
该系统采用nodeJS + koa + art-template模板引擎搭建的轻量型开发框架,可快速添加web api接口和网页。让开发更高效、稳定、便于维护。
集成了HTTP、WebSocket、MQTT通讯模块;MySQL、Redis、MongoDB数据库操作模块;email邮箱、phone手机短信、JWT、公众号、image图片裁剪等辅助模块。
因此,基于该系统进行二次开发做网站、APP、小程序、公众号、聊天机器人变得十分简单。
模板开发
主题模板是表现网站是否美观、多样的关键,为了让开发者能更轻松上手模板开发,模板文件均采用html格式文件和简单的模板语法
具体如何开发,请移步#模板开发文档。
挂件开发
挂件是挂载在某个页面的热拔插组件,可实现在已有模板的某个位置展现内容。为了让开发者能更轻松上手挂件开发,挂件开发方式和主题模板类同。
具体如何开发,请移步#挂件开发文档。
插件开发
模块化开发是现在主流的开发方式,更有利于功能的维护和升级。
该系统采用热拔插方式,更有利于管理功能模块,当需要使用到某些功能时可以在后台安装、启用,不需要时停止、卸载即可
详细了解插件开发,请移步#插件开发文档。
应用开发
一般情况下,内容管理系统、资源管理系统、辅助工具系统和微信管理系统已经足够应对市面上大部分需求。
但也有需要开发商城系统、物联网系统、saas系统等需求的时候,这时如果只是在应用上拓展插件,对于后期功能庞大了,维护和升级并不友好。因此需要单独创建应用来完成
应用开发相对与模板开发和插件开发而言比较简单,如果需要开发一个具有用户操作台的应用,可参考app/admin应用。如果需要开发无单独操作台的,可参考app/cms应用
2.公共函数
要想掌握该系统进行二次开发,了解该系统自带的一些公共函数是很有必要的。
这些公共函数可帮助我们快速实现视图渲染、mqtt通讯、图片裁剪、发送邮件、实现授权等
除了系统自带的公共函数,还可以自定义公共函数。在系统根或插件、应用根目录下的com/目录下创建一个目录,并在该目录下创建com.json配置文件即可引用公共函数。配置文件如下:
{
// 公共函数名称
"name": "页面钩子",
// 公共函数脚本文件
"script": "./com.js",
// 是否启用
"state": 1
}
拓展函数
拓展函数统一添加到全局变量$下,这样可以通过Object.keys($), 查看有哪些拓展函数。
拓展函数的调用方法是$.xxx()或者$.xxx.demo(),个别模块作为拓展函数时则用var xxx = new $.XXX()方式实例化后使用。
函数以大写字母开头的都是需要实例化后使用的,而小写的则是直接使用的函数。例如:var http = new $.Http(); var res = await http.get('https://www.baidu.com');
钩子函数
钩子函数是模板