- 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
反例:_name / __name / $Object / name_ / name$/ Object$
理解:Java标准命名规范要求:
a.名称只能由字母、数字、下划线、$符号组成;
b.不能以数字开头;
==这里可以看出在基本规范的基础上做了增强性强制规定,我想是因为下划线和美元符号在很多别的语言中都有特殊用途,譬如Python下划线开头或结尾有特定意义,PHP中美元符号有特殊意义,做出强制规定更好避免歧义==
- 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式 也要避免采用。
正例:alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。
反例:DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3。
理解:在实际业务开发中,很多情况涉及到专业术语,而专业术语如果只是通过百度翻译将命名翻译成英文,有时变成了中国式英语,更不容易理解。
==我们可以采取一种变通的方式,不做强制规定,但是命名时为了别人能够看懂,加注释==
比如:ziRanZhuangNo = 1 //自然幢号
- 【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:DO / BO / DTO / VO / AO
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
理解:DO:(Domain Object)领域对象,与数据库表结构一一对应,通过DAO层向上传输数据源对象。
BO :(business object) 业务对象。 由Service层输出的封装业务逻辑的对象。
DTO :(Data Transfer Object)数据传输对象,Service或Manager向外传输的对象。
VO :(view object)显示层对象,通常是Web向模板渲染引擎层传输的对象。
AO:(Application Object)应用对象。 在Web层与Service层之间抽象的复用对象模型,极为贴近展示层,复用度不高。
POJO:(Plain Ordinary Java Object),专指只有setter/getter/toString的简单类,包括 DO/DTO/BO/VO等。
==类名我们的也是驼峰形式,只是因为我们的类在生成时遵循了一定的规则,系统生成的不要做修改,手工写的要遵循驼峰形式==
- 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式。
正例: localValue / getHttpMessage() / inputUserId
理解:lowerCamelCase驼峰要和UpperCamelCase 驼峰区分
成员变量:在类范围内定义的变量。
局部变量:在一个方法内定义的变量,方法的形式参数在整个方法内有效,方法内定义变量在方法内定义开始的地方有效。
- 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
正例:MAX_STOCK_COUNT
反例:MAX_COUNT
理解:除了大写,单词间下划线隔开,还要加注释。
- 【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类 命名以它要测试的类的名称开始,以 Test 结尾。
理解:平台生成类以系统为准,不做修改,自己写的类要遵循此规则。
- 【强制】中括号是数组类型的一部分,数组定义如下:String[] args;
反例:使用 String args[]的方式来定义。
理解:String是字符串类型,String[]是字符串数组类型。String[] args和String args[]都是定义一个字符串数组,没有本质区别,String[] args更清晰些,尽量采用这种方式。
- 【强制】POJO 类中布尔类型的变量,都不要加is,否则部分框架解析会引起序列化错误。
反例:定义为基本数据类型 Boolean isDeleted的属性,它的方法也是 isDeleted(),RPC框架在反向解析的时候,“以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异常。
理解:springMVC框架会有这个问题,如果你用字符串的1,2来表示真假,不必考虑这个问题,如果是Boolean类型的,就要注意这个规则,强制去掉is。
- 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例:应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils(此规则参考 spring 的框架结构)
理解:目前我们包命名前面遵守的好,最后一级简写的多,不太容易看明白。
- 【强制】杜绝完全不规范的缩写,避免望文不知义。
反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随 意缩写严重降低了代码的可阅读性。
理解:这种情况代码中比较常见。要规范起来,名字不嫌长,为了便于理解,要加注释。英文中的缩写有个惯例,去掉元音留下辅音即可,不能乱缩写。
- 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。
正例:从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。
反例:变量 int a 的随意命名方式
理解:这个我们尽量遵守吧,如果实在感觉太长需要简写的话,加注释。
- 【推荐】如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。
正例:public class OrderFactory; (工厂模式)
public class LoginProxy; (代理模式)
public class ResourceObserver; (观察者模式)
理解:可以了解下基本的设计模式。
- 【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁 性,并加上有效的 Javadoc(见:javadoc注释规范) 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是 与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名:void f();
接口基础常量表示:String COMPANY = "alibaba";
反例:接口方法定义:public abstract void f();
说明:JDK8 中接口允许有默认实现,那么这个 default方法,是对所有实现类都有价值的默 认实现。
理解:接口中方法和属性默认就是public abstract的,加不加public abstract都可以。目前我们的接口中的属性和方法都是有的,这里不做修改。
- 接口和实现类的命名有两套规则:
1)【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部 的实现类用 Impl 的后缀与接口区别。
正例:CacheServiceImpl 实现 CacheService接口
2)【推荐】 如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。
正例:AbstractTranslator 实现 Translatable
理解:目前我们平台是遵循第一套规则的。
- 【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。
说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKOWN_REASON。
理解:用到枚举类尽量遵循此规则,容易辨识,类中成员变量加注释。
- 【参考】各层命名规约:
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
理解:平台层提供了足够多的方法,如果自己额外添加的要遵循此约定。