信誉国际登陆

星期

2020年04月04日

为什么阿里工程师代码写的好?看看他的代码规范就知道了

2020-04-04 15:52:17 来(lai)源:互(hu)联(lian)网 阅读:-

摘要

本文(wen)主要讲解(jie)阿里JAVA开发(fa)手册中(zhong)比较重(zhong)要的设计(ji)规(gui)(gui)范(fan),这些重(zhong)要的设计(ji)规(gui)(gui)范(fan)有助于我们(men)改进自己的代码,提升系(xi)统的系(xi)统的性能。


曾经与一位从阿里出来的Java工程师一起工作过一段时间,他的技术说不上非常厉害,但是,他的代码写的的非常好,凡是他做的功能很少出现Bug。我就很好奇,于是经常向他请教一些代码设计的原则,然后他告诉了我阿里Java手册。并且,他将这个手册进行了修改,也成为了我司Java程序员的开发手册。这篇文章就让我们看一看这个手册中比较重要的原则。


为什么阿里工程师代码写的好?看看他的代码规范就知道了




【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

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


【强制】类型与中括号紧挨相连来表示数组。

正例(li):定(ding)义整形(xing)数组(zu) int[] arrayDemo; 反例(li):在 main 参(can)数中,使用 String args[]来(lai)定(ding)义。


【强制】POJO 类中布尔类型变量都不要加 is 前缀,否则部分框架解析会引起序列化错误。

说明(ming):表(biao)达是与否的(de)值采用(yong) is_xxx 的(de)命名(ming)方式(shi),所以,需要(yao)在 设置从 is_xxx 到 xxx 的(de)映(ying)射关系。

反例:定义为基本数据类型 Boolean isDeleted 的属性,它的方法也是 isDeleted(),RPC 框架在反向解 析的时候,“误以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异常。


【推荐】在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。

正例:startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例:startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD


为什么阿里工程师代码写的好?看看他的代码规范就知道了


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

正例:接口方法签名 void commit();

接口基础常量 String COMPANY = "alibaba";

反(fan)例:接口(kou)方法定义(yi) public abstract void f();

说明(ming):JDK8 中接口允许有默认实(shi)现(xian),那么这个(ge) default 方法,是对(dui)所(suo)有实(shi)现(xian)类(lei)都有价(jia)值的(de)默认实(shi)现(xian)。


【参考】枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。

说明:枚举其(qi)实(shi)就是特殊的类,域成员均为常量,且构(gou)造方法被默认强制是私有(you)。

正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKNOWN_REASON。


【参考】各层命名规约:

  • A) Service/DAO 层方法命名规约

1) 获取(qu)单(dan)个对象的方法用 get 做前缀(zhui)。

2) 获取(qu)多个对象的方法用 list 做(zuo)前缀(zhui),复(fu)数形(xing)式(shi)结尾如:listObjects。 3) 获取(qu)统计值的方法用 count 做(zuo)前缀(zhui)。

4) 插入的(de)方法用 save/insert 做(zuo)前缀。

5) 删除的方(fang)法用 remove/delete 做前缀(zhui)。

6) 修改的(de)方(fang)法(fa)用 update 做前缀。

  • B) 领域模型命名规约

1) 数据对(dui)象:xxxDO,xxx 即为数据表名。

2) 数(shu)据传输对象(xiang):xxxDTO,xxx 为(wei)业(ye)务(wu)领域相(xiang)关的名称。

3) 展示对象:xxxVO,xxx 一般(ban)为网页名称。

4) POJO 是 DO/DTO/BO/VO 的(de)统称,禁止命名成 xxxPOJO。


为什么阿里工程师代码写的好?看看他的代码规范就知道了


【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。

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

缓存(cun)(cun) get 时,由(you)于在代(dai)码复(fu)制时,漏掉下(xia)划线,导致缓存(cun)(cun)击穿而(er)出现问题


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


【强制】相同参数类型,相同业务含义,才可以使用Java的可变参数,避免使用Object。

说(shuo)明:可(ke)变参(can)(can)数必须放置在参(can)(can)数列表的最后。(提倡(chang)同(tong)学们尽量不(bu)用可(ke)变参(can)(can)数编(bian)程(cheng))

正例:public List listUsers(String type, Long... ids) {...}


【强制】所有整型包装类对象之间值的比较,全部使用equals方法比较。

说明(ming):对于(yu) Integer var = ? 在-128 至 127 范(fan)围内(nei)的赋值,Integer 对象是在 IntegerCache.cache 产 生,会(hui)(hui)(hui)复用已有对象,这(zhei)个区间(jian)内(nei)的 Integer 值可(ke)以直(zhi)接使用==进(jin)行判断(duan),但是这(zhei)个区间(jian)之(zhi)外的所有数 据,都会(hui)(hui)(hui)在堆上(shang)产生,并不会(hui)(hui)(hui)复用已有对象,这(zhei)是一个大坑(keng),推荐使用 equals 方法(fa)进(jin)行判断(duan)。


关于基本数据类型与包装数据类型的使用标准如下:

  • 1) 【强制】所有的 POJO 类属性必须使用包装数据类型。
  • 2) 【强制】RPC 方法的返回值和参数必须使用包装数据类型。 3) 【推荐】所有的局部变量使用基本数据类型。

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

正例:数据库的(de)查询结果可能是 null,因为自动拆箱,用(yong)基本(ben)数据类型接收有(you) NPE 风险。

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


为什么阿里工程师代码写的好?看看他的代码规范就知道了


【强制】POJO 类必须写 toString 方法。

使用 IDE 中的工(gong)具(ju):source> generate toString 时,如果继承了(le)另一(yi)(yi)个(ge) POJO 类,注意在前面(mian)加一(yi)(yi)下 super.toString。

说明:在方法执行抛出异常时,可以直接调用 POJO 的 toString()方法打印其属性值,便于排查问题。


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

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

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


【强制】线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。

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


【强制】线程池不允许使用Executors去创建,而是通过ThreadPoolExecutor的方式,这样的处理方式让写的同学更加明确线程池的运行规则,规避资源耗尽的风险。


为什么阿里工程师代码写的好?看看他的代码规范就知道了


总结

以(yi)上规(gui)范在(zai)设计代(dai)码(ma)中,是(shi)比较重要的原(yuan)则。如果编写代(dai)码(ma)的过程中,可(ke)以(yi)依照以(yi)上原(yuan)则,那(nei)代(dai)码(ma)的可(ke)读性(xing)和(he)可(ke)维护性(xing)将(jiang)大(da)大(da)提升

推荐阅读:移动硬盘有什么用