开发者社区> 铭铭erom> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

阿里巴巴 Java 开发手册之编程规约(一)-------我的经验

简介: 阿里javaa开发手册经验总结,我会说一下日常写代码我的规范,也会补充说一下为什么阿里要这么规定,总之,都是经验,也有不合理的,忘海涵。。。。
+关注继续查看

阿里巴巴 Java 开发手册

一、编程规约

(一) 命名规约

1.【强制】 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。(代码规范,易读)

反例: _name / __name / $Object / name_ / name$ / Object$

2.【强制】 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式 也要避免采用。(代码规范,易读)

反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
正例: alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。

3.【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:(领域模型 的相关命名)DO / BO / DTO / VO等。(代码规范,易读)关于DO/DTO/VO的介绍

正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

4.【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从 驼峰形式。(代码规范,易读)

正例: localValue / getHttpMessage() / inputUserId

5.【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。(这个必须要注意,一般常量会用static final修饰,所以这种命名方式容易使代码在阅读的时候容易发现这是个全局常量)

正例: MAX_STOCK_COUNT
反例: MAX_COUNT

6.【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类 命名以它要测试的类的名称开始,以 Test 结尾。(良好的习惯才能写出优秀的代码)

7.【强制】中括号是数组类型的一部分,数组定义如下:String[] args; 反例:使用String args[]的方式来定义。(编译后都是String[] args = new String[size],属于代码规范)

8.【强制】POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。 反例:定义为基本数据类型Boolean isSuccess;的属性,它的方法也是isSuccess(),RPC 框架在反向解析的时候,“以为”对应的属性名称是 success,导致属性获取不到,进而抛出异 常。(这个得重点注意一下,因为正常开发getset方法都是采用ide自动生成的,很少会自己写,比如在使用fastjson反解析就出出现这种问题)

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

正例: 应用工具类包名为com.alibaba.open.util、类名为MessageUtils(此规则参考 spring 的框架结构)

10.【强制】杜绝完全不规范的缩写,避免望文不知义。(这个我也经常犯,嫌命名太长了,英文水平不行)

反例: AbstractClass“缩写”命名成 AbsClass; condition“缩写”命名成 condi,此类 随意缩写严重降低了代码的可阅读性。

11.【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。 说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。 正例:public class OrderFactory;

public class LoginProxy; public class ResourceObserver;

12.【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁 性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是 与接口方法相关,并且是整个应用的基础常量。(这个还真没怎么注意,一般interface接口是不会去定义常量的,应该会定义在接口的实现类里)

正例:接口方法签名:void f();
接口基础常量表示:String COMPANY = "alibaba";
反例:接口方法定义:public abstract void f();
说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默 认实现。

13.【推荐】接口和实现类的命名有两套规则:(代码规范,易读)

1)【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用 Impl 的后缀与接口区别。 正例:CacheServiceImpl 实现 CacheService 接口。
2)【推荐】 如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。 正例:AbstractTranslator 实现 Translatable。

14.【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。 说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。(代码规范,易读)

正例:枚举名字:DealStatusEnum,成员名称:SUCCESS / UNKOWN_REASON。

15.【参考】各层命名规约:

A) Service/DAO层方法命名规约
1) 获取单个对象的方法用get做前缀。
2) 获取多个对象的方法用list做前缀。(这个还真不怎么用,我之前一般都是get...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。

(二) 常量定义

1. 【强制】不允许出现任何魔法值(即未经定义的常量)直接出现在代码中。 (需要注意,卸载代码里的常量咋一看确实对理解代码有阻碍,还是得先定义一个常量出来)

反例: String key = "Id#taobao_"+tradeId;
cache.put(key, value);

2.【强制】long 或者 Long 初始赋值时,必须使用大写的 L,不能是小写的 l,小写容易跟数字 1 混淆,造成误解。 (规范,记得以前写随机4位码的时候,如果区分大小写,像C c W w o O 0 b 6 P p K k这种很相似的都准出现,尤其是 0 o O)

说明:Long a = 2l; 写的是数字的21,还是Long型的2?

3. 【推荐】不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。如:缓存 相关的常量放在类:CacheConsts 下;系统配置相关的常量放在类:ConfigConsts 下。 说明:大而全的常量类,非得使用查找功能才能定位到修改的常量,不利于理解和维护。 (自己写的时候就知道了,如果一个常量类里你上百个常量,估计都不好找了吧)

4. 【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包 内共享常量、类内共享常量。

1) 跨应用共享常量:放置在二方库中,通常是client.jar中的constant目录下。
2) 应用内共享常量:放置在一方库的modules中的constant目录下。
    反例:易懂变量也要统一定义成应用内共享常量,两位攻城师在两个类中分别定义了表示 “是”的变量:
    类A中:public static final String YES = "yes";类B中:public static final String YES = "y"; 
    A.YES.equals(B.YES),预期是 true,但实际返回为 false,导致产生线上问题。
