1、编程规约spring
(一)命名风格编程
1.【强制】代码中的命名均不能以 _ 和 $ 开始 ,也不能以 _ 和 $ 结束。设计模式
反例:_name / __name / $object / name_ / object$数组
2.【强制】代码中的命名严禁使用英文和拼音混合的方式。更不能直接使用中文。架构
说明:正确的英文拼写和语法可让读者更易于阅读理解,避免歧义。注意,纯拼音的命名方式也要尽可能避免。框架
正例:albaba / taobao 等国际通用的拼音,可视为英文。工具
反例:DaZhePromotion[打折] / int 某变量 = 3 ;测试
3.【强制】类名使用UpperCamelCase风格,必须遵循驼峰命名形式,但一下情形除外:DO / BO / DTO / VO / AO设计
正例:MarcoPolo / UserDO / XmlService / TCPUdpDeal / TaPromotionserver
反例:mrocoPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
4.【强制】方法名、参数名、成员变量 、 局部变量 都统一使用 lowerCameCase 风格 ,必须遵照驼峰形式。
正例:localValue / getHttpMessage() / inputUserId
5.【强制】常量名所有用大写,单词用 _ 下划线隔开 ,不要嫌名字长 ,力求表达完整清晰易懂。
正例:MAX_STOCK_COUNT
反例:MAX_COUNT
6.【强制】抽象类 类名 用 Abstract 或 Base 开头;异常类型 用 Exception 结尾 ;测试类 以它要测试的类名开头,以Test结尾。
7.【强制】中括号是数组类型的一部分,数组定义以下:String[] args;
反例:使用 String args[] 的方式来定义。
8.【强制】POJO类当值 Boolean类型的变量 ,都不要加 is ,不然部分框架解析会引发序列化错误。
反例:定义为基本数据类型 Boolean isDeleted ; 的属性, 他的方法也是 isDeleted(), RPC框架在反向解析的时候,“觉得”对应的属性名称deleted,致使属性获取不到,进而抛出异常 。
9.【强制】包名统一使用小写,点分隔符之间只能有一个天然语义的英语单词。包名统一使用单数形式,可是类名若是具备复数含义,类名可使用复数形式。
正例: 应用工具类包名为com.alibaba.open.util 、 类名MessageUtil(此规则参考spring的框架结构)
10.【强制】杜绝彻底不规范的缩写,避免望文不知义。
反例:AbstractClass “缩写” 命名 AbsClass ; condition "缩写" 命名成 condi,此类随意缩写严重下降了代码的可阅读性。
11.【推荐】为了达到代码自解析的目标,任何自定义编程元素在命名时,使用尽可能完整的单词来表达其意。
正例:从远程仓库拉取代码的类,命名为PullCodeFromRemoteRespository
反例:变量 int a; 的随意命名方式。
12.【推荐】若是模块、类、接口、方法 使用了设计模式,在命名时要体现出具体的设计模式。
说明:将设计模式体如今命名当中,有利于阅读者快速理解架构的设计理念。
正例:public class OrderFactory ;
public class LoginProxy ;
public class ResouresObserver;
13.【推荐】接口类中的方法和属性不要加任何的修饰符号(public也不要加),保持代码的简洁性,并加上有效的Javadoc注释。尽可能不要再接口当中定义变量,即便定义变量,那么这个变量也必定是与方法有关,而且是整个应用的基础常量。
正例:接口的方法签名 : void f ();
接口的基础常量表示: String COMPANY = “alibaba”;
反例:接口方法定义: public abstract void f();
说明:JDK8中接口容许有默认实现,那么这个default方法,是对全部实现类都有价值的默认实现。
14.接口和实现的命名有两套规则:
1)【强制】对于Service 和 DAO 类, 基于SOA的理念,暴露出来的服务必定是接口,内部的实现类使用 Impl 的后缀与接口区别。
正例:CacheSercviceImpl 实现CaheService接口。
2)【推荐】若是是形容能力的接口名称,取出对应的形容词做为接口名(一般是 -able 的形式)。
正例:AbstractTranslator 实现 Translatable
15.【参考】枚举类名最好加上Enum后缀,枚举成员名称须要全大写,单词间用下划线隔开。
说明:枚举其实就是特殊的常量类,且构造方法被默认是强制私有。
正例:枚举名字ProcessStrutsEnum的成员名称:SUCCESS / UNKNOW_REASON
16.【参考】各层命名规约:
A)Service / DAO 层命名规约
1)获取单个对象用 set 作前缀。
2)获取多个对象用 list 作前缀。
3)获取统计只的方法用 count 作前缀。
4)插入的方法用 save/inset 作前缀。
5)删除的方法用 remove/delete 作前缀。
6)修改的方法用 update 作前缀。
B)领域模型命名规约
1)数据对象: xxDO , xx 为数据表名。
2)数据传输对象: xxxDTO ,xxx 为业务领域相关的名称。
3)展现对象:xxVO ,xx通常为网页名。
4)POJO是 DO / DTO / BO / VO 的统称,禁止命名成 xxxPOJO 。
-------------------------------------------------------------------------------------------------------
第一节到此结束,这些都是平时最基础的命名规范,为了代码的质量,严格遵照吧,养成好的代码习惯。