Java开发手册整理笔记

一. 编程规约

命名规约

[强制]所有编程相关命名均不能以下划线或者美元符号开始，也不能以下划线或美元符号结束。

[强制]所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式，国际通用的名称可视为英文。

[强制]类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / DTO / VO / DAO等。

[强制]方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。

[强制]常量命名全部大写，单词间用下划线隔开。

[强制]抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类以要测试的类名开始，以Test结尾。

[强制]中括号是数组类型的一部分，数组定义如下：String[] args;

[强制]POJO类中的任何布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误。

[强制]包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

[推荐]如果使用到了设计模式，建议在类名中体现出具体模式。

[推荐]接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

[参考]Service/DAO层方法命名规约

1> 获取单个对象的方法用get做前缀；

2>获取多个对象的方法用list做前缀；

3> 获取统计值的方法用count做前缀；

4>插入的方法用save（推荐）或insert做前缀；

5>删除的方法用remove（推荐）或delete做前缀；

6>修改的方法用update做前缀。

[参考]领域模型命名规约

1>数据对象：xxxDO，xxx即为数据表名；

2>数据传输对象：xxxDTO，xxx为业务领域相关的名称；

3>展示对象：xxxVO，xxx一般为网页名称；

4>POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。

[强制]不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。

[强制]或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆。

格式规约

[强制]大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：

1>左大括号前不换行;

2>左大括号后换行;

3>右大括号前换行;

4>右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。

[强制]左括号和后一个字符之间不出现空格，右括号和前一个字符之间也不出现空格。

[强制]if/for/while/switch/do等保留字与左右括号之间都必须加空格。

[强制]任何运算符左右必须加一个空格。

[强制]代码块缩进4个空格，如果使用tab缩进，请设置成1个tab为4个空格。

[强制]单行字符数限制不超过120个，超出需要换行，换行时，遵循如下原则：

1>换行时相对上一行缩进4个空格;

2>运算符与下文一起换行;

3>方法调用的点符号与下文一起换行;

4>在多个参数超长，逗号后进行换行;

5>在括号前不要换行。

[强制]方法参数在定义和传入时，多个参数逗号后边必须加空格。

[强制]IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式，不要使用windows格式。

[推荐]方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

OOP规约

[强制]避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

[强制]所有的覆写方法，必须加@Override注解。

[强制]相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。 说明：可变参数必须放置在参数列表的最后。

[强制]对外暴露的接口签名，原则上不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。

[强制]Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。

[强制]所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。 说明：对于Integer var=?在-128至127之间的赋值，Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象。详见java中的 equals()和==

[强制]关于基本数据类型与包装数据类型的使用标准如下：

1>所有的POJO类属性必须使用包装数据类型；

2>RPC方法的返回值和参数必须使用包装数据类型；

3>所有的局部变量推荐使用基本数据类型。

说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。

[强制]定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。

[强制]构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。

[强制]POJO类必须写toString方法。使用工具类source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。

[推荐]使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。

[推荐]当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。

[推荐]类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法。

[推荐]setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter/setter方法中，尽量不要增加业务逻辑，增加排查问题难度。

[推荐]循环体内，字符串的联接方式，使用StringBuilder的append方法进行扩展。

[推荐]final可提高程序响应效率，声明成final的情况：

1>不需要重新赋值的变量，包括类属性、局部变量；

2>对象参数前加final，表示不允许修改引用的指向；

3> 类方法确定不允许被重写。

[推荐]慎用Object的clone方法来拷贝对象。 说明：对象的clone方法默认是浅拷贝，若
4000
想实现深拷贝需要重写clone方法实现属性对象的拷贝。详见java中的深拷贝和浅拷贝

[推荐]类成员与方法访问控制从严：

1>如果不允许外部直接通过new来创建对象，那么构造方法必须是private；

2>工具类不允许有public或default构造方法；

3>类非static成员变量并且与子类共享，必须是protected；

4>类非static成员变量并且仅在本类使用，必须是private；

5> 类static成员变量如果仅在本类使用，必须是private；

6>若是static成员变量，必须考虑是否为final；

7>类成员方法只供类内部调用，必须是private；

8>类成员方法只对继承类公开，那么限制为protected。

集合处理

[强制]Map/Set的key为自定义对象时，必须重写hashCode和equals。

[强制]ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException异常：java.util.RandomAccessSubList cannot be cast to java.util.ArrayList ; 说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是 ArrayList 的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。

[强制]在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生ConcurrentModificationException 异常。

[强制]使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一样的数组，大小就是list.size()。

[强制]使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear方法会抛出UnsupportedOperationException异常。 说明：asList的返回对象是一个Arrays内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。

[强制]不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式，如果并发操作，需要对Iterator对象加锁。

[推荐]集合初始化时，尽量指定集合初始值大小。

[推荐]高度注意Map类集合K/V能不能存储null值的情况，如下表格：



[参考]利用Set元素唯一的特性，可以快速对另一个集合进行去重操作，避免使用List的contains方法进行遍历去重操作。

控制语句

[强制]在一个switch块内，每个case要么通过break/return来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。

[强制]在if/else/for/while/do语句中必须使用大括号，即使只有一行代码。

[推荐]循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch操作。

[参考]方法中需要进行参数校验的场景：

1>调用频次低的方法；

2> 执行时间开销很大的方法；

3>需要极高稳定性和可用性的方法；

4>对外提供的开放接口，不管是RPC/API/HTTP接口。

[参考]方法中不需要参数校验的场景：

1>极有可能被循环调用的方法，不建议对参数进行校验。但在方法说明里必须注明外部参数检查；

2>底层的方法调用频度都比较高，一般不校验；

3>被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。