项目说明文档.md

项目说明文档

1. 项目代码编写规范说明

2. 项目架构说明

3. 项目相关技术说明

4. 项目大体流程说明

5. 服务调用及接口说明

6. 服务集群部署及测试说明

7. 服务集群横向扩展要点说明

项目代码编写规范说明

前端代码规范

• js脚本可以单独写成文件就写成文件
• 涉及到提交敏感信息如个人信息、电话号码、注册验证码等信息时使用对称加密算法加密，例如Base64、rsa256等
• 前端完成页面需要调用接口在小幺鸡系统中添加文件夹：前端调取未完成接口请求，在此文件夹下写需要哪些接口，后端完成接口后查看该文件夹开始完成该需求
• 前端完成页面需要调用则需要用到后台服务，联系kepler进行服务部署进行测试，后续购买云服务器则在云服务器直接测试
• 将写好的文件放在Nginx上

后端代码规范

• 方法及属性的命名使用驼峰式命名，名称尽可能的简单易懂，实在看不出来写一个注释
• POM包跟据具体项目业务进行添加，尽可能减少冗余
• 两层for循环尽可能外小内大以提升性能
• 查询数据库筛选条件尽可能在数据库完成，尽可能减少内存区筛选，如查询id为1-100的100个用户，在数据库查询即可，不可查询出全部的数据然后用java遍历筛选
• 尽量控制每一个请求调取数据库的次数在三次以内
• 代码长度过长就汲取其中某个可以重复使用的片段封装然后调用（不能重复使用的片段也需单独分离，让代码变得简单易懂）
• 设置路由层模型，对业务返回对象进行封装

项目架构说明

项目框架

初步理想化项目架构设想，后续初步开发根据取舍选取其中工具进行应用，也有可能对此进行扩展

• 技术核心框架：SpringBoot+SpringCloudAlibaba
• ORM框架：Mybatis
• 数据连接池：Alibaba Druid
• 数据库缓存：Redis Sentinel
• 消息中间件：RocketMQ
• 接口文档引擎：Swagger2RESTful文档生成
• 全文检索引擎：ElasticSearch
• 分布式链路追踪：SkyWalking
• 分布式文件系统：Alibaba OSS
• 分布式系统网关：SpringCloudGeteway
• 分布式协调系统：SpringCloudAlibabaNacosServer
• 分布式配置中心：SpringCloudAlibabaNacosConfig
• 分布式熔断降级：SpringCloudAlibabaSentinel
• 反向代理负载均衡：Nginx

前后分离

前端框架：Vue+Axios

持续集成

• 持续集成：GitBLit
• 自动化部署：jenkins

开发环境

• 操作系统：windows10
• 开发工具Intellij IDEA
• 数据库MySQL8.0
• javaSDK：JDK1.8_152

部署环境

• 虚拟环境：VMware+LinuxCentOS7