后端开发代码规范

后端开发代码规范

一.命名规范

• 类名， 属性名，方法名采用大驼峰(首字母大写)命名，字段名，变量名采用小驼峰(第一个首字母小写)命名。
• 命名需要遵循语义化原则，较长的名称可以使用英文简写，命名尽量满足见名知意，简短优雅的要求。
• 接口名称，方法名称，实体名称可以采用动词为前缀，常用的动词有Query、Get、Set、Add、Update、Delete、Change、Remove、Send、Save等。
• 数据库表实体使用PO后缀，接口入参实体使用Req后缀，接口出参使用Res后缀，代码层传输实体使用DTO后缀。

二.编码规范

1.代码注释

• 方法名，接口名，属性名必须写含义注释。
• 复杂代码逻辑必须写逻辑注释。
• 废弃的/无用的代码一律直接删除，禁止以注释等方式保留。如需查看历史代码，通过SVN/Git的history找回。

2.代码分块

• 代码每一行的长度不应超过编辑区域宽度的80%，超长的需要换行。
• 较长的业务代码根据逻辑进行分块，每个代码块之间空一行。
• 单个方法代码不能超过200行，超长的需要拆分。
• 多次重复使用的代码需要思考是否封装，应避免多次复制代码块，当逻辑变动时顾此失彼，产生bug，非常不利于维护。
• if/else/for/while语句后必须使用大括号，即使只有一行代码(需求总是变化的，一行是暂时的)。

3.方法传参

• 方法的声明中简单类型入参放在前面,复杂类型入参放在后面。
• 方法的参数不能超过5个,若超过5个则把参数封装成一个对象。

4.操作数据库

• 避免循环查询数据库操作, 考虑一次性预加载需要用到的数据。
• 新增，修改，删除业务数据需要记录操作日志。
• 可能为空的变量进行必要判空。

5.使用常量类

• 接口返回的提示消息使用常量
• 接口的路由路径使用常量
• 缓存的key值使用常量

6.美化代码

• 变量声明时赋值常用类型推断。
• 使用语法糖简化代码。
• 使用代码格式化整理代码 。