3) 子工程内部共享常量:即在当前子工程的constant目录下。
4) 包内共享常量:即在当前包下单独的constant目录下。
5) 类内共享常量:直接在类内部private static final定义。

5. 【推荐】如果变量值仅在一个范围内变化用 Enum 类。如果还带有名称之外的延伸属性,必须 使用 Enum 类,下面正例中的数字就是延伸信息,表示星期几。

正例:public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}

(三) 格式规约

1. 【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果 是非空代码块则: (IDE自带格式化)

1) 左大括号前不换行。
2) 左大括号后换行。
3) 右大括号前换行。
4) 右大括号后还有else等代码则不换行;表示终止右大括号后必须换行。

2. 【强制】 左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空 格。(IDE自带格式化)

3. 【强制】if/for/while/switch/do 等保留字与左右括号之间都必须加空格。(IDE自带格式化)

4. 【强制】任何运算符左右必须加一个空格。(IDE自带格式化)

说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运算符等。

5. 【强制】缩进采用 4 个空格,禁止使用 tab 字符。

说明:如果使用 tab 缩进,必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时, 请勿勾选Use tab character ;而在 eclipse 中,必须勾选insert spaces for tabs。

6. 【强制】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:

1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。
2) 运算符与下文一起换行。
3) 方法调用的点符号与下文一起换行。 4) 在多个参数超长,逗号后进行换行。 5) 在括号前不要换行,见反例。
正例:
StringBuffer sb = new StringBuffer();
//超过 120 个字符的情况下,换行缩进 4 个空格,并且方法前的点符号一起换行 sb.append("zi").append("xin")...
          .append("huang")...
          .append("huang")...
          .append("huang");
反例:
StringBuffer sb = new StringBuffer();
//超过 120 个字符的情况下,不要在括号前换行 sb.append("zi").append("xin")...append
("huang");
//参数很多的方法调用可能超过 120 个字符,不要在逗号前换行 method(args1, args2, args3, ...
, argsX);

7. 【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。(IDE自带格式化)

正例:下例中实参的"a",后边必须要有一个空格。 method("a", "b", "c");

8.【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式, 不要使用 windows 格式。(IDE自带)

9. 【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。 正例:

int a = 3;
long b = 4L;
float c = 5F;
StringBuffer sb = new StringBuffer();
说明:增加 sb 这个变量,如果需要对齐,则给 a、b、c 都要增加几个空格,在变量比较多的 情况下,是一种累赘的事情。

  1. 【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。(这里应该是只一个方法内处理逻辑差距过大可以空行来分割,不过这样应该可以看看方法是不是可以重构了,一般方法别超过150行。我一般控制在50行以内)
    说明:没有必要插入多行空格进行隔开。

(四) OOP 规约

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可。(意思就是访问静态资源的时候直接通过A.ID来访问,无需new A(),再访问)

2.【强制】所有的覆写方法,必须加@Override 注解。(@Override原来是干这个用的,用来提示是否重写了父类或者借口的方法。需要注意一下了)

反例:getObject()与 get0bject()的问题。一个是字母的 O,一个是数字的 0,加@Override 可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编 译报错。

3. 【强制】相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object。 说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程) 正例:public User getUsers(String type, Integer... ids)

4. 【强制】外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生 影响。接口过时必须加@Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。(意思就是别乱改接口名字和接口的参数数量、顺序、类型)

5. 【强制】不能使用过时的类或方法。

说明:java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时,应 该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口, 那么有义务同时提供新的接口;作为调用方来说,有义务去考证过时方法的新实现是什么。

6. 【强制】Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用 equals。(这个是常识,不过 == 就无所谓前后顺序了,个人建议变量放前面)

正例: "test".equals(object);
反例: object.equals("test"); 说明:推荐使用java.util.Objects#equals (JDK7引入的工具类)

7. 【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较。 说明:对于Integer var = ?在-128至127之间的赋值,Integer对象是在 IntegerCache.cache 产生,会复用已有对象,这个区间内的 Integer 值可以直接使用==进行 判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑, 推荐使用 equals 方法进行判断。(不仅是Integer,包括Byte、Char、Short、Long,这五个都是-128~127由cache缓存的)

8. 【强制】关于基本数据类型与包装数据类型的使用标准如下:

1) 【强制】所有的POJO类属性必须使用包装数据类型。(我理解的就是正常封装的JAVA对象,只包含get set方法的那种)
2) 【强制】RPC(远程过程调用协议)方法的返回值和参数必须使用包装数据类型。(这个确实如此,按我的经验来说RPC接口最好不要用简单数据类型)
3) 【推荐】所有的局部变量使用基本数据类型。
说明:POJO 类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何NPE (空指针)问题,或者入库检查,都由使用者来保证。

正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE 风险。
反例:比如显示成交总额涨跌情况,即正负 x%,x 为基本数据类型,调用的 RPC 服务,调用不成功时,返回的是默认值,页面显示:0%,这是不合理的,应该显示成中划线-。所以包装 数据类型的 null 值,能够表示额外的信息,如:远程调用失败,异常退出。

9. 【强制】定义 DO/DTO/VO 等 POJO 类时,不要设定任何属性默认值。(这个不太理解,难道由代码显示的赋值吗?)

反例:POJO类的gmtCreate默认值为new Date();但是这个属性在数据提取时并没有置入具 体值,在更新其它字段时又附带更新了此字段,导致创建时间被修改成当前时间。

10. 【强制】序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败;如果完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。(序列化与反序列化之间的版本验证)

说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。

11. 【强制】构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init 方法中。

12. 【强制】POJO 类必须写 toString 方法。使用 IDE 的中工具:source> generate toString 时,如果继承了另一个 POJO 类,注意在前面加一下 super.toString。 说明:在方法执行抛出异常时,可以直接调用 POJO 的 toString()方法打印其属性值,便于排 查问题。(好习惯)

13. 【推荐】使用索引访问用 String 的 split 方法得到的数组时,需做最后一个分隔符后有无内容的检查,否则会有抛 IndexOutOfBoundsException的风险。(一般split出来的数组都是遍历,不会索引访问)

说明:
String str = "a,b,c,,";
String[] ary = str.split(","); //预期大于 3,结果是 3 System.out.println(ary.length);

14. 【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起, 便于阅读。(好习惯,当你添加了带参数的构造方法,最好还能加上空的构造方法)

15.【推荐】 类内方法定义顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter方法。

说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类 关心,也可能是“模板设计模式”下的核心方法;而私有方法外部一般不需要特别关心,是一个黑盒实现;因为方法信息价值较低,所有 Service 和 DAO 的 getter/setter 方法放在类体最 后。

16. 【推荐】setter 方法中,参数名称与类成员变量名称一致,this.成员名 = 参数名。在getter/setter 方法中,尽量不要增加业务逻辑,增加排查问题的难度。(好习惯,不过加处理也不是不行)

反例:
public Integer getData() { if (true) {
return data + 100; } else {
return data - 100; }
}

17. 【推荐】循环体内,字符串的连接方式,使用 StringBuilder 的 append 方法进行扩展。(好习惯,个人建议强制使用吧)

反例:
String str = "start";
for (int I = 0; I < 100; i++) {
str = str + "hello"; }
说明:反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象,然后进行 append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。

18. 【推荐】下列情况,声明成 final 会更有提示性:

1) 不需要重新赋值的变量,包括类属性、局部变量。 2) 对象参数前加final,表示不允许修改引用的指向。 3) 类方法确定不允许被重写。

19. 【推荐】慎用 Object 的 clone 方法来拷贝对象。

说明:对象的 clone 方法默认是浅拷贝,若想实现深拷贝需要重写 clone 方法实现属性对象 的拷贝。

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 的成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视 线内,变量作用域太大,如果无限制的到处跑,那么你会担心的。

(五) 集合处理

1. 【强制】关于 hashCode 和 equals 的处理,遵循如下规则:

1) 只要重写equals,就必须重写hashCode。
2) 因为Set存储的是不重复的对象,依据hashCode和equals进行判断,所以Set存储的 对象必须重写这两个方法。
3) 如果自定义对象做为Map的键,那么必须重写hashCode和equals。

说明:String 重写了 hashCode 和 equals 方法,所以我们可以非常愉快地使用 String 对象 作为 key 来使用。

2. 【强制】ArrayList的subList结果不可强转成ArrayList,否则会抛出ClassCastException 异常:java.util.RandomAccessSubList cannot be cast to java.util.ArrayList ; 说明:subList 返回的是 ArrayList 的内部类 SubList,并不是 ArrayList ,而是 ArrayList 的一个视图,对于SubList子列表的所有操作最终会反映到原列表上。(测试过,确实如此,不过没这么写过代码)

3. 【强制】 在 subList 场景中,高度注意对原集合元素个数的修改,会导致子列表的遍历、增 加、删除均产生ConcurrentModificationException 异常。(多线程不锁的话很容易出现这个问题,单线程的for循环里也不能对本集合操作,也会造成这个异常,造成的原因就是List的操作数前后大小不相等,比如说遍历的时候操作数只有5,结果你在循环里有添加了一个元素,操作数就变成6了,等到下一次循环的时候操数不相等,就会报异常)

4.【强制】使用集合转数组的方法,必须使用集合的toArray(T[] array),传入的是类型完全 一样的数组,大小就是 list.size()。(之所以需要传入目的数组,是因为简单的toArray()方法出来的是Object数组)

说明:使用 toArray 带参方法,入参分配的数组空间不够大时,toArray 方法内部将重新分配 内存空间,并返回新数组地址;如果数组元素大于实际所需,下标为[ list.size() ]的数组 元素将被置为 null,其它数组元素保持原值,因此最好将方法入参数组大小定义与集合元素 个数一致。
正例:

List<String> list = new ArrayList<String>(2); list.add("guan");
list.add("bao");
String[] array = new String[list.size()]; array = list.toArray(array);

反例:直接使用 toArray 无参方法存在问题,此方法返回值只能是 Object[]类,若强转其它 类型数组将出现 ClassCastException 错误。

5. 【强制】 使用工具类 Arrays.asList()把数组转换成集合时,不能使用其修改集合相关的方 法,它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。 说明:asList 的返回对象是一个 Arrays 内部类,并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式,只是转换接口,后台的数据仍是数组。(一定要注意Arrays.asList的坑,Arrays.asList的值不能被增删。不过 List list = new ArrayList<>(Arrays.asList(a))这种方式创建的list就可以修改了,因为new的时候是以数组创建的)

      String[] str = new String[] { "a", "b" };
      List list = Arrays.asList(str);

第一种情况:list.add("c"); 运行时异常。
第二种情况:str[0] = "gujin"; 那么list.get(0)也会随之修改。

6.【强制】泛型通配符<? extends T>来接收返回的数据,此写法的泛型集合不能使用add方 法,而<? super T>不能使用get方法,做为接口调用赋值时易出错。 说明:扩展说一下PECS(Producer Extends Consumer Super)原则:1)频繁往外读取内容 的,适合用上界 Extends。2)经常往里插入的,适合用下界 Super。(没写过这种)

7. 【强制】 不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式,如果并发操作,需要对 Iterator 对象加锁。(这个就是上面说的那种情况)

反例:

List<String> a = new ArrayList<String>(); a.add("1");
a.add("2");
for (String temp : a) {
    if ("1".equals(temp)) { a.remove(temp);}
 }

说明:以上代码的执行结果肯定会出乎大家的意料,那么试一下把“1”换成“2”,会是同样的结果吗?
正例:

Iterator<String> it = a.iterator(); while (it.hasNext()) {
String temp = it.next(); 
if (删除元素的条件) {
         it.remove();
      }
}

8. 【强制】 在 JDK7 版本及以上,Comparator 要满足如下三个条件,不然 Arrays.sort, Collections.sort 会报 IllegalArgumentException 异常。(这个得注意一下)

说明:

1) x,y的比较结果和y,x的比较结果相反。
2) x>y,y>z,则x>z。
3) x=y,则x,z比较结果和y,z比较结果相同。

反例:下例中没有处理相等的情况,实际使用中可能会出现异常:

new Comparator<Student>() {
    @Override
    public int compare(Student o1, Student o2) {
        return o1.getId() > o2.getId() ? 1 : -1;
     }
}

####9. 【推荐】集合初始化时,尽量指定集合初始值大小。(这个是好习惯,尽量初始化的时候加上初始值,因为集合在扩容的时候还是挺消耗性能的,ArrayList初始值10)

