第一章 编程规约
1.1 命名
1.【强制】命名均不以下划线或美元符号开头或结束。
2.【强制】命名切忌拼音或拼音与英语混合。
3.【强制】类名使用UpperCamelCase风格，但DO/BO/DTO/VO/AO/PO等例外。
正例 反例
MarcoPolo macroPolo
UserDO UserDo
Xmlservice XMLService
TcpUdpDeal TCPUDPDeal
TaPromotion TAPromotion
QrCode QRCode
4.【强制】方法名、参数名、成员变量、局部变量用lowerCamelCase风格，驼峰形式。
5.【强制】常量命名全部大写，单词间用下划线隔开。
MAX_STOCK_COUNT PRIZE_NUMBER_EVERYDAY
6.【强制】抽象类命名使用Abstract或Base开头；异常类命名用Exception结尾；测试类命名以要测试的类命开始，以Test结尾。
7.【强制】类型与中括号之间无空格项链定义数组。
int[] arrayDemo;
8.【强制】POJO类中布尔类型变量都不要加is前缀，否者部分框架解析会引起序列化错误。
9.【强制】包名用小写，点分隔符之间有且仅有一个自然语义的英语单词。
10.【强制】切忌不规范的缩写。
11.【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
正例：从远程仓库拉取代码的类命名为PullCodeFromRemoteRepository
反例：变量int a; 的随意命名方式。
12.【推荐】如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
正例：public class OrderFactory; public class LoginProxy; public class ResourceObserver;
13.【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
14. 接口和实现类的命名有两套规则：
①【强制】对于Service 和DAO 类，基于SOA 的理念，暴露出来的服务一定是接口，内部的实现类用Impl 的后缀与接口区别。
正例：CacheServiceImpl 实现CacheService 接口。
②【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形式）。
正例：AbstractTranslator 实现Translatable。
15.【参考】枚举类带上Enum后缀，枚举成员名称全大写，单词间用下划线隔开。
正例：枚举名称为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON
16.【参考】各层命名规约：
① Service/DAO 层方法命名规约如下：
👌 获取单个对象的方法用get作为前缀。
👌 获取多个对象的方法用list作为前缀。
👌 获取统计值的方法用count作为前缀。
👌 插入的方法用save / insert 作为前缀。
👌 删除的方法用remove / delete 作为前缀。
👌 修改的方法用 update 作为前缀。
② 领域模型命名规约如下：
👌 数据对象： xxxDO, xxx为数据表名。
👌 数据传输对象： xxxDTO, xxx为业务领域相关的名称。
👌 展示对象：xxxVO,xxx一般为网页名称。
👌 POJO是 DO/DTO/BO/VO 的统称，禁止命名为xxxPOJO。
1.2 常量定义
17.【强制】不允许未经预先定义的常量直接出现在代码中。
18.【强制】long或者Long初始赋值时，使用大写的L。避免与1混淆。
Long a = 2L;
19.【推荐】按常量功能进行归类，分开维护。
例：缓存相关常量放在类CacheConsts下；系统配置相关常量放在类ConfigConsts下。
20.【推荐】常量的5个复用层次：
① 跨应用共享常量：放置在二方库中，通常是在client.jar中的constant目录下。
② 应用内共享常量： 放置在一方库中，通常是在子模块中的constant目录下。
③ 子工程内部共享常量： 在当前子工程的constant目录下。
④ 包内共享常量： 在当前包下单独的constant目录下。
⑤ 类内共享常量： 直接在类内部以private static final的方式定义。
21.【推荐】如果变量值仅在一个范围内变化，则用enum类型来定义。
例：
public enum SeasonEnum {
SPRING(1), Summer(2), AUTUMN(3), WINTER(4);
private int seq;
SeasonEnum(int seq) {
this.seq = seq;
}
}
