Java编程规范.docx
《Java编程规范.docx》由会员分享，可在线阅读，更多相关《Java编程规范.docx（16页珍藏版）》请在冰点文库上搜索。
Java编程规范
Java编程规范
本文引用阿里Java开发手册。
GitHub阅读地址：
编程规约
-命名规约
-常量定义
-格式规范
-OOP规约
-集合处理
-并发处理
-控制语句
-注释规约
-其他
-异常处理
-建表规约
-索引规约
-SQL规约
-ORM规约
编程规约
命名规约
1、【强制】所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束
反例：
_name/__name/$Object/name_/name$/Object$1
2、【强制】所有编程相关的命名严禁使用拼音与英语混合的方式，更不允许直接使用中的方式。
说明：
正确的英文拼写和语法可以让阅读者易于理解，避免歧义。
注意，即纯拼音的命名方式也要避免采用。
反例：
DaZhePromotion[打折]/getPingfenByName（）[评分]/int变量=3;
正例：
ali/alibaba/taobao/cainiao/aliyun/youku/hangzhou等国际通用的名称，可视为英文。
12345
3、【强制】类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：
（领域模型的相关命名）DO/DTO/VO/DAO等。
正例：
MarcoPolo/UserDO/XmlService/TcpUdpDeal/TaPromotion
反例：
macroPolo/UserDo/XMLService/TCPUDPDeal/TAPromotion123
4、【强制】方法名、参数名、成员变量、局部变量都统一只用lowerCamelCase风格，必须遵从驼峰形式。
正例：
localValue/getHttpMessage（）/inputUserId1
5、【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例：
MAX_STOCK_COUNT
反例：
MAX_COUNT123
6、【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。
7、【强制】中括号是数组类型的一部分，数组定义如下：
String[]args;
反例：
请勿使用Stringargs[]的方式来定义1
8、【强制】POJO类中的任何布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误。
反例：
定义为基本数据类型booleanisSuccess；的属性，它的方法也是isSuccess（），RPC框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异常。
1
9、【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。
包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例：
应用工具类包名为、类名为MessageUtils（此规则参考spring的框架结构）1
10、【强制】杜绝完全不规范的缩写，避免望文不知义。
反例：
某业务代码>AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成condi，此类随意缩写严重降低了代码的可阅读性。
1
11、【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。
说明：
将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。
正例：
publicclassOrderFactory;publicclassLoginProxy;publicclassResourceObserver;123
12、【推荐】接口类中的方法和属性不要加任何修饰符号（public也不要加），保持代码的简洁性，并加上有效的javadoc注释。
尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
正例：
接口方法签名：
voidf（）;接口基础常量表示：
StringCOMPANY='alibaba';
反例：
接口方法定义：
publicabstractvoidf（）;
说明：
JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。
12345
13、接口和实现类的命名有两套规则：
１）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
正例：
CacheServiceImpl实现CacheService接口。
２）【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。
正例：
AbstractTranslator实现Translatable。
123
14、【参考】枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：
枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
正例：
枚举名字：
DealStatusEnum；成员名称：
SUCCESS/UNKOWN_REASON。
123
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。
223
常量定义
1、【强制】不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。
反例：
Stringkey='Id#taobao_'tradeId；（key,value）;1
2、【强制】long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
说明：
Longa=2l;写的是数字的21，还是Long型的21
3、【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。
如：
缓存相关的常量放在类：
CacheConsts下；系统配置相关的常量放在类：
ConfigConsts下。
说明：
大而全的常量类，非得ctrlf才定位到修改的常量，不利于理解，也不利于维护。
1
4、【推荐】常量的复用层次有五层：
跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
1）跨应用共享常量：
放置在二方库中，通常是中的const目录下。
2）应用内共享常量：
放置在一方库的modules中的const目录下。
反例：
易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示“是”的变量：
类A中：
publicstaticfinalStringYES='yes';
类B中：
publicstaticfinalStringYES='y';
，预期是true，但实际返回为false，导致产生线上问题。
3）子工程内部共享常量：
即在当前子工程的const目录下。
4）包内共享常量：
即在当前包下单独的const目录下。
5）类内共享常量：
直接在类内部privatestaticfinal定义。
５、【推荐】如果变量值仅在一个范围内变化用Enum类。
如果还带有名称之外的延伸属性，必须使用Enum类，下面正例中的数字就是延伸信息，表示星期几。
正例：
publicEnum{MONDAY
（1）,TUESDAY
（2）,WEDNESDAY（3）,THURSDAY（4）,FRIDAY（5）,SATURDAY（6）,SUNDAY（7）;}1
格式规范
1、【强制】大括号的使用约定。
如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
1）左大括号前不换行。
2）左大括号后换行。
3）右大括号前换行。
4）右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。
1234567
2、【强制】左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。
详见第5条下方正例提示。
3、【强制】if/for/while/switch/do等保留字与左右括号之间都必须加空格。
4、【强制】任何运算符左右必须加一个空格。
说明：
运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。
1
5、【强制】缩进采用4个空格，禁止使用tab字符。
说明：
如果使用tab缩进，必须设置1个tab为4个空格。
IDEA设置tab为4个空格时，请勿勾选Usetabcharacter；而在eclipse中，必须勾选insertspacesfortabs。
1
正例：
（涉及1-5点）
publicstaticvoidmain（Stringargs[]）{
ppend（'xin'）...
.append（'huang'）...
.append（'huang'）...
.append（'huang'）;
反例：
StringBuffersb=newStringBuffer（）;
ppend（'xin'）...append
（'huang'）;
.
,argsX）;
819
7、【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
正例：
下例中实参的'a',后边必须要有一个空格。
method（'a','b','c'）;123
8、【强制】IDE的textfileencoding设置为UTF-8;IDE中文件的换行符使用Unix格式，不要使用windows格式。
9、【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。
正例：
inta=3;
longb=4L;
floatc=5F;
StringBuffersb=newStringBuffer（）;
说明：
增加sb这个变量，如果需要对齐，则给a、b、c都要增加几个空格，在变量比较多的情况下，是一种累赘的事情。
10、【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。
相同业务逻辑和语义之间不需要插入空行。
说明：
没有必要插入多行空格进行隔开。
1
面向对象编程规约
1、【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
2、【强制】所有的覆写方法，必须加@Override注解。
反例：
getObject（）与get0bject（）的问题。
一个是字母的O，一个是数字的0，加@Override可以准确判断是否覆盖成功。
另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。
1
3、【强制】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。
说明：
可变参数必须放置在参数列表的最后。
（提倡同学们尽量不用可变参数编程）
正例：
publicUsergetUsers（Stringtype,Integer...ids）123
4、【强制】对外暴露的接口签名，原则上不允许修改方法签名，避免对接口调用方产生影响。
接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。
5、【强制】不能使用过时的类或方法。
说明：
中的方法decode（StringencodeStr）这个方法已经过时，应该使用双参数decode（Stringsource,Stringencode）。
接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。
1
6、【强制】Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
正例：
'test'.equals（object）;
反例：
（'test'）;
说明：
推荐使用（JDK7引入的工具类）12345
7、【强制】Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
说明：
对于Integervar=在-128至127之间的赋值，Integer对象是在产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。
1
8、【强制】关于基本数据类型与包装数据类型的使用标准如下：
1）所有的POJO类属性必须使用包装数据类型。
2）RPC方法的返回值和参数必须使用包装数据类型。
3）所有的局部变量【推荐】使用基本数据类型。
12345
说明：
POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。
正例：
数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险。
反例：
比如显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的RPC服务，调用不成功时，返回的是默认值，页面显示：
0%，这是不合理的，应该显示成中划线-。
所以包装数据类型的null值，能够表示额外的信息，如：
远程调用失败，异常退出。
12345
9、【强制】定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。
反例：
POJO类的gmtCreate默认值为newDate（）;但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。
1
10、【强制】序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。
说明：
注意serialVersionUID不一致会抛出序列化运行时异常。
1
11、【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。
12、【强制】POJO类必须写toString方法。
使用IDE的中工具：
source>generatetoString时，如果继承了另一个POJO类，注意在前面加一下。
说明：
在方法执行抛出异常时，可以直接调用POJO的toString（）方法打印其属性值，便于排查问题。
1
13、【推荐】使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。
说明：
Stringstr='a,b,c,,';
String[]ary=（','）;
员名=参数名。
在getter/setter方法中，尽量不要增加业务逻辑，增加排查问题的难度。
反例：
publicIntegergetData（）{
if（true）{
returndata100;
}else{
returndata-100;
}
}9
17、【推荐】循环体内，字符串的联接方式，使用StringBuilder的append方法进行扩展。
反例：
Stringstr='start';
for（inti=0;i100;i）{
str=str'hello';
}
说明：
反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象，然后进行append操作，最后通过toString方法返回String对象，造成内存资源浪费。
18、【推荐】final可提高程序响应效率，声明成final的情况：
1）不需要重新赋值的变量，包括类属性、局部变量。
2）对象参数前加final，表示不允许修改引用的指向。
3）类方法确定不允许被重写。
12345
19、【推荐】慎用Object的clone方法来拷贝对象。
说明：
对象的clone方法默认是浅拷贝，若想实现深拷贝需要重写`clone`方法实现属性对象的拷贝。
1
20、【推荐】类成员与方法访问控制从严：
1）如果不允许外部直接通过new来创建对象，那么构造方法必须是private。
2）工具类不允许有public或default构造方法。
3）类非static成员变量并且与子类共享，必须是protected。
4）类非static成员变量并且仅在本类使用，必须是private。
5）类static成员变量如果仅在本类使用，必须是private。
6）若是static成员变量，必须考虑是否为final。
7）类成员方法只供类内部调用，必须是private。
8）类成员方法只对继承类公开，那么限制为protected。
说明：
任何类、方法、参数、变量，严控访问范围。
过宽泛的访问范围，不利于模块解耦。
思考：
如果是一个private的方法，想删除就删除，可是一个public的Service方法，或者一个public的成员变量，删除一下，不得手心冒点汗吗变量像自己的小孩，尽量在自己的视线内，变量作用域太大，如果无限制的到处跑，那么你会担心的。
8
集合处理
1、【强制】关于hashCode和equals的处理，遵循如下规则：
1）只要重写equals，就必须重写hashCode。
2）因为Set存储的是不重复的对象，依据hashCode和equals进行判断，所以Set存储的对象必须重写这两个方法。
3）如果自定义对象做为Map的键，那么必须重写hashCode和equals。
正例：
String重写了hashCode和equals方法，所以我们可以非常愉快地使用String对象作为key来使用。
1234567
2、【强制】ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException异常：
cannotbecastto;
说明：
subList返回的是ArrayList的内部类SubList，并不是ArrayList，而是ArrayList的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。
1
3、【强制】在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生ConcurrentModificationException异常。
4、【强制】使用集合转数组的方法，必须使用集合的toArray（T[]array），传入的是类型完全一样的数组，大小就是（）。
反例：
直接使用toArray无参方法存在问题，此方法返回值只能是Object[]类，若强转其它类型数组将出现ClassCastException错误。
正例：
Listlist=newArrayList
（2）;
（'guan'）;
（'bao'）;
String[]array=newString[（）];
array=（array）;
说明：
使用toArray带参方法，入参分配的数组空间不够大时，toArray方法内部将重新分配内存空间，并返回新数组地址；如果数组元素大于实际所需，下标为[（）]的数组元素将被置为null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。
5、【强制】使用工具类（）把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear方法会抛出UnsupportedOperationException异常。
说明：
asList的返回对象是一个Arrays内部类，并没有实现集合的修改方法。
体现的是适配器模式，只是转换接口，后台的数据仍是数组。
String[]str=newString[]{'a','b'};
Listlist=（str）;
第一种情况：
（'c'）;运行时异常。
第二种情况：
str[0]='gujin';那么（0）也会随之修改。
6、【强制】泛型通配符
说明：
苹果装箱后返回一个extendsFruits>对象，此对象就不能往里加任何水果，包括苹果。
1
7、【强制】不要在foreach循环里进行元素的remove/add操作。
remove元素请使用Iterator方式，如果并发操作，需要对Iterator对象加锁。
反例：
ListString>a=newArrayListString>（）;
（'1'）;
（'2'）;
for（Stringtemp:
a）{
if（'1'.equals（temp））{
（temp）;
}
}
说明：
以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗
正例：
IteratorString>it=（）;
while（））{
Stringtemp=（）;
if（删除元素的条件）{
（）;
}
}
升级会员 