JAVA技术规范

JAVA技术规范

整理一些比较常用的一些技术规范

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

反例：_name / name / $name/nam{e}_{/}name$ / name

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

3、类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。

正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

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

正例： localValue / getHttpMessage() / inputUserId

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

正例：MAX_STOCK_COUNT
反例：MAX_COUNT

6、抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾

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

正例：定义整形数组 int[] arrayDemo;
反例：在 main 参数中，使用 String args[]来定义

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

9、包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式

10、杜绝完全不规范的缩写，避免望文不知义

11、为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意

12、如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。##

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
正例：public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

13、接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

正例：接口方法签名 void commit();
接口基础常量 String COMPANY = “alibaba”;
反例：接口方法定义 public abstract void f();
说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现

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

说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。

15、不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。

16、在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字1 混淆，造成误解

17、不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护

18、如果变量值仅在一个固定范围内变化用 enum 类型来定义

19、大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：

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

20、左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格

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

22、注释的双斜线与注释内容之间有且仅有一个空格

23、单个方法的总行数不超过 80 行