该篇文档为《简单工厂模式》的文章所引用的补充说明。
阿里巴巴命名规范
在《阿里Java开发手册-泰山版》中，对命名做了如下规范：
代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
1
2//反例
_name / __name / $name / name_ / name$ / name__所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
1
2
3
4
5
6
7//说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免使用
//正例
ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视同英文
//反例
DaZhePromotion[打折] / getPingfenByName() [评分] / int 某变量 = 3类名使用大驼峰(UpperCamelCase)风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。
1
2
3
4
5//正例
ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion
//反例
forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion补充说明：
源文链接：https://blog.csdn.net/w605283073/article/details/89715188
DO(Data Object)：此对象与数据库表结构一一对应，通过DAO层向上传输数据源对象。
BO(Business Object)：用于封装业务逻辑。
DTO(Data Transfer Object)：数据传输对象，Service 或 Manager 向外传输的对象。
VO(View Object)：显示层对象，通常是Web向模板渲染引擎层传输的对象。
AO(Application Object)：应用对象，在Web层与Service层之间抽象的复用对象模型，即为贴近展示层，复用度不高。
PO(Persistent Object)：用于表示数据库中一条记录映射而成的java对象，仅用于表示数据。
POJO(Plain Ordinary Java Object)：用于表示一个最基础的Java对象，PO、VO、DTO都是POJO。
BO的理解方式：
BO这个对象可以包括一个或多个其他的对象。
比如一个简历，有教育经历、工作精力、社会关系等等。
我们可以把教育经历对应一个PO、工作经历对应一个PO、社会关系对应一个PO。
建立一个对应简历的BO对象处理简历，每个BO包含这些PO。这样处理业务逻辑时，我们就可以针对BO去处理。
方法名、参数名、成员变量、局部变量都统一使用小驼峰(lowerCamelCase)风格。
1
2//正例
localValue / getHttpMessage() / inputUserId常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
1
2
3
4
5//正例
MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
//反例
MAX_COUNT / EXPIRED_TIME抽象类命名使用Abstract 或 Base开头；异常类命名使用Exception结尾；测试类命名以他要测试的类的名称开始，以Test结尾。
类型与中括号紧挨相连来表示数组。
1
2
3
4
5//正例
定义整型数组 int[] arrayDemo;
//反例
在main参数中，使用String args[]来定义。POJO类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
1
2//反例
定义为基本数据类型Boolean isDeleted的属性，它的方式也是isDeleted(),框架在反向解析的时候，“误以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常。包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
1
2
3
4
5//正例
应用工具类
包名为：com.alibaba.ei.kunlun.aap.util
类名为：MessageUtils
(此规则参考Spring的框架结构)避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。
说明：子类、父类成员变量名相同，即使是public类型的变量也是能够通过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非setter/getter的参数名称也要避免与成员变量名称相同。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23//反例
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;
}杜绝完全不规范的所写，避免望文不知义。
1
2
3
4//反例
AbstractClass "缩写" 命名成 AbsClass;
condition "缩写" 命名成 condi
此类随意缩写严重降低了代码的可阅读性。为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达。
1
2
3
4
5//正例
在JDK中，对某个对象引用的 volatile 字段进行原子更新的类名为：AtomicReferenceFieldUpdater
//反例
常见的方法内变量为 int a; 的定义方式。在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。
1
2
3
4
5//正例
startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
//反例
startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
1
2
3
4//正例
public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;接口类中的方法和属性不要加任何修饰符号(public 也不要加)，保持代码的简介性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量。
说明：JDK8中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。
1
2
3
4
5
6//正例
接口方法签名 void commit();
接口基础常量 String COMPANY = "alibaba";
//反例
接口方法定义 public abstract void f();接口和实现类的命名有两套规则：
对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用Impl 的后缀与接口区别。
1
2//正例
CacheServiceImpl 实现 CacheService 接口如果是形容能力的接口名称，取对应的形容词为接口名（通常是-able 的形容词）。
1
2//正例
AbstractTranslator 实现 Translatable接口
枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
1
2//正例
枚举名字为 ProcessStatusEnum 的成名名称：SUCCESS / UNKNOWN_REASON各层命名规约：
A) Service/DAO 层方法命名规约
1.获取单个对象的方法用 get 做前缀。
2.获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects。
3.获取统计值的方法用 count 做前缀。
4.插入的方法用 save/insert 做前缀。
5.删除的方法用 remove/delete 做前缀。
6.修改的方法用 update 做前缀。
B) 领域模型命名规约
1.数据对象：xxxDO，xxx即为数据表名。
2.数据传输对象：xxxDTO，xxx为业务领域相关的名称。
3.展示对象：xxxVO，xxx一般为网页名称。
4.POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。