代码规范(开发必读)

基于微信云托管及微信生态等基础设施,我们对平台的技术架构进行了整体规划:

Architecture

查看架构图

类似微服务架构,服务层将业务功能拆分成 n 个独立的:业务模块(Bussiness Module)

  • 每个业务模块由 3 个核心子模块组成:
    • moduler-server:数据服务(迁移及模型管理),给业务平台提供数据接口;
    • module-api: 业务接口,给前端小程序提供数据及业务能力;
    • module-opeapi: 模块开放接口,提供定制业务对接使用,外网可访问;
  • 子模块之间可以通过 http/websocket 的方式相互内网调用,可以跨业务模块调用;
  • 子模块都是独立的代码仓库,技术框架一致,都可以独立容器部署

前端业务规范:

🏷️ 代码协作

  1. 开始新的开发任务,获取最新的主分支(main)作为代码基础,无需创建新分支
  2. 多人协作,完成代码修改后,提交审阅前最好进行 rebase,跟上最新提交;
  3. 主分支最新代码会自动同步到预览环境,生产环境代码部署需要指定 tag 版本号

📑 API 版本变更策略

直接在路由路径中增加版本号,以新增接口的方式实现:

GET /api/{api_version}/module/status

在 Apifox 中以版本号为名称作为接口子目录,增加新版本的接口说明:

API_VERSION

🔨 工具推荐

代码编辑:

依赖管理:

数据库管理:

文档管理: