后端开发代码规范
一.命名规范
1.名称命名规则
编程中的命名规则采用骆驼式命名法,又称驼峰式命名法,采用英文首字母大小写命名,所有的命名名称须遵循语义化原则。
- 大驼峰(首字母大写): 文件名, 类名, 属性名
- 小驼峰(第一个首字母小写):字段名, 方法名, 变量名
2.传值对象分类定义
- PO(persistant object):数据库表实体【数据库持久化对象】
- Req(request) : 数据传输对象【入参对象】
- Res(response) : 数据传输对象【出参对象】
二.编码原则
1.代码注释原则
- 方法名,接口名,属性名必须写含义注释
- 复杂逻辑代码块必须写注释
- 废弃的/无用的代码一律直接删除,禁止以注释等方式保留。如需查看历史代码,通过SVN/Git的history找回
2.代码分块原则
- 代码每一行的长度不应超过编辑区域宽度的80%,超长的需要换行
- 相同的逻辑代码放在一起,每块代码之间空一行
- 单个方法代码不能超过200行,超长的需要拆分
- 重复代码需要思考是否封装,应避免多次复制代码块,当逻辑变动时顾此失彼,产生bug,非常不利于维护
- if/else/for/while语句后必须使用大括号,即使只有一行代码。(需求总是变化的,一行是暂时的)
3.方法传参原则
- 方法的声明中简单类型入参放在前面,复杂类型入参放在后面
- 方法的参数不能超过5个,若超过5个则把参数封装成一个对象
4.操作数据库原则
- 避免循环查询数据库, 尽可能一次性查询所有数据
- 避免数据库存取null值, 所有类型null值全部用默认值处理
- 可能为空的变量进行必要判空
5.代码美化技巧
- 变量声明时赋值常用类型推断
- 使用语法糖简化代码