说明:ArrayList尽量使用ArrayList(int initialCapacity) 初始化。

10. 【推荐】使用 entrySet 遍历 Map 类集合 KV,而不是 keySet 方式进行遍历。(jdk8里的集合操作不要太方便)

说明:keySet 其实是遍历了 2 次,一次是转为 Iterator 对象,另一次是从 hashMap 中取出 key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中,效 率更高。如果是 JDK8,使用 Map.foreach 方法。

正例:values()返回的是 V 值集合,是一个 list 集合对象;keySet()返回的是 K 值集合,是 一个 Set 集合对象;entrySet()返回的是 K-V 值组合集合。

11. 【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况,如下表格:

   Hashtable:Key:不允许为 null;Value:不允许为 null;Super:为Dictionary说明:线程安全
   ConcurrentHashMap:Key不允许为 null;Value:不允许为 null;Super:AbstractMap;说明:分段锁技术
   TreeMap:Key:不允许为 null; Value:允许为 null;Super: AbstractMap;说明:线程不安全
   HashMap:Key:允许为 null;Value:允许为 null;Super: AbstractMap;说明:线程不安全

反例: 由于 HashMap 的干扰,很多人认为 ConcurrentHashMap 是可以置入 null 值,注意存储 null 值时会抛出 NPE 异常。

12. 【参考】合理利用好集合的有序性(sort)和稳定性(order),避免集合的无序性(unsort)和 不稳定性(unorder)带来的负面影响。 说明:有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次 序是一定的。如:ArrayList 是 order/unsort;HashMap 是 unorder/unsort;TreeSet 是 order/sort。

13. 【参考】利用 Set 元素唯一的特性,可以快速对一个集合进行去重操作,避免使用 List 的 contains 方法进行遍历、对比、去重操作。

(六) 并发处理

1. 【强制】获取单例对象需要保证线程安全,其中的方法也要保证线程安全。

说明:资源驱动类、工具类、单例工厂类都需要注意。

2. 【强制】创建线程或线程池时请指定有意义的线程名称,方便出错时回溯。

正例:
public class TimerTaskThread extends Thread { public TimerTaskThread() {
super.setName("TimerTaskThread"); ... }

3. 【强制】线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。(这个以前不注意,现在觉得确实得注意一下)

说明:使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销,解决资 源不足的问题。如果不使用线程池,有可能造成系统创建大量同类线程而导致消耗完内存或者 “过度切换”的问题。

4. 【强制】线程池不允许使用 Executors 去创建,而是通过 ThreadPoolExecutor 的方式,这样 的处理方式让写的同学更加明确线程池的运行规则,规避资源耗尽的风险。 (这个以前只是为了方便没在意这一点)

说明:Executors 返回的线程池对象的弊端如下:
1)FixedThreadPool 和 SingleThreadPool:
允许的请求队列长度为 Integer.MAX_VALUE,可能会堆积大量的请求,从而导致 OOM。
2)CachedThreadPool 和 ScheduledThreadPool:
允许的创建线程数量为 Integer.MAX_VALUE,可能会创建大量的线程,从而导致 OOM。

5.【强制】SimpleDateFormat 是线程不安全的类,一般不要定义为static变量,如果定义为static,必须加锁,或者使用 DateUtils 工具类。 (SimpleDateFormat 的线程不安全性)

正例:注意线程安全,使用 DateUtils。
亦推荐如下处理:
private static final ThreadLocal df = new ThreadLocal() { @Override
protected DateFormat initialValue() {
return new SimpleDateFormat("yyyy-MM-dd");
} };
说明:如果是 JDK8 的应用,可以使用 Instant 代替 Date,LocalDateTime 代替 Calendar, DateTimeFormatter 代替 Simpledateformatter,官方给出的解释:simple beautiful strong immutable thread-safe。

6. 【强制】高并发时,同步调用应该去考量锁的性能损耗。能用无锁数据结构,就不要用锁;能 锁区块,就不要锁整个方法体;能用对象锁,就不要用类锁。

7. 【强制】对多个资源、数据库表、对象同时加锁时,需要保持一致的加锁顺序,否则可能会造 成死锁。

说明:线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作,那么线程二的加锁顺序 也必须是 A、B、C,否则可能出现死锁。

