java开发规范

阅读目录

• 1、变量、成员、方法名统一采用驼峰命名(lowerCamelCase),做到见语知其义
• 2、类名的定义
• 3、常量、类型、接口、子类的定义
• 4、包名、异常、枚举、方法名称的定义
• 5、领域模型定义规范：主要是以VO\DTO\DO等结尾
• 1、括号代码要求
• 2、括号中间的操作变量要有空格,左右括号不出现空格。
• 3、注释规范：注释的双斜线与注释内容之间有且仅有一个空格
• 4、行字符数限制不超过120个,超出需要换行,换行时遵循如下原则：
• 5、方法传参中,多个参数之间要有空格。
• 1、重写方法规范：重写方法必须添加注解@Override避免方法名不一致
• 2、参数如果相同、含义也相同,使用可变参数替换逐个定义
• 3、不能使用过时的类或方法
• 4、Object的equals方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals
• 5、所有整型包装类对象之间值的比较,使用equals方法比较
• 6、任何货币金额,均以最小货币单位且整型类型来进行存储
• 7、浮点数之间的比较
• 8、禁止使用构造方法BigDecimal(double)的方式把double值转化为BigDecimal对象
• 9、基本类型和包装类型使用规范
• 10、使用索引访问用String的split方法得到的数组时,需做最后一个分隔符后有无内容的检查,否则会有抛IndexOutOfBoundsException的风险
• 1、类(抽象类)、类属性、类方法的注释
• 2、所有的类都必须添加创建者和创建日期
• 3、方法内部单行注释
• 4、在类中删除未使用的任何字段、方法、内部类；在方法中删除未使用的任何参数声明与内部变量
• 5、谨慎注释掉代码。在上方详细说明,而不是简单地注释掉。如果无用,则删除
• 6、特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描,经常清理此类标记。线上故障有时候就是来源于这些标记处的代码
• 1、switch括号内的变量类型为String并且此变量为外部参数时,必须先进行null判断
• 2、在if/else/for/while/do语句中必须使用大括号。
• 3、三目运算符值规范。
• 4、在高并发场景中,避免使用”等于”判断作为中断或退出的条件。
• 5、表达异常的分支时,少用if-else方式。
• 6、不要在其它表达式（尤其是条件表达式）中,插入赋值语句。
• 7、不要在条件判断中执行其它复杂的语句,将复杂逻辑判断的结果赋值给一个有意义的布尔变量名,以提高可读性。

---

(一)java命名规范

1、变量、成员、方法名统一采用驼峰命名(lowerCamelCase),做到见语知其义

例子：变量——用户数据(userList)、方法——getUserData(int type)等。
说明：正常变量定义使用驼峰命名,特殊的如DTO\VO\DO等除外。

2、类名的定义

（1）普通类名采用大写字母开始;
（2）抽象类采用Abstract或Base开头。 例子&