java开发宝典

Java命名规范

1：代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

   反例：_name / __name / $name / name_ / name$ / name__ 。

2：禁止使用拼音和英文混合。

   反例：DaZhePromotion [打折] / getPingfenByName()

3：类名，大驼峰式命名法：Name，MyFirstName

   方法名、参数名、成员变量、局部变量都统一使用小驼峰式命名法，

小驼峰：name，myFirstName

   

4：常量命名全部大写，单词间用下划线隔开；

   例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME 。

5：类型与中括号紧挨相连来表示数组。

   例：定义整形数组 int[] arrayDemo。

   

6：boolean类型变量，不要以is开头，避免部分序列化框架出错。

   反例：boolean isExists。

   

7：杜绝完全不规范的缩写，避免望文不知义。

   反例：AbstractClass“缩写”成AbsClass；condition“缩写”成 condi。

   

8：对于Service和DAO类，一定是接口，实现需要以Impl的后缀结尾。区别于接口

   例：CacheService CacheServiceImpl。

9：枚举类名带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。

10：类接口中属性和方法不要加任何修饰符。

常量定义

1. 不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。  反例：String key = “id=” + id;

2. long和Long初始赋值时，必须使用大写，为了避免和数字1搞混。

例：Long a = 2L   反例：Long a = 2l

3. 不要使用一个常量类维护所有常量，尽可能根据功能进行拆分归类，分开维护。便于理解和维护。

代码格式

1. 如果是大括号内为空，则写成{}即可，大括号中间无需换行和空格；

   如果是非空代码块则：

     （ 1） 左大括号前不换行，左大括号后换行。  

      （2） 右大括号前换行。  

2. 左括号与后一个字符之间不出现空格，右括号与前一个字符之间不出现空格

     例：if (flag == 0)。

3. if/for/while/switch/do 等保留字与括号之间都必须加空格。

4. 何二目、三目运算符的左右两边都需要加一个空格。

5. 注释的双斜线与注释内容之间有且仅有一个空格。

6：方法参数在定义和传入时，多个参数逗号后必须加空格。

     例：method(“a”, “b”, “c”);