知学云产品开发手册¶
本手册旨在于帮助开发人员快速熟悉系统整体业务与技术架构、代码管理流程、系统部署环境等,以快速进入开发角色。
知识清单¶
- 模块化编程思想、微服务架构思想
后端
- Java8新特性(
Lambda
表达式、Stream
、Optional
等) - SpringBoot
- RPC(远程过程调用协议)、Dubbo
- RabbitMQ
- JOOQ(后台
ORM
框架) - Docker
前端
整体架构¶
产品生态¶
功能蓝图¶
技术架构¶
应用架构¶
架构说明¶
- 系统前后端分离,前后端通过
RESTFul Web Service
与WebSocket
进行通讯。 - 前端(web、app、H5)使用
Drizzlejs
、SleetJs
、Vue
开发,并完全**模块化**,各模块独立开发,最后组合成完整的应用。 - 后端采用基于
Alibaba Dubbo
的面向服务架构(SOA
),系统逻辑被拆分为不同的服务,分布式部署,提供**无状态**服务。
准备工作¶
账号注册¶
- Gitlab:代码管理平台,使用公司邮箱注册账号,账号激活后由负责人授权
- YApi:API管理平台,使用公司邮箱注册账号,由负责人授权
- Confluence:内部文档知识系统,由负责人创建账号
- 禅道:内部协作系统,由负责人创建账号
软件安装¶
Git
:参考官方文档安装并配置环境变量,建议安装可视化客户端(TortoiseGit
、SourceTree
等)
代码管理¶
知学云产品代码统一在Gitlab
平台上管理,版本控制采用git分布式版本管理工具。团队按照 Gitflow 做版本控制,develop
、release-x
、master
分支受保护,向保护分支合并需要负责人做 Code Review。
详见代码管理规范
环境与发布¶
环境与配置信息详见:环境配置管理
环境管理规范详见:产品环境管理规范