阿里巴巴代码规范

曾经终败给现在 2022-06-07 00:05 447阅读 0赞

# 1、关于本规范 #

本规范均出自阿里巴巴代码规范以及本人日常过程中的积累。由于篇幅有限，本文不予列出阿里巴巴代码规范的所有，仅列出本人觉得对日常使用过程中帮助较大且又是大家容易忽略的问题。  
阿里巴巴代码规范：http://pan.baidu.com/s/1slt3g0P

# 一、编程规约 #

## (一) 命名规约 ##

1、抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。  
2、中括号是数组类型的一部分，数组定义如下：String\[\] args; 反例：请勿使用String args\[\]的方式来定义。  
3、如果使用到了设计模式，建议在类名中体现出具体模式  
正例：public class OrderFactory; public class LoginProxy; public class ResourceObserver;  
4、各层命名规约：  
A) Service/DAO层方法命名规约  
1） 获取单个对象的方法用get做前缀。  
2） 获取多个对象的方法用list做前缀。  
3） 获取统计值的方法用count做前缀。  
4） 插入的方法用save（推荐）或insert做前缀。  
5） 删除的方法用remove（推荐）或delete做前缀。  
6） 修改的方法用update做前缀。

B) 领域模型命名规约  
1） 数据对象：xxxDO，xxx即为数据表名。  
3） 展示对象：xxxVO，xxx一般为网页名称。  
4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。

## (二) 常量定义 ##

1、long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。 说明：Long a = 2l; 写的是数字的21，还是Long型的2?

## (三) 格式规约 ##

## (四) OOP规约 ##

1、所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。 说明：对于Integer var=?在-128至127之间的赋值，Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。  
2、构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。  
3、POJO类必须写toString方法。使用IDE的中工具：source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。  
4、当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。  
5、类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法。  
说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为方法信息价值较低，所有Service和DAO的getter/setter方法放在类体最后。

## (五) 集合处理 ##

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  
3、在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生ConcurrentModificationException 异常。  
4、使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear方法会抛出UnsupportedOperationException异常。  
5、使用entrySet遍历Map类集合KV，而不是keySet方式进行遍历。 说明：keySet其实是遍历了2次，一次是转为Iterator对象，另一次是从hashMap中取出key所对应的value。而entrySet只是遍历了一次就把key和value都放到了entry中，效率更高。如果是JDK8，使用Map.foreach方法。

![这里写图片描述][format_png]  
7、利用Set元素唯一的特性，可以快速对一个集合进行去重操作，避免使用List的contains方法进行遍历、对比、去重操作。

## (六) 并发处理 ##

## (七) 控制语句 ##

1、在一个switch块内，每个case要么通过break/return等来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。  
2、推荐尽量少用else， if-else的方式可以改写成：  
if(condition)\{  
…  
return obj;  
\}  
// 接着写else的业务逻辑代码;  
说明：如果非得使用if()…else if()…else…方式表达逻辑，【强制】请勿超过3层，超过请使用状态设计模式。  
正例：逻辑上超过3层的if-else代码可以使用卫语句，或者状态模式来实现。  
3、除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。  
正例：  
//伪代码如下  
boolean existed = (file.open(fileName, “w”) != null) && (…) || (…);  
if (existed) \{  
…  
\}  
反例：  
if ((file.open(fileName, “w”) != null) && (…) || (…)) \{  
…  
\}  
4、循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch操作（这个try-catch是否可以移至循环体外）。

## (八) 注释规约 ##

1、类、类属性、类方法的注释必须使用Javadoc规范，使用/*内容/格式，不得使用//xxx方式。  
2、所有的抽象方法（包括接口中的方法）必须要用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。  
3、方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* \*/注释，注意与代码对齐。

## (九) 其它 ##

1、在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。 说明：不要在方法体内定义：Pattern pattern = Pattern.compile(规则);  
2、后台输送给页面的变量必须加$!\{var\}——中间的感叹号。  
3、注意 Math.random() 这个方法返回是double类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。  
4、获取当前毫秒数System.currentTimeMillis(); 而不是new Date().getTime(); 说明：如果想获取更加精确的纳秒级时间值，用System.nanoTime()。在JDK8中，针对统计时间等场景，推荐使用Instant类。

# 二、异常日志 #

## (一) 异常处理 ##

1、对大段代码进行try-catch，这是不负责任的表现。catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。  
2、finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。 说明：如果JDK7，可以使用try-with-resources方式。  
3、定义时区分unchecked / checked 异常，避免直接使用RuntimeException抛出，更不允许抛出Exception或者Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException等。

## (二) 日志规约 ##

1、对trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的方式。 说明：logger.debug("Processing trade with id: " + id + " symbol: " + symbol); 如果日志级别是warn，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象，会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。 正例：（条件）  
if (logger.isDebugEnabled()) \{  
logger.debug("Processing trade with id: " + id + " symbol: " + symbol);  
\}  
正例：（占位符）  
logger.debug("Processing trade with id: \{\} symbol : \{\} ", id, symbol);  
2、避免重复打印日志，浪费磁盘空间，务必在log4j.xml中设置additivity=false。 正例：

# 三、MySQL规约 #

## (一) 建表规约 ##

## (二) 索引规约 ##

1、业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。 说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验和控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。  
2、在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度。

## (三) SQL规约 ##

1、不要使用count(列名)或count(常量)来替代count(*)，count(*)就是SQL92定义的标准统计行数的语法，跟数据库无关，跟NULL和非NULL无关。 说明：count(\*)会统计值为NULL的行，而count(列名)不会统计此列为NULL值的行。  
2、count(distinct col) 计算该列除NULL之外的不重复数量。注意 count(distinct col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。  
3、当某一列的值全是NULL时，count(col)的返回结果为0，但sum(col)的返回结果为NULL，因此使用sum()时需注意NPE问题。  
正例：可以使用如下方式来避免sum的NPE问题：SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;  
4、使用ISNULL()来判断是否为NULL值。注意：NULL与任何值的直接比较都为NULL。 说明：  
1） NULL<>NULL的返回结果是NULL，而不是false。  
2） NULL=NULL的返回结果是NULL，而不是true。  
3） NULL<>1的返回结果是NULL，而不是true。

## (四) ORM规约 ##

# (三) 服务器规约 #

1、高并发服务器建议调小TCP协议的time\_wait超时时间。 说明：操作系统默认240秒后，才会关闭处于time\_wait状态的连接，在高并发访问下，服务器端会因为处于time\_wait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。 正例：在linux服务器上请通过变更/etc/sysctl.conf文件去修改该缺省值（秒）： net.ipv4.tcp\_fin\_timeout = 30  
2、调大服务器所支持的最大文件句柄数（File Descriptor，简写为fd）。 说明：主流操作系统的设计是将TCP/UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd。主流的linux服务器默认所支持最大fd数量为1024，当并发连接数很大时很容易因为fd不足而出现“open too many files”错误，导致新的连接无法建立。 建议将linux服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。  
3、给JVM设置-XX:+HeapDumpOnOutOfMemoryError参数，让JVM碰到OOM场景时输出dump信息。 说明：OOM的发生是有概率的，甚至有规律地相隔数月才出现一例，出现时的现场信息对查错非常有价值。

[format_png]: /images/20220607/a8625b14d35b4490a5d7863b2bc164d6.png