代码规范

Posted 2021-05-14 ConcertoTeam

这个作业属于哪个课程	课程
这个作业要求在哪里	作业要求
这个作业的目标	alpha冲刺
	博客集合

环境

jdk: 1.8
mysql：5.7.xx

维护

git维护

• 代码由后端组长统一维护。其他成员fork仓库后在自己的仓库里进行开发，完成一定的模块之后进行pr。由组长审核后合并代码，处理冲突。
• 成员完成一个小模块，需要保证可以运行后才可以提交

代码冲突预防

• 基础pojo类型只能由后端组长来修改。
• 分工以模块为分工颗粒，减少交叉的模块数量。
• 采取小规模多次提交，文件中标注文件创建者，只能由创建者来修改该文件的内容。
• 为了提高效率，开发阶段允许冗余的文件存在，可以等到开发任务基本完成后进行调整。

数据库

命名

表名：

• 要有明确的语义。
• 全小写，单词之间用下划线_进行分割
  字段名：
• 要有明确的语义。除了有其他语义的字段，基础字段采取表名_字段名来命名，如user_id
• 全小写，单词之间用下划线_进行分割。

通用数据类型

id: BIGINT
任务\\项目起始结束时间: DATE
记录时间: DATETIME

后端代码

命名

包名\\类名：单数，驼峰命名
属性：驼峰命名
dao层文件：以Dao结尾
controller层文件：以Controller结尾
service层接口：以Service结尾
service层实现类：以ServiceImpl结尾
工具类：以Utils结尾
普通pojo：以实体名称命名，不用pojo结尾
接收表单数据对象：以Form结尾
前端展示对象：以Vo结尾

数据传递

• 层之间禁止采用Map的形式传递数据
• 接受前端数据时，超过三个参数则需要封装成类进行参数接收
• 结合效率和成本复用已有类型，数据传递时层与层之间的包装类型不能出现无效字段

返回格式

统一包装成CommonResponse进行返回
CommonResponse字段：

Integer status;//状态码
String message;//状态信息
Object data;//数据

异常处理

采用springboot的全局异常处理，在代码中catch只能用于将异常包装成自定义异常后再次抛出。
封装成CustomException抛出异常。其中有状态码和状态信息的字段。