开发规范

Java开发手册

一、编程规约

（一）命名风格

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

2. 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文。

3. 类名使用 UpperCamelCase 风格，必须遵从驼峰形式(大驼峰)

4. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从

   驼峰形式(小驼峰)。

5. 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

6. • 抽象类命名使用 Abstract 或 Base 开头；

   • 异常类命名使用 Exception 结尾；

   • 测试类命名以它要测试的类的名称开始，以 Test 结尾。

7. 中括号是数组类型的一部分，数组定义如下：String[] args;

8. POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。

9. 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用

   单数形式。

10. 杜绝完全不规范的缩写。

11. 如果使用到了设计模式，建议在类名中体现出具体模式。

（二）代码格式

1. 大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果

   是非空代码块则：

   1） 左大括号前不换行。

   2） 左大括号后换行。

   3） 右大括号前换行。

   4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。

2. 左右小括号和字符之间不出现空格。

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

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

5. 单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：

   1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进。

   2） 运算符与下文一起换行。

   3） 方法调用的点符号与下文一起换行。

   4） 在多个参数超长，在逗号后换行。

   5） 在括号前不要换行。

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

7. IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，

   不要使用 windows 格式。

8. 没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。