8. 【强制】并发修改同一记录时,避免更新丢失,需要加锁。要么在应用层加锁,要么在缓存加 锁,要么在数据库层使用乐观锁,使用 version 作为更新依据。 说明:如果每次访问冲突概率小于 20%,推荐使用乐观锁,否则使用悲观锁。乐观锁的重试次 数不得小于 3 次。

9. 【强制】多线程并行处理定时任务时,Timer 运行多个 TimeTask 时,只要其中之一没有捕获 抛出的异常,其它任务便会自动终止运行,使用 ScheduledExecutorService 则没有这个问题。(有待研究为什么没有这个问题)

10. 【推荐】使用 CountDownLatch 进行异步转同步操作,每个线程退出前必须调用 countDown方法,线程执行代码注意 catch 异常,确保 countDown 方法可以执行,避免主线程无法执行 至 await 方法,直到超时才返回结果。(不把countDownLath不减到0,执行不到await后面的方法)

说明:注意,子线程抛出异常堆栈,不能在主线程 try-catch 到。

11. 【推荐】避免 Random 实例被多线程使用,虽然共享该实例是线程安全的,但会因竞争同一 seed 导致的性能下降。(这个也不曾注意)

说明:Random 实例包括 java.util.Random 的实例或者 Math.random()实例。
正例:在 JDK7 之后,可以直接使用 API ThreadLocalRandom,在 JDK7 之前,可以做到每个 线程一个实例。

12. 【推荐】在并发场景下,通过双重检查锁(double-checked locking)实现延迟初始化的优 化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration),推荐问 题解决方案中较为简单一种(适用于 JDK5 及以上版本),将目标属性声明为 volatile 型。 反例:

class Foo {
private Helper helper = null; public Helper getHelper() {
if (helper == null) synchronized(this) { if (helper == null)
helper = new Helper();
}
return helper; }
// other functions and members...
}

13. 【参考】volatile 解决多线程内存不可见问题。对于一写多读,是可以解决变量同步问题, 但是如果多写,同样无法解决线程安全问题。如果是 count++操作,使用如下类实现: AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8,推 荐使用 LongAdder 对象,比 AtomicLong 性能更好(减少乐观锁的重试次数)。

14. 【参考】 HashMap 在容量不够进行 resize 时由于高并发可能出现死链,导致 CPU 飙升,在开发过程中注意规避此风险。(原因就是HashMap多线程不安全,HashMap不能作为共享变量,resize死链是出现在多线程同时发现大小超过门限值进行扩容是造成的问题)

15. 【参考】ThreadLocal 无法解决共享对象的更新问题,ThreadLocal 对象建议使用 static 修饰。这个变量是针对一个线程内所有操作共有的,所以设置为静态变量,所有此类实例共享 此静态变量 ,也就是说在类第一次被使用时装载,只分配一块存储空间,所有此类的对象(只 要是这个线程内定义的)都可以操控这个变量。(ThreadLocal用过但是没自己写过,待研究)

(七) 控制语句

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

2. 【强制】在 if/else/for/while/do 语句中必须使用大括号,即使只有一行代码,避免使用 下面的形式:if (condition) statements;(习惯,个人一直坚持加大括号)

3. 【推荐】推荐尽量少用 else, if-else 的方式可以改写成:

if (condition) { ...
return obj; }
// 接着写 else 的业务逻辑代码;
说明:如果非得使用if()...else if()...else...方式表达逻辑,【强制】请勿超过3层,
超过请使用状态设计模式。
正例:逻辑上超过 3 层的 if-else 代码可以使用卫语句,或者状态模式来实现。

4. 【推荐】除常用方法(如 getXxx/isXxx)等外,不要在条件判断中执行其它复杂的语句,将复 杂逻辑判断的结果赋值给一个有意义的布尔变量名,以提高可读性。

说明:很多 if 语句内的逻辑相当复杂,阅读者需要分析条件表达式的最终结果,才能明确什么 样的条件执行什么样的语句,那么,如果阅读者分析逻辑表达式错误呢?
正例:
//伪代码如下
boolean existed = (file.open(fileName, "w") != null) && (...) || (...); if (existed) {
... }
反例:
if ((file.open(fileName, "w") != null) && (...) || (...)) { ...
}

5. 【推荐】循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变量、获取数据库连接,进行不必要的 try-catch 操作(这个 try-catch 是否可以移至循环体外)。

