Java 开发手册 - 编程规约【命名风格】_com.alibaba.ei.kunlun.aap.util-优快云博客

本文链接：https://blog.youkuaiyun.com/goandozhf/article/details/109819920

一、编程规约

（一）命名风格

1. 通用

所有编程相关的命名
严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

【反例】
```
DaZhePromotion [打折]    
getPingfenByName() [评分]
String fw[福娃] 
int 某变量 = 3
```

2. 包名

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

包名统一使用单数形式

【正例】

 应用工具类包名为 com.alibaba.ei.kunlun.aap.util

3. 类名

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

【正例】

ForceCode / UserDO / HtmlDTO / XmlService /TcpUdpDeal

【反例】

forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal

抽象类命名使用 Abstract 或 Base开头。

异常类命名使用 Exception 结尾。

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

类名如果有复数含义，类名可以使用复数形式。

【正例】
```
类名为 MessageUtils (此规则参考 spring 的 框架结构)
```

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

【正例】
```
枚举名字为 ProcessStatusEnum 的成员名称:
SUCCESS / UNKNOWN_REASON。
```

4. 方法、参数名

方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。

【正例】
```
localValue / getHttpMessage() / inputUserId
```

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

【正例】
```
MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
```
【反例】
```
MAX_COUNT / EXPIRED_TIME
```

避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理解性降低。

【反例】

public class ConfusingName { 
    public int stock;
    // 非 setter/getter 的参数名称，不允许与本类成员变量同名
    public void get(String alibaba) { 
        if (condition) {
            final int money = 666;
        // ...
        }
        for (int i = 0; i < 10; i++) {
            // 在同一方法体中，不允许与其它代码块中的 money 命名相同
            final int money = 15978;
            // ...
        } 
     }
  }

class Son extends ConfusingName {
	// 不允许与父类的成员变量名称相同 
	public int stock;
}