Java开发规范
一、编程规约 (一) 命名规约 1.【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。 反例： _name/__name/$name/name_/name$/name__
原因：标识符的规范 组成元素 a.英文字符: a-zA-Z b.数字: 0-9 c.符号: _与$
标识符规则 a.数字不能开 b.不可以使用关键字 c.严格区分大小写，不限制长度起名时，尽量达到见名知意
2.【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。 正例： alibaba / beijing等国际通用的名称以及公司特别规定的，可视为英文。 反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3; 3. 【强制】类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / DTO / VO / DAO等。
正例：MarcoPolo / UserDO /XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
领域模型：由行业内的各个企业的业务模型再向上抽象出整个行业的业务模型
DO（Domain Object）：领域对象，就是从现实世界中抽象出来的有形或无形的业务实体。
VO（View Object）：视图对象，用于展示层，它的作用是把某个指定页面（或组件）的所有数据封装起来。
DTO（Data Transfer Object）：数据传输对象，泛指用于展示层与服务层之间的数据传输对象。
DAO: 数据访问对象是第一个面向对象的数据库接口，是一个数据访问接口(Data Access Object)。
UpperCamelCase：第一个词的首字母，以及后面每个词的首字母都大写，叫做“大骆驼拼写法”4. 【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。
正例： localValue / getHttpMessage() / inputUserId
lowerCamelCase第一个词的首字母小写，后面每个词的首字母大写，叫做“小骆驼拼写法”
非常重要，可以在MyBatista中配置实体类pojo属性与数据库中对应如：userName与user_name5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例： MAX_STOCK_COUNT
反例： MAX_COUNT 6. 【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。7. 【强制】中括号是数组类型的一部分，数组定义如下：String[] args;
反例：请勿使用String args[]的方式来定义
单独执行效果上没有不同, 但在语法意义不同.
string[] args,声明一个String数组，名字叫args ;string args[],声明一个叫args的数组，类型是String.8. 【强制】POJO类中的任何布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误。
反例：定义为基本数据类型boolean isSuccess；的属性，它的方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异常。 9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例： 应用工具类包名为com.lenovo.mpp.util、类名为MessageUtils（此规则参考spring的框架结构） 10.【强制】杜绝完全不规范的缩写，避免望文不知义。
反例：AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
11.【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
正例：从远程仓库拉取代码的类命名为PullCodeFromRemoteRepository。反例：变量int a; 的随意命名
11.【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。 正例：public class OrderFactory; public class LoginProxy; public class ResourceObserver; 12.【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。 正例： 接口方法签名：void f(); 接口基础常量表示：String COMPANY = “alibaba”; 反例： 接口方法定义：public abstract void f(); 说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。
在JDK8之前，接口不能定义任何实现，这意味着之前所有的JAVA版本中，接口制定的方法是抽象的，不包含方法体。从JKD8开始，添加了一种新功能-默认方法。默认方法允许接口方法定义默认实现，而所有子类都将拥有该方法及实现。
default void addOneObj(Object object){
System.out.println("default add");
}
13.接口和实现类的命名有两套规则： 1）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。 正例：CacheServiceImpl实现CacheService接口。 2）【推荐】 如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。 正例：AbstractTranslator实现 Translatable。 14.【参考】枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。 说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。 正例：枚举名字：DealStatusEnum；成员名称：SUCCESS / UNKOWN_REASON。 15.【参考】各层命名规约： A) Service/DAO层方法命名规约 1） 获取单个对象的方法用get做前缀。 2） 获取多个对象的方法用list做前缀。 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。