6. 【推荐】接口入参保护,这种场景常见的是用于做批量操作的接口。

7. 【参考】方法中需要进行参数校验的场景:(尽可能早的发现由于参数的原因会导致的错误,一般RPC过来的接口和前台API接口都需要参数校验)

1) 调用频次低的方法。
2) 执行时间开销很大的方法,参数校验时间几乎可以忽略不计,但如果因为参数错误导致中间执行回退,或者错误,那得不偿失。
3) 需要极高稳定性和可用性的方法。
4) 对外提供的开放接口,不管是RPC/API/HTTP接口。 
5) 敏感权限入口。

8. 【参考】方法中不需要参数校验的场景:(什么时候不需要参数校验还真没怎么仔细考虑过)

1) 极有可能被循环调用的方法,不建议对参数进行校验。但在方法说明里必须注明外部参数检查要求。
2) 底层的方法调用频度都比较高,一般不校验。毕竟是像纯净水过滤的最后一道,参数错误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中,部署在同一 台服务器中,所以 DAO 的参数校验,可以省略。
3) 被声明成private只会被自己代码所调用的方法,如果能够确定调用方法的代码传入参 数已经做过检查或者肯定不会有问题,此时可以不校验参数。

(八) 注释规约

1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范,使用/*内容*/格式,不得使用 //xxx 方式。

说明:在 IDE 编辑窗口中,Javadoc 方式会提示相关注释,生成 Javadoc 可以正确输出相应注 释;在 IDE 中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高 阅读效率。

2. 【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、 异常说明外,还必须指出该方法做什么事情,实现什么功能。 说明:对子类的实现要求,或者调用注意事项,请一并说明。(哈哈,以前从来不注意,以后注意!)

3. 【强制】所有的类都必须添加创建者信息。(有这个意识,但是没怎么强制自己执行,一般项目里不怎么关心这个类是谁创建的,而是关心一个功能是谁写的)

4. 【强制】方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释

使用/ /注释,注意与代码对齐。

5. 【强制】所有的枚举类型字段必须要有注释,说明每个数据项的用途。(枚举我一般会做一个desc的属性,用来解释这个枚举元素的用途)

6. 【推荐】与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持 英文原文即可。(不仅如此,我觉得异常或者业务日志也得注意这一点)

反例:“TCP 连接超时”解释成“传输控制协议连接超时”,理解反而费脑筋。

7. 【推荐】代码修改的同时,注释也要进行相应的修改,尤其是参数、返回值、异常、核心逻辑 等的修改。(这个也是好习惯,以后多遵守)

说明:代码与注释更新不同步,就像路网与导航软件更新不同步一样,如果导航软件严重滞后, 就失去了导航的意义。

8. 【参考】注释掉的代码尽量要配合说明,而不是简单的注释掉。(这个是好习惯,一般以后会启用的代码我会加上注释,一般觉得基本不会再用都是直接删除)

说明:代码被注释掉有两种可能性:1)后续会恢复此段代码逻辑。2)永久不用。前者如果没 有备注信息,难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。

9. 【参考】对于注释的要求:

第一、能够准确反应设计思想和代码逻辑;
第二、能够描述业务含 义,使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路;注释也是给继任者看 的,使其能够快速接替自己的工作。

10. 【参考】好的命名、代码结构是自解释的,注释力求精简准确、表达到位。避免出现注释的一个极端:过多过滥的注释,代码的逻辑一旦修改,修改注释是相当大的负担。

反例:
// put elephant into fridge
put(elephant, fridge);
方法名 put,加上两个有意义的变量名 elephant 和 fridge,已经说明了这是在干什么,语义清晰的代码不需要额外的注释。

11. 【参考】特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描, 经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1) 待办事宜(TODO):( 标记人,标记时间,[预计处理时间]) 表示需要实现,但目前还未实现的功能。这实际上是一个 Javadoc 的标签,目前的 Javadoc还没有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个 Javadoc 标签)。 
2) 错误,不能工作(FIXME):(标记人,标记时间,[预计处理时间])在注释中用 FIXME 标记某代码是错误的,而且不能工作,需要及时纠正的情况。

(九) 其它

1. 【强制】在使用正则表达式时,利用好其预编译功能,可以有效加快正则匹配速度。 说明:不要在方法体内定义:Pattern pattern = Pattern.compile(规则);(这个以前还真没怎么注意,以后多多注意这些地方)

