官方文档指引
提示:若不计划发布到应用市场,可省略图片等非必要功能
参考文档:https://doc.buildadmin.com/senior/module/basicInfo.html
目录
- 官方文档指引
- 开发说明
- 模块开发流程
- 模块包结构示例
- 安装开发工具
- 总结
开发说明
目标:将现有功能模块打包移植到新环境
功能模块示例:
- 朋友圈
- 商品管理
- 收货地址
- 分销系统
开发建议:
- 按功能划分独立模块(如公共模块public、商品goods、订单order)
- 采用驼峰命名(如朋友圈模块命名为circleOfFriends)
- 在Markdown中清晰标注模块逻辑
- 同步记录相关数据结构至Markdown
- 将API文档置于项目目录中
- 配置项命名规范(如circleOfFriendsId、circleOfFriendsXxxx)
- 遵循高内聚低耦合原则,减少跨模块调用
- 使用Git进行版本控制,首发版本建议1.0.0
- 版本号规范:
- 测试版:1.0.1-beta.1
- 功能迭代:1.x.x
- 重大更新:x.0.0
核心文件说明:重点关注以下3个文件
- info.ini - 作者信息
- install.sql - 数据库脚本
- config.json - Composer包配置
模块开发流程
模块包结构示例
安装开发工具
-
从应用商店安装"模块开发辅助"插件
-
安装完成后刷新即可查看已安装模块
-
创建新文件夹并复制核心文件,刷新后即可看到新模块
-
点击模块第一个按钮 选中左侧文件 打包按钮选择对应文件,完成模块打包
总结
打包完可以多测试几次 最好用他们新框架纯净环境多试几次。
-
模块划分
- 将各模块单独存放,例如:
public
公共块、goods
商品模块、order
订单模块 - 模块命名采用驼峰式,如朋友圈模块命名为
circleOfFriends
- 将各模块单独存放,例如:
-
文档规范
- 在Markdown文件中明确标注模块相关逻辑
- 将对应数据结构同步记录在Markdown文件中
- API文档统一存放在项目目录下
-
配置管理
- 配置项命名遵循模块前缀原则,如:
circleOfFriendsId
、circleOfFriendsXxxx
- 配置项命名遵循模块前缀原则,如:
-
代码设计
- 遵循高内聚、低耦合原则
- 避免模块间过度依赖,如存在大量交叉调用,应考虑合并为新模块
-
版本控制
- 使用Git进行版本管理
- 首发版本号建议采用
1.0.0
- 测试版命名规范:
1.0.1-beta.1
- 复杂功能迭代可采用增量版本:
1.x.x
或x.0.0
表示大版本更新