命名

类、方法或字段的命名必须基本见名达意。如：

过滤List<Integer>的奇数：

代码粒度

大部分人查看代码的习惯都是，先看整体再看细节。所以，需要有模块化和抽象思维，将大块的复杂逻辑提炼成类或函数，屏蔽细节。

简单来说就是，对复杂业务逻辑，主方法只处理主干，分枝由其他方法处理，以直观的方式体现主要流程。

比如：

null判断与处理

方法

如果方法可能返回null则，必须注解javax.annotation.Nullable或javax.annotation.CheckForNull。（注：如果是实现类，则该注解必须注解在接口方法中，而不是具体实现类）

• 作用1：明确接口可能会响应null，以便于开发人员更直观的认识接口。
• 作用2：使用如IDEA inspections，Ali-Check，FindBugs,SonarLint等插件可以更好的辅助排查空指针问题。

方法参数

如果方法参数可接收为null的参数，则必须注解javax.annotation.Nullable。

如果没有注解Nullable的参数默认一定是非null。

如果符合上述规范的代码要求，可以简化对null判断的逻辑操作（基本无效操作，只是为了保证non-null。这是因为在以前的代码规范中，没有明确的表达某个接口是否会有null返回，需要假设所有的接口都有可能返回null，为了保证程序的健壮性，需要在各个地方都进行non-null判断。所以后来出现JAVA标准jsr305来处理该问题）。

简化null判断代码示例：

流程处理

在if，for，while, iterator等流程控制语法中，必须遵守最短路径原则。即流程可结束立即结束，以可短路的分支作为优先判断逻辑。

作用：简化复杂逻辑、简化代码的层次嵌套，避免多次缩进，代码阅读时理解困难。

示例：

重构示例：

if逻辑判断

在使用if进行逻辑判断时，如果逻辑判断复杂，应该使用能表达逻辑判断语义的命名变量来表示。

如：

而不是直接使用：

区别在于，查看代码的人员不需要额外的理解这个复杂的表达式所想表达的语义。而是通过变量名可以先有直语的语义环境，促进对复杂表达式的阅读理解。

创建集合类

集合类的创建必须有明确或者有评估容量指定。

作用：集合类在创建时都会有默认的容量大小。如ArrayList默认初始化容量为10（每次扩容为当前容量的1.5倍），HashMap的默认初始化容量为16（实际容量：16 * 0.75 = 12，即如果超过12会触发扩容，每次扩容为2倍容量）。如果放置的元素超过容量大小，会触发扩容操作，而扩容操作是相对复杂的，需要：

• 创建一个新的容量数组（申请内存）
• 将旧的数据复制到新的数组（数据复制）

这个过程是相对非常耗时的。

所以，创建集合类时创建符合预期容量大小的容量，可以有效的减少扩容次数，提升性能。

传参

集合类List,Set,Map,对象在作为参数进行传递时，正常情况下禁止对其进行修改。除非非常明确该修改是符合预期的行为。

禁止修改原因：

• 原始集合类创建的业务方法中，无法评估该集合是否产生了非预期行为的变化。比如：某数据被删除，新增了某个数据。
• 下游方法无得知该集合是否可变。

同理，在对象的传递中，被调用的方法内部也需要考虑对对象的操作是否是符合上下文预期，符合方法预期的。

相等符号 == 使用注意事项

对象或类的相等性判断==是判断其引用地址是否相同。

如：Object a = new Object(); Object b = new Object(); a == b一定是false。

所以，在使用==符号时必须明确的知道其在JVM中被赋予的功能。

相同的，在数字相等性比较中，比如1 == 1，一定是true。但是在JVM中有时候并不是这样的。

如下代码：

这是因为在JVM中，基础类型涉及到自动拆/装箱逻辑。在基础类型被需求为对象时都会进行装箱操作。也就是说二者的相等性对比变成了对象引用地址是否相同的比较。

所以，上述代码中就变成对比a和b，c和d的引用地址是否相同，而不是对比1 == 1和10086 == 10086的逻辑了。

那么，为什么a与b引用地址相同，但是b与c的引用地址不同呢？

这是因为Integer缓存了-128 ~ 127数值的对象。如果数字在这个范围内，返回的对象都是相同的。

（如果是逻辑运算，>、<等会触发基础类型的封装类型的自动拆箱操作，或者判断==的基础类型中某一方不是封装类型也会触发自动拆箱操作（如：int a=199,;Integer b = 199; a == b则不存在以上问题）

同理，其他的基础类型也都有相同的缓存实现。（String不是基础类型）

所以，通常情况下，二个对象是否相同的判断必须使用equals。

equals的使用

• 常量必须在前。如"true".equals(isLaegal)
• 建议使用：Objects.equals(a,b)

线程池的使用

线程池禁止直接使用Executors创建。

比如：Executors.newScheduledThreadPool(100);。 其他创建一个corePoolSize=100核心线程，但是默认的maximumPoolSize=Integer.MAX_VALUE。

如果使用不当，会创建出超过预期的线程数量，堆积大量的请求，导致OOM。

try catch finally

禁止在finally代码块中使用return语句。

finally的执行逻辑是：在try代码块中遇到return，执行finally，finally执行完成，返回try代码块的return结果。

而如果在finally遇到return，则直接返回该return结果。不会返回try代码块的return结果。

switch使用

switch必须指定default。如：

避免在case中忘记写break，以及不存在任意匹配规则时的执行业务逻辑（即没有任何的case被命中）。（强制原因：国外友人因为没写break，并且没有default，导致了几亿美元的损失，后来就成为该约定了）

ThreadLocal使用

ThreadLocal的原理决定了其元素在使用时可能存在逃逸问题。

所以，在使用ThreadLocal时，必须明确的调用remove方法。

通常情况下，ThreadLocal是为在同一线程执行过程中会多次使用到的同一实例。 ThreadLocal正常需要在有一个全局的执行点执行remove操作。在使用ThreadLocal时，设计上必须考虑如果remove的问题。

阿里规范：

必须回收自定义的ThreadLocal变量，尤其在线程池场景下，线程经常会被复用，如果不清理自定义的 ThreadLocal变量，可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用try-finally块进行回收。

正则表达式

正则Pattern可以在相同的表达式中是线程安全的，所以在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

不要在方法体内定义：Pattern pattern = Pattern.compile(规则)。

使用工具

SonarLint

SonarLint是相对比较全面的检测，但是无法检测编译好的类（编译好的需要使用FindBugs）

主要分为三类报告：

• Blocker：对应严重的问题，原则上必须处理所有的Blocker报告。如果不能处理必须写有原因注释，并标注@todo或者@fixme。
• Marjor：对应警告性信息，原则上需要处理。部份不处理的，需要注解@SuppressWarnings。
• Minor：对应微弱警告性信息，原则上需要处理可处理的。

Ali-Check

AliCheck主要分为三类报告：

• BLOCKER: 对应严重的问题，原则上必须处理。如果不能处理必须写有原因注释，并标注@todo或者@fixme。
• CRITICAL： 对应警告性信息，原则上需要处理。部份不处理的，需要注解@SuppressWarnings。
• MAJOR：对应微弱警告性信息，原则上需要处理可处理的。

代码提交标准

任何人在代码提交之前，必须通过Ali-Check及SonarLint的双重检测标准。