2. 【强制】velocity 调用 POJO 类的属性时,建议直接使用属性名取值即可,模板引擎会自动按 规范调用 POJO 的 getXxx(),如果是 boolean 基本数据类型变量(boolean 命名不需要加 is 前缀),会自动调用 isXxx()方法。

说明:注意如果是 Boolean 包装类对象,优先调用 getXxx()的方法。

3. 【强制】后台输送给页面的变量必须加$!{var}——中间的感叹号。 说明:如果 var=null 或者不存在,那么${var}会直接显示在页面上。(${var}显示在页面,产品是不能忍的)

4. 【强制】注意 Math.random() 这个方法返回是 double 类型,注意取值的范围 0≤x<1(能够 取到零值,注意除零异常),如果想获取整数类型的随机数,不要将 x 放大 10 的若干倍然后 取整,直接使用 Random 对象的 nextInt 或者 nextLong 方法。

5. 【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();(多多注意)

说明:如果想获取更加精确的纳秒级时间值,用 System.nanoTime()。在 JDK8 中,针对统计时间等场景,推荐使用Instant 类。

6. 【推荐】尽量不要在 velocity 模板中加入变量声明、逻辑运算符,更不要在模板中加入任何 复杂的逻辑。

7. 【推荐】任何数据结构的构造或初始化,都应指定大小,避免数据结构无限增长吃光内存。

8. 【推荐】对于“明确停止使用的代码和配置”,如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去,避免造成过多垃圾。(确定不用了,就把代码、文件删了吧,不然不好维护,而且项目加载也浪费内存,为什么说不好维护呢?比如说哪天一个方法里一个属性需要从int换成long,而这个方法都不用了,改也没必要,不该的话以后编译有不通过,还不如直接删除,况且IDEA也能清楚的看到方法或者类有没有被使用)

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
再次搞定 Ali 云函数计算 FC
原本早就该写完了微信 SDK 授权服务上云计划由于对 Ali 云函数计算 FC 的不熟悉遇到了很多的坑,再前面的文章中还吐槽了一通。在服务顺利跑通后,这回实打实的来总结一下顺利上云的保守指南~
22857 0
特稿|过去5年,阿里云是如何打造云原生数据库PolarDB的
阿里云在云原生数据库领域的自研创新突围。
23408 0
如何优雅的消除系统重复代码
在程序猿的日常工作中,不仅要跟随业务侧的发展不断开发新的需求,同时也需要维护老的已有平台。无论是开发新需求还是维护老系统,我们都会遇到同样一个问题,系统中总是充斥着很多重复的代码。
23813 0
初识Serverless函数计算
Serverless 并不是没有服务器,而是开发者不再需要关心服务器。在传统 Serverful 架构下,部署一个应用需要购买服务器,部署操作系统,搭建开发环境,编写代码,构建应用,部署应用,配置负载均衡机制,搭建日志分析与监控系统,应用上线后,继续监控应用的运行情况。而在 Serverless 架构下,开发者只需要关注应用的开发构建和部署,无需关心服务器相关操作与运维,在函数计算架构下,开发者只需要编写业务代码并监控业务运行情况。这将开发者从繁重的运维工作中解放出来,把精力投入到更有意义的业务开发上。
24394 0
【AI征文】对DeepRec认识以及了解
对DeepRec认识以及了解
57473 0
Tensorflow Serving部署模型与调用
本文以mnist为数据集,使用keras 构建CNN网络,将训练获取的模型通过Tensorflow Serving方式部署提供Rest Full接口,分别使用PostMan和Python调用服务,代码编辑调试使用阿里云PAI DSW实例,模型部署使用阿里云ECS虚拟机。
6048 0
业务中台之上的低代码应用开发平台
中台低代码平台帮助开发者掌握全栈能力,促进开发者提高工作效率,基于企业数字化业务能力组件,可以实现业务应用的敏捷按需装配,成为企业组装式应用创新平台,进而实现企业业务能力的持续优化和复用,促进从组织到企业甚至行业的业务能力集约与创新。
101021 0
十分钟生成影视级室内设计效果,红星美凯龙设计云如何升级传统家居行业
依托于阿里云强大的弹性云上GPU算力,红星美凯龙可以为客户提供快速的、高质量的渲染,实现秒级的门店快速设计。
65950 0
+关注
铭铭erom
目标:顶级互联网公司
35
文章
1
问答
文章排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载