一.前言
这几天学习java写了一些东西,代码有问题,就拿去问老师,把代码发给老师后,老师批评说我写的代码不规范,即使代码可以实现相应的功能,但是企业依旧不会使用你的代码,你拥有的仅仅是编程基础,老师不止一次告诉我,让我去学习编程规范,我觉得也是时候学习一波了,不知道各位读者有没有这种体验啊,比如一个QQ群,有萌新问你这个代码有什么问题,很多人想去帮忙,却不知道写的什么,才会一点一点问,这个方法是干什么的,那个变量是干啥,确实作为萌新的我们都将我们自己定义为中心,我们没有为别人考虑,当我们自己写代码的时候,我们当时是知道这个变量是干什么的,哪怕是一个a,一个b,因为那是你写的,你不可能那么快忘记,但是换另一个人来读你的代码,就需要从头重新刷你的代码,曾几何时,我的变量也是a,b,c,最狼狈的时候是我尽然找不到26个字母中可以用来命名的字母了,因为我太随意了,想到什么就写什么,a简单就写a,但是,当我第二年再次打开我写的这些,我当初自认为很好的代码来说,我也不知道我写的是什么,我只能从定义它的地方一步一步回忆。
写代码的过程就好像我们写作文,虽然我语文课从来不好好听哈,但是对于写作文呢,语文老师说过一句话:要先写自己,再写集体,然后顺势扩展到国家,社会等等,反正呢,就是一步一步往大阔。我相信各位读者的语文老师也说过这句话,写的代码我认为可以比作是个人,集体,国家几个阶段,刚开始初级阶段,我们写的代码可以乱,可以随意,只要能实现我们所需要的功能即可,这便是作文中的个人,中级阶段,我们写的代码需要同别人交流,总不能我说汉语,你说英语,你与大多数人不同,那你一定是不受待见的那一个,这便是作文中的集体,再往后就不举例子了,当你通过百度读到这篇文章的时候,我觉得你应该和正在写这篇文章的我一样,已经意识到了集体的意义,而不再是一个人的单打独斗,你可以自己学习代码,但你终究是要出去找工作的。离开了集体,我们什么都不是!想说的话就到这里,下面进入正题吧。
二.命名风格
- 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
反例:
_name / __name / $name / name_ / name$ / name__
- 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
说明:
正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。
正例:alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。
反例:DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
- 【强制】类名使用 UpperCamelCase 风格,但以下情形例外:DO / BO / DTO / VO / AO /
正例:
MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
- 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式。
正例:
localValue / getHttpMessage() / inputUserId
- 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
正例:
MAX_STOCK_COUNT
反例:MAX_COUNT
-
【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。
-
【强制】类型与中括号紧挨相连来表示数组。
扫描二维码关注公众号,回复: 9836130 查看本文章
正例:
定义整形数组 int[] arrayDemo;
反例:在 main 参数中,使用 String args[]来定义。
- 【强制】POJO 类中布尔类型的变量,都不要加 is 前缀,否则部分框架解析会引起序列化错误。
反例:
定义为基本数据类型 Boolean isDeleted 的属性,它的方法也是 isDeleted(),RPC框架在反向解析的时候,“误以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异常。
- 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例:
应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils(此规则参考 spring 的框架结构)
- 【强制】杜绝完全不规范的缩写,避免望文不知义。
反例:
AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随 意缩写严重降低了代码的可阅读性。
- 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词 组合来表达其意。
正例:
在 JDK 中,表达原子更新的类名为:AtomicReferenceFieldUpdater。
反例:变量 int a 的随意命名方式。
- 【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。
说明:
将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。
正例:public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
- 【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是 与接口方法相关,并且是整个应用的基础常量。
正例:
接口方法签名 void commit(); 接口基础常量 String COMPANY = "alibaba";
反例:接口方法定义 public abstract void f();
说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默认实现。
- 接口和实现类的命名有两套规则:
1)【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用 Impl 的后缀与接口区别。
正例:
CacheServiceImpl 实现 CacheService 接口。
2)【推荐】 如果是形容能力的接口名称,取对应的形容词为接口名(通常是–able 的形式)。
正例:
AbstractTranslator 实现 Translatable 接口。
- 【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。
说明:
枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制是私有。
正例:枚举名字为 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。
<font color=#cc0000 size=4 face="STCAIYUN">【强制】</font>
<font color=#009933 size=4 face="STCAIYUN">【推荐】</font>
<font color=#6699ff size=4 face="STCAIYUN">【参考】</font>