写博客即是为了记录自己的学习历程,也希望能够结交志同道合的朋友一起学习。文章在撰写过程中难免有疏漏和错误,欢迎指出文章的不足之处;更多内容请点进爱敲代码的小游子查看。
临渊羡鱼,不如退而结网。一起加油!
1、命名不能以下划线美元符号开始结束,代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式,纯拼音命名方式更要避免采用。
2、类名使用大驼峰命名法(POJO实体类除外),方法名、参数名、成员变量、局部变量都统一使用使用小驼峰命名法,常量使用大写单词(表示类型的名词放在词尾)之间使用"_"间隔
如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。
3、抽象类(Abstract,Base开头)、异常类(Exception结尾)、测试类(测试的类名+Test)命名规范,数组定义规范(数据类型[] 数组名),POJO类定义规范(禁止is开头)
4、包名规范:小写、一个单词、使用“.”间隔,单数形式,类名如果有复数含义可以使用复数
5、变量名规范:子类与父类、局部变量不同代码块之间都不要有相同的变量名
6、不规范的缩写,尽量使用完整单词
7、接口、实现类、枚举命名规范
接口: 接口中的方法属性不要加修饰符(默认方法除外),使用javadoc注解,接口中尽量不要定义属性(定义的属性必须是与接口相关的)
实现类:service层只暴露接口,实现类后缀Impl,形容能力的接口命名:使用形容词(-able)
枚举:后缀:Emun,成员名称全部大写
8、各层命名规范
- 方法命名:
- 获取:get、list
- 计数:count
- 插入:insert、save
- 删除:remove、delete
- 修改:update
- 实体类命名
- xxxDO对应数据库
- DTO对应业务领域
- VO:展示
- POJO:实体类的统称(不能使用POJO命名实体类)
9、常量定义: - 常量都必须预先定义
- Long类型的参数是同L,l和1容易混淆
10、常量的维护:
常量分类管理
常量复用层次—>放在不用的包中管理常量
11、变量管理:在固定范围内变动的变量使用Emun管理
12、大括号、小括号、缩进规范、注释
注释// 与内容保持一个空格
13、换行:单行字数不超过120、不要再括号前换行、不要在逗号前换行,运算符与与下文一起换行
14、其他
- 多个参数逗号后加空格
- 编码设置UTF-8,使用Unix格式
- 单个方法不超过80行,分清红花、绿叶(抽出称为额外方法)
- 不要强求对其
- 不用逻辑、语义、不同业务代码可以用空行分隔