java开发手册Word文件下载.docx
《java开发手册Word文件下载.docx》由会员分享，可在线阅读，更多相关《java开发手册Word文件下载.docx（35页珍藏版）》请在冰豆网上搜索。
“正例”提倡什么样的编码和实现方
式；
“反例”说明需要提防的雷区，以及真实的错误案例。
本手册的愿景是码出质量、码出高效。
代码的字里行间流淌的是软件生命中的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升质量意识。
另外，现代软件架构都需要协同开发完成，高效考虑的是降低协同成本，所谓无规矩不成方圆，无规范不能协作。
众所周知，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全。
试想如果没有限速，没有红绿灯，没有规定靠右行驶，谁还敢上路行驶。
对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率。
版本号
制定团队
更新日期
备注
1.1.0
增加前言和专有名词说明，修正部分描述。
一、编程规约
（一）命名规约
1.【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：
//$//$/$
2.【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：
正确的英文拼写和语法可以让阅读者易于理解，避免歧义。
注意，即使纯拼音命名方式也要避免采用。
[打折]/（）[评分]/某变量=3正例：
///等国际通用的名称，可视同英文。
3.【强制】类名使用风格，必须遵从驼峰形式，但以下情形例外：
（领域模型
的相关命名）///等。
正例：
////反例：
////
4.【强制】方法名、参数名、成员变量、局部变量都统一使用风格，必须遵从驼峰形式。
/（）/
5.【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
6.【强制】抽象类命名使用或开头；
异常类命名使用结尾；
测试类命名以它要测试的类的名称开始，以结尾。
7.【强制】中括号是数组类型的一部分，数组定义如下：
[];
反例：
使用[]的方式来定义。
8.【强制】类中布尔类型的变量，都不要加，否则部分框架解析会引起序列化错误。
定义为基本数据类型；
的属性，它的方法也是（），
框架在反向解析的时候，“以为”对应的属性名称是，导致属性获取不到，进而抛出异常。
9.【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。
包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
应用工具类包名为、类名为（此规则参考的框架结构）
10.【强制】杜绝完全不规范的缩写，避免望文不知义。
“缩写”命名成；
“缩写”命名成，此类
随意缩写严重降低了代码的可阅读性。
11.【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。
将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。
;
12.【推荐】接口类中的方法和属性不要加任何修饰符号（也不要加），保持代码的简洁
性，并加上有效的注释。
尽量不要在接口里定义变量，如果一定要定义变量，肯定是
与接口方法相关，并且是整个应用的基础常量。
接口方法签名：
f（）;
接口基础常量表示：
="
"
;
接口方法定义：
8中接口允许有默认实现，那么这个方法，是对所有实现类都有价值的默
认实现。
13.接口和实现类的命名有两套规则：
1）
【强制】对于和类，基于的理念，暴露出来的服务一定是接口，内部
的实现类用的后缀与接口区别。
实现接口。
2）
【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–的形式）。
实现。
14.【参考】枚举类名建议带上后缀，枚举成员名称需要全大写，单词间用下划线隔开。
枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
枚举名字：
，成员名称：
/。
15.【参考】各层命名规约：
A）层方法命名规约
1）获取单个对象的方法用做前缀。
2）获取多个对象的方法用做前缀。
3）获取统计值的方法用做前缀。
4）插入的方法用（推荐）或做前缀。
5）删除的方法用（推荐）或做前缀。
6）修改的方法用做前缀。
B）领域模型命名规约
1）数据对象：
，即为数据表名。
2）数据传输对象：
，为业务领域相关的名称。
3）展示对象：
，一般为网页名称。
4）是的统称，禁止命名成。
（二）常量定义
1.【强制】不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。
；
（,）;
2.【强制】或者初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
a=2l;
写的是数字的21，还是型的2?
3.【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。
如：
缓存相关的常量放在类：
下；
系统配置相关的常量放在类：
下。
大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。
4.【推荐】常量的复用层次有五层：
跨应用共享常量、应用内共享常量、子工程内共享常量、包
内共享常量、类内共享常量。
1）跨应用共享常量：
放置在二方库中，通常是中的目录下。
2）应用内共享常量：
放置在一方库的中的目录下。
易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示
“是”的变量：
类A中：
类B中：
y"
（），预期是，但实际返回为，导致产生线上问题。
3）子工程内部共享常量：
即在当前子工程的目录下。
4）包内共享常量：
即在当前包下单独的目录下。
5）类内共享常量：
直接在类内部定义。
5.【推荐】如果变量值仅在一个范围内变化用类。
如果还带有名称之外的延伸属性，必须使用类，下面正例中的数字就是延伸信息，表示星期几。
{
（1）,
（2）,（3）,（4）,（5）,（6）,
（7）;
}
（三）格式规约
1.【强制】大括号的使用约定。
如果是大括号内为空，则简洁地写成{}即可，不需要换行；
如果是非空代码块则：
1）左大括号前不换行。
2）左大括号后换行。
3）右大括号前换行。
4）右大括号后还有等代码则不换行；
表示终止右大括号后必须换行。
2.【强制】左括号和后一个字符之间不出现空格；
同样，右括号和前一个字符之间也不出现空格。
详见第5条下方正例提示。
3.【强制】等保留字与左右括号之间都必须加空格。
4.【强制】任何运算符左右必须加一个空格。
运算符包括赋值运算符=、逻辑运算符、加减乘除符号、三目运算符等。
5.【强制】缩进采用4个空格，禁止使用字符。
如果使用缩进，必须设置1个为4个空格。
设置为4个空格时，请勿勾选；
而在中，必须勾选。
（涉及1-5点）
（[]）{
缩进4个空格
//运算符的左右必须有一个空格=0;
//关键词与括号之间必须有一个空格，括号内的f与左括号，0与右括号不需要空格（0）{
（）;
//左大括号前加空格且不换行；
左大括号后换行
（1）{（"
）;
右大括号前换行，右大括号后有，不用换行
}{（"
在右大括号后直接结束，则必须换行
6.【强制】单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则：
1）第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进，参考示例。
2）运算符与下文一起换行。
3）方法调用的点符号与下文一起换行。
4）在多个参数超长，逗号后进行换行。
5）在括号前不要换行，见反例。
=（）;
超过120个字符的情况下，换行缩进4个空格，并且方法前的点符号一起换行
（"
）（"
）...
超过120个字符的情况下，不要在括号前换行（"
）
参数很多的方法调用可能超过120个字符，不要在逗号前换行
（1,2,3,...
）;
6.【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
下例中实参的"
a"
后边必须要有一个空格。
"
b"
c"
8.【强制】的设置为8;
中文件的换行符使用格式，不要使用格式。
9.【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。
a=3;
b=4L;
c=5F;
增加这个变量，如果需要对齐，则给a、b、c都要增加几个空格，在变量比较多的
情况下，是一种累赘的事情。
10.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义
之间插入一个空行。
相同业务逻辑和语义之间不需要插入空行。
没有必要插入多行空格进行隔开。
（四）规约
1.【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
2.【强制】所有的覆写方法，必须加注解。
（）与0（）的问题。
一个是字母的O，一个是数字的0，加
可以准确判断是否覆盖成功。
另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。
3.【强制】相同参数类型，相同业务含义，才可以使用的可变参数，避免使用。
可变参数必须放置在参数列表的最后。
（提倡同学们尽量不用可变参数编程）
（,...）
4.【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。
接口过时必须加注解，并清晰地说明采用的新接口或者新服务是什么。
5.【强制】不能使用过时的类或方法。
中的方法（）这个方法已经过时，应该使用双参数（,）。
接口提供方既然明确是过时接口，那么有义务同时提供新的接口；
作为调用方来说，有义务去考证过时方法的新实现是什么。
6.【强制】的方法容易抛空指针异常，应使用常量或确定有值的对象来调用
。
"
（"
推荐使用（7引入的工具类）
7.【强制】所有的相同类型的包装类对象之间值的比较，全部使用方法比较。
对于=?
在-128至127之间的赋值，对象是在产生，会复用已有对象，这个区间内的值可以直接使用进行
判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，
推荐使用方法进行判断。
8.关于基本数据类型与包装数据类型的使用标准如下：
1）【强制】所有的类属性必须使用包装数据类型。
2）【强制】方法的返回值和参数必须使用包装数据类型。
3）【推荐】所有的局部变量使用基本数据类型。
类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何
问题，或者入库检查，都由使用者来保证。
数据库的查询结果可能是，因为自动拆箱，用基本数据类型接收有风险。
比如显示成交总额涨跌情况，即正负，x为基本数据类型，调用的服务，调用不成功时，返回的是默认值，页面显示：
0%，这是不合理的，应该显示成中划线-。
所以包装
数据类型的值，能够表示额外的信息，如：
远程调用失败，异常退出。
9.【强制】定义等类时，不要设定任何属性默认值。
类的默认值为（）;
但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。
10.【强制】序列化类新增属性时，请不要修改字段，避免反序列失败；
如果完全不兼容升级，避免反序列化混乱，那么请修改值。
注意不一致会抛出序列化运行时异常。
11.【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在方法中。
12.【强制】类必须写方法。
使用的中工具：
>
时，如果继承了另一个类，注意在前面加一下。
在方法执行抛出异常时，可以直接调用的（）方法打印其属性值，便于排
查问题。
13.【推荐】使用索引访问用的方法得到的数组时，需做最后一个分隔符后有无
内容的检查，否则会有抛的风险。
,"
[]=（"
"
预期大于3，结果是3
14.【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，
便于阅读。
15.【推荐】类内方法定义顺序依次是：
公有方法或保护方法>
私有方法>
方法。
公有方法是类的调用者和维护者最关心的方法，首屏展示最好；
保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；
而私有方法外部一般不需要特别关心，是一个黑盒实现；
因为方法信息价值较低，所有和的方法放在类体最
后。
16.【推荐】方法中，参数名称与类成员变量名称一致，.成员名=参数名。
在
方法中，尽量不要增加业务逻辑，增加排查问题的难度。
（）{（）{
+100;
}{
-100;
17.【推荐】循环体内，字符串的连接方式，使用的方法进行扩展。
（I=0;
I<
100;
）{=+"
反编译出的字节码文件显示每次循环都会出一个对象，然后进行
操作，最后通过方法返回对象，造成内存资源浪费。
18.【推荐】下列情况，声明成会更有提示性：
1）不需要重新赋值的变量，包括类属性、局部变量。
2）对象参数前加，表示不允许修改引用的指向。
3）类方法确定不允许被重写。
19.【推荐】慎用的方法来拷贝对象。
对象的方法默认是浅拷贝，若想实现深拷贝需要重写方法实现属性对象
的拷贝。
20.【推荐】类成员与方法访问控制从严：
1）如果不允许外部直接通过来创建对象，那么构造方法必须是。
2）工具类不允许有或构造方法。
3）类非成员变量并且与子类共享，必须是。
4）类非成员变量并且仅在本类使用，必须是。
5）类成员变量如果仅在本类使用，必须是。
6）若是成员变量，必须考虑是否为。
7）类成员方法只供类内部调用，必须是。
8）类成员方法只对继承类公开，那么限制为。
任何类、方法、参数、变量，严控访问范围。
过宽泛的访问范围，不利于模块解耦。
思
考：
如果是一个的方法，想删除就删除，可是一个的方法，或者一
个的成员变量，删除一下，不得手心冒点汗吗？
变量像自己的小孩，尽量在自己的视
线内，变量作用域太大，如果无限制的到处跑，那么你会担心的。
（五）集合处理
1.【强制】关于和的处理，遵循如下规则：
1）只要重写，就必须重写。
2）因为存储的是不重复的对象，依据和进行判断，所以存储的对象必须重写这两个方法。
3）如果自定义对象做为的键，那么必须重写和。
重写了和方法，所以我们可以非常愉快地使用对象作为来使用。
2.【强制】的结果不可强转成，否则会抛出异常：
说明：
返回的是的内部类，并不是，而是
的一个视图，对于子列表的所有操作最终会反映到原列表上。
3.【强制】在场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生异常。
4.【强制】使用集合转数组的方法，必须使用集合的（T[]），传入的是类型完全一样的数组，大小就是（）。
使用带参方法，入参分配的数组空间不够大时，方法内部将重新分配内存空间，并返回新数组地址；
如果数组元素大于实际所需，下标为[（）]的数组元素将被置为，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。
<
=<
（2）;
[]=[（）];
直接使用无参方法存在问题，此方法返回值只能是[]类，若强转其它
类型数组将出现错误。
5.【强制】使用工具类（）把数组转换成集合时，不能使用其修改集合相关的方法，它的方法会抛出异常。
的返回对象是一个内部类，并没有实现集合的修改方法。
体现的是适配器模式，只是转换接口，后台的数据仍是数组。
[]=[]{"
};
第一种情况：
运行时异常。
第二种情况：
[0]="
那么（0）也会随之修改。
6.【强制】泛型通配符<
?
T>
来接收返回的数据，此写法的泛型集合不能使用方法，而<
不能使用方法，做为接口调用赋值时易出错。
扩展说一下（）原则：
1）频繁往外读取内容的，适合用上界。
2）经常往里插入的，适合用下界。
7.【强制】不要在循环里进行元素的操作。
元素请使用
方式，如果并发操作，需要对对象加锁。
a=<
1"
2"
（:
a）{
（））{（）;
以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的
结果吗？
（（））{
（删除元素的条件）{
8.【强制】在7版本及以上，要满足如下三个条件，不然，
会报异常。
1）x，y的比较结果和y，x的比较结果相反。
2）x>
y，y>
z，则x>
z。
3），则x，z比较结果和y，z比较结果相同。
下例中没有处理相等的情况，实际使用中可能会出现异常：
<
（）{
（o1,o2）{o1（）>
o2（）?
1:
-1;
9.【推荐】集合初始化时，尽量指定集合初始值大小。
尽量使用（）初始化。
10.【推荐】使用遍历类集合，而不是方式进行遍历。
其实是遍历了2次，一次是转为对象，另一次是从中取出
所对应的。
而只是遍历了一次就把和都放到了中，效
率更高。
如果是8，使用方法。
（）返回的是V值集合，是一个集合对象；
（）返回的是K值集合，是一个集合对象；
（）返回的是值组合集合。
11.【推荐】高度注意类集合能不能存储值的情况，如下表格：
集合类
说明
不允许为
线程安全
分段锁技术
允许为
线程不安全
由于的干扰，很多人认为是可以置入值，注意存储
值时会抛出异常。
12.【参考】合理利用好集合的有序性（）和稳定性（），避免集合的无序性（）和
不稳定性（）带来的负面影响。
有序性是指遍历的结果是按某种比较规则依次排列的。
稳定性指集合每次遍历的元素次
序是一定的。
是；
是。
13.【参考】利用元素唯一的特性，可以快速对一个集合进行去重操作，避免使用的
方法进行遍历、对比、去重操作。
（六）并发处理
1.【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
资源驱动类、工具类、单例工厂类都需要注意。
2.【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
{（）{
...
3.【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资源不足的问题。
如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
4.【强制】线程池不允许使用去创建，而是通过的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
返回的线程池对象的弊端如下：
1）和:
允许的请求队列长度为，可能会堆积大量的请求，从而导致。
2）和:
允许的创建线程数量为，可能会创建大量的线程，从而导致。
5.【强制】是线程不安全的类，一般不要定义为变量，如果定义为，必须加锁，或者使用工具类。
注意线程安全，使用。
亦推荐如下处理：
（）{
};
如果是8的应用，可以使用代替，代替，代替，官方给出的解释：
。
6.【强制】高并发时，同步调用应该去考量锁的性能损耗。
能用无锁数据结构，就不要用锁；
能锁区块，就不要锁整个方法体；
能用对象锁，就不要用类锁。
7.【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
线程一需要对表A、B、C依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是A、B、C，否则可能出现死锁。
8.【强制】并发修改同一记录时，避免更新丢失，需要加锁。
要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁
升级会员 