阿里巴巴编码规范

• 编码规范

1. 命名风格（强制要求）

代码的命名不以下划线或美元符号开始或者结束

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

类名使用UpperCameCase风格，但是以下情形例外：DO / BO / DTO / VO / AO / PO / UID

方法名、参数名、成员变量、局部变量都使用lowerCameCase风格，必须遵守驼峰形式

常量命名全部大写，单词之间用下划线区分，力求语义表达完整，不要嫌弃名字长（eg：MAX_COUNT_TIME)）

抽象类使用Abstract或者Base开头；自定义异常类使用Exception结尾；测试类以要测试的类的类名开头以Test结尾

类型与中括号相连来表示数组（eg：int【】 arrayDemo）

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

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

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

说明：子类、父类成员变量名相同，即使是 public 类型的变量也是能够通过编译，而局部变量在同一方法
内的不同代码块中同名也是合法的，但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员
变量名称相同。
反例：
public class ConfusingName {
 public int age;
 // 非 setter/getter 的参数名称，不允许与本类成员变量同名
 public void getData(String alibaba) {
 if(condition) {
 final int money = 531;
 // ...
 }
 for (int i = 0; i < 10; i++) {
 // 在同一方法体中，不允许与其它代码块中的 money 命名相同
 final int money = 615;
 // ...
 }
 }
}
class Son extends ConfusingName {
 // 不允许与父类的成员变量名称相同
 public int age;
}

杜绝完全不规范的缩写，避免望文生义。（eg：AbstrastClass “缩写” 成AbsClass  严重降低的代码的可阅读性）

    2.命名风格（建议推荐）

使用索引访问用String的split方法得到的数组时，需要做最后一个分隔符后有无内容的检查，不然要抛出IndexOutOfBoundException的风险

String str = "a,b,c,,";
String[] ary = str.split(",");
System.out.println(ary.length);

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

在常量和变量命名的时候，表示类型的名词放在词尾，以提升辨别度

正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

如果模板、类、接口、方法使用了设计模式，在命名的时候需要具体体现出对应的设计模式

public class OrderFactory
public class LoginProxy
public class ResourceObserver

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

接口和实现类的命名有两套规则

1. 对于Service和DAO类，基于SOA理念，暴露出来的服务一定是接口，内部的实现类使用Impl的后缀与接口区别

        正例：CacheServiceImpl 实现 CacheService 接口。

1. 如果是形容能力的接口，取对应的形容词为接口名（通常是-able的形容词）

        正例：AbstractTranslator 实现 Translatable 接口。

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

3.常量定义

 

 

 

• 异常日志
• 单元测试
• 安全规约
• MySQL数据库
• 工程结构
• 设计规约