阿里巴巴java开发手册-嵩山版

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

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。

正例：alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。

反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

正例：日本人 / 印度人 / blockList / allowList / secondary

反例：RIBENGUIZI / Asan / blackList / whiteList / slave

正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

正例： localValue / getHttpMessage() / inputUserId

正例：MAX_STOCK_COUNT

反例：MAX_COUNT

正例：定义整形数组int[] arrayDemo

反例：在main参数中，使用String args[]来定义

说明：在本文MySQL规约中的建表约定第一条，表达是与否的变量采用is_xxx的命名方式，所以，需要
在<resultMap>设置从is_xxx 到xxx 的映射关系。

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

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

说明：：子类、父类成员变量名相同，即使是public类型的变量也能够通过编译，另外，局部变量在同一方
法内的不同代码块中同名也是合法的，这些情况都要避免。对于非setter/getter的参数名称也要避免与成
员变量名称相同。

反例：

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

正例：对某个对象引用的volatile字段进行原子更新的类名为AtomicReferenceFieldUpdater。

反例：常见的方法内变量为int a;的定义方式。

正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT

反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

正例：public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

正例：接口方法签名 void commit();
接口基础常量 String COMPANY = "alibaba";

反例：接口方法定义：public abstract void f();

说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露
出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。

2）【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able 的形式）。

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKOWN_REASON。

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

B) 领域模型命名规约

反例：String key = "Id#taobao_" + tradeId;
           cache.put(key, value);
// 本例中，开发者A定义了缓存的key，然后开发者B使用
缓存时少了下划线，即key是"Id#taobao"+tradeId，导致
出现故障

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

说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。

2） 应用内共享常量：放置在一方库中，通常是 modules 中的 constant 目录下。

3） 子工程内部共享常量：即在当前子工程的 constant 目录下。

4） 包内共享常量：即在当前包下单独的 constant 目录下。

5） 类内共享常量：直接在类内部 private static final 定义。

正例：

1） 左大括号前不换行。

2） 左大括号后换行。

3） 右大括号前换行。

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

正例：if (flag == 0)

反例：if (空格 a == b 空格)

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

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

正例： （涉及 1-5 点）

正例：// 注释内容，注意在//和注释内容之间有一个空格。

正例：double first = 3.2d;
           int second = (int)first + 2;

1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。

2） 运算符与下文一起换行。

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

4） 方法调用时，多个参数，需要换行时，在逗号后进行。

5） 在括号前不要换行，见反例。

正例：

反例：

正例：下例中实参的args1，后边必须要有一个空格。
            method(args1, args2, args3);

说明：除注释之外的方法签名、左右大括号、方法内代码、
空行、回车及任何不可见字符的总行数不超过80 行。

正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，
使主干代码更加清晰；共性逻辑抽取成为共性方法，便于复用和维护。

正例：

说明：增加sb这个变量，如果需要对齐，则给one、two、three都要增加几个空格，
在变量比较多的情况下，是非常累赘的事情。

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

说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）

正例：public User getUsers(String type, Integer... ids) {...}

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

正例："test".equals(object);

反例：object.equals("test");

说明：推荐使用JDK7引入的工具类java.util.Objects#equals(Object a, Object b)

说明：对于 Integer var = ? 在-128 至 127 范围内的赋值，Integer 对象是在IntegerCache.cache 产生，
会复用已有对象，这个区间内的 Integer 值可以直接使用==进行判断，但是这个区间之外的所有数据，
都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。

说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进
制无法精确表示大部分的十进制小数。具体原理可以查看计算机组成原理中浮点数章节

反例：

正例：

说明：：equals()方法会比较值和精度（1.0与1.00返回结果为false），而compareTo()则会忽略精度。

正例：数据库字段的bigint必须与类属性的Long类型相对应

反例：某个案例的数据库表id字段定义类型bigint unsigned，实际类对象属性为Integer，
随着id越来越大，超过Integer的表示范围而溢出成为负数

说明：BigDecimal(double)存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。
如：BigDecimal g = new BigDecimal(0.1F); 实际的存储值为：0.10000000149

正例：优先推荐入参为String的构造方法，或使用BigDecimal的valueOf方法，此方法内部其实执行了
Double 的toString，而 Double 的toString 按 double 的实际能表达的精度对尾数进行了截断。
    BigDecimal recommend1 = new BigDecimal("0.1");
    BigDecimal recommend2 = BigDecimal.valueOf(0.1);

1） 【强制】所有的 POJO 类属性必须使用包装数据类型。

2） 【强制】RPC 方法的返回值和参数必须使用包装数据类型。

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

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

正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

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

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

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

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

说明：框架在调用属性xxx的提取方法时，并不能确定哪个方法一定是被优先调用到的。

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

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

反例：

说明：下例中，反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象，然后进行append
操作，最后通过toString方法返回String对象，造成内存资源浪费。

反例：

1） 不允许被继承的类，如：String类。

2） 不允许修改引用的域对象，如：POJO类的域变量。

3） 不允许被覆写的方法，如：POJO类的setter方法。

4） 不允许运行过程中重新赋值的局部变量。

5） 避免上下文重复使用一个变量，使用final关键字可以强制
       重新定义一个变量，方便更好地进行重构。

说明：对象clone方法默认是浅拷贝，若想实现深拷贝，
           需覆写clone方法实现域对象的深度遍历式拷贝。

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

说明：日期格式化时，yyyy表示当天所在的年，而大写的YYYY代表是week in which year（JDK7之后
引入的概念），意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的YYYY
就是下一年。

正例：表示日期和时间的格式如下所示：
new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")

说明：日期格式中的这两对字母表意如下：

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

1）java.sql.Date

2）java.sql.Time。

3）java.sql.Timestamp

说明：第1个不记录时间，getHours()抛出异常；第2个不记录日期，getYear()抛出异常；第3个在构造
方法super((time/1000)*1000)，在 Timestamp 属性 fastTime 和 nanos 分别存储秒和纳秒信息。

反例： java.util.Date.after(Date)进行时间比较时，当入参是 java.sql.Timestamp 时，会触发 JDK
BUG(JDK9 已修复)，可能导致比较时的意外结果。

正例：

反例：

说明：参考JDK原生注释，Month value is 0-based. e.g., 0 for January.

正例： Calendar.JANUARY，Calendar.FEBRUARY，Calendar.MARCH
等来指代相应月份来进行传参或比较。

1） 只要覆写equals，就必须覆写hashCode

2） 因为Set存储的是不重复的对象，依据hashCode和equals进行判断，
所以Set存储的对象必须覆写这两种方法

3） 如果自定义对象作为Map的键，那么必须覆写hashCode和equals

说明：String 因为覆写了hashCode和equals方法，所以可以愉快地将String对象作为key来使用

说明：在某些集合中，前者的时间复杂度为O(1)，而且可读性更好

正例：

说明：参数mergeFunction的作用是当出现key重复时，自定义对value的处理策略

正例：

反例：

说明：在java.util.HashMap 的 merge 方法里会进行如下的判断：

反例：

说明：subList()返回的是ArrayList 的内部类SubList，并不是 ArrayList 本身，而是ArrayList 的一个视
图，对于SubList的所有操作最终会反映到原列表上。

反例：如果查询无结果，返回Collections.emptyList()空集合对象，调用方一旦进行了
添加元素的操作，就会触发UnsupportedOperationException 异常

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

正例：

说明：使用toArray带参方法，数组空间大小的length：
1） 等于0，动态创建与size相同的数组，性能最好。
2） 大于0但小于size，重新创建大小等于size的数组，增加GC负担。
3） 等于size，在高并发情况下，数组创建完成之后，size正在变大的情况下，负面影响与2相同。
4） 大于size，空间浪费，且在size处插入null值，存在NPE隐患。

说明：在ArrayList#addAll 方法的第一行代码即Object[] a = c.toArray(); 其中 c为输入集合参数，如果
为null，则直接抛出异常。

说明：asList 的返回对象是一个Arrays内部类，并没有实现集合的修改方法。
Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组
    String[] str = new String[] { "chen", "yang", "hao" };
    List list = Arrays.asList(str);
第一种情况：list.add("yangguanbao"); 运行时异常。
第二种情况：str[0] = "change"; 也会随之修改，反之亦然。

说明：扩展说一下PECS(Producer Extends Consumer Super)原则：第一、频繁往外读取内容的，适合用
<? extends T>。第二、经常往里插入的，适合用<? super T>

说明：毕竟泛型是在JDK5后才出现，考虑到向前兼容，编译器是允许非泛型集合与泛型集合互相赋值

反例：

正例：

反例：

说明：三个条件如下
1） x，y的比较结果和y，x的比较结果相反。
2） x>y，y>z，则x>z。
3） x=y，则x，z比较结果和y，z比较结果相同。

反例：下例中没有处理相等的情况，交换两个对象判断结果并不互反，
不符合第一个条件，在实际使用中可能会出现异常。

说明：菱形泛型，即diamond，直接使用<>来指代前边已经指定的类型

正例：

说明：HashMap使用HashMap(int initialCapacity) 初始化，
如果暂时无法确定集合大小，那么指定默认值（16）即可

正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即loader factor）默认
为0.75，如果暂时无法确定初始值大小，请设置为16（即默认值）

反例： HashMap需要放置1024个元素，由于没有设置容量初始大小，随着元素增加而被迫不断扩容，
resize()方法总共会调用8次，反复重建哈希表和数据迁移。当放置的集合元素个数达千万级时会影响程序
性能

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

正例：values()返回的是V值集合，是一个list集合对象；keySet()返回的是K值集合，是一个Set集合对
象；entrySet()返回的是K-V值组合集合

表格

反例：由于HashMap的干扰，很多人认为ConcurrentHashMap是可以置入null值，
而事实上，存储null 值时会抛出NPE异常。

说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。
如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是 order/sort

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

正例：自定义线程工厂，并且根据外部特征进行分组，比如，来自同一机房的调用，把机房编号赋值给
whatFeatureOfGroup

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

说明：Executors 返回的线程池对象的弊端如下：

正例：注意线程安全，使用 DateUtils。亦推荐如上处理：

说明：如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，DateTimeFormatter
代替 SimpleDateFormat，官方给出的解释：simple beautiful strong immutable thread-safe。

正例：

说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。

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

说明一：如果在lock方法与try代码块之间的方法调用抛出异常，那么无法解锁，造成其它线程无法成功
获取锁

说明二：如果lock方法在try代码块之内，可能由于其它方法抛出异常，导致在finally代码块中，unlock
对未加锁的对象解锁，它会调用AQS的tryRelease方法（取决于具体实现类），抛出
IllegalMonitorStateException 异常

说明三：在Lock对象的lock方法实现中可能抛出unchecked异常，产生的后果与说明二相同

正例：

反例：

说明：Lock对象的unlock方法在执行时，它会调用AQS的tryRelease方法（取决于具体实现类），如果
当前线程不持有锁，则抛出IllegalMonitorStateException 异常

正例：

说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，
否则使用悲观锁。乐观锁的重试次数不得小于 3 次。

说明：乐观锁在获得锁的同时已经完成了更新操作，校验逻辑容易出现漏洞，另外，乐观锁对冲突的解决策
略有较复杂的要求，处理不当容易造成系统压力或数据异常，所以资金相关的金融敏感信息不建议使用乐观
锁更新。

正例：悲观锁遵循一锁、二判、三更新、四释放的原则

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

说明：Random 实例包括 java.util.Random 的实例或者 Math.random()的方式。

正例：在 JDK7 之后，可以直接使用 API ThreadLocalRandom，而在 JDK7 之前，
需要编码保证每个线程持有一个单独的Random实例。

正例：

说明：如果是count++操作，使用如下类实现：AtomicInteger count = new AtomicInteger();
count.addAndGet(1); 如果是JDK8，推荐使用LongAdder 对象，比AtomicLong性能更好（减少乐观
锁的重试次数）

说明：这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量，
也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可
以操控这个变量

说明：注意break是退出switch语句块，而return是退出方法体

反例：如上的代码输出是什么？

说明：即使只有一行代码，也禁止不采用大括号的编码方式：if (condition) statements;

说明：以下两种场景会触发类型对齐的拆箱操作：

1） 表达式1或表达式2的值只要有一个是原始类型

2） 表达式1或表达式2的值的类型不一致，会强制拆箱升级成表示范围更大的那个类型

反例：

说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间
判断条件来代替

反例：判断剩余奖品数量等于0时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成
了负数，这样的话，活动无法终止

说明：这样做逻辑清晰，有利于代码阅读时重点关注

说明：如果非使用if()...else if()...else...方式表达逻辑，避免后续代码维护困难，请勿超过3层

正例：超过3层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，
其中卫语句示例如上：

说明：很多 if 语句内的逻辑表达式相当复杂，与、或、取反混合运算，甚至各种方法纵深调用，理解成本
非常高。如果赋值一个非常好理解的布尔变量名字，则是件令人爽心悦目的事情

正例：

反例：

说明：赋值点类似于人体的穴位，对于代码的理解至关重要，所以赋值语句需要清晰地单独成为一行

反例：

说明：取反逻辑不利于快速理解，并且取反逻辑写法一般都存在对应的正向逻辑写法

正例：使用if (x < 628) 来表达 x 小于628

反例：使用if (!(x >= 628)) 来表达 x 小于628

反例：某业务系统，提供一个用户批量查询的接口，API文档上有说最多查多少个，但接口实现上没做任何
保护，导致调用方传了一个1000的用户id数组过来后，查询信息后，内存爆了

1） 调用频次低的方法。

2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，
但如果因为参数错误导致中间执行回退，或者错误，那得不偿失

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

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

5） 敏感权限入口

1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。

2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。
一般 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，所以 DAO 的参数校验，可以省略。

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

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

说明：对子类的实现要求，或者调用注意事项，请一并说明。

说明：在设置模板时，注意IDEA的@author为`${USER}`，而 eclipse的@author为`${user}`，大小写有
区别，而日期的设置统一为yyyy/MM/dd的格式

正例：

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

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

说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，
难以知晓注释动机。后者建议直接删掉即可，假如需要查阅历史代码，登录代码仓库即可。

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

1） 待办事宜（TODO）:（标记人，标记时间，[预计处理时间]）
表示需要实现，但目前还未实现的功能。这实际上是一个Javadoc的标签，目前的Javadoc还没
有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个Javadoc标签）

2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况

说明：

说明：此条约定有利于数据层面上的协作更加高效，减少前端很多琐碎的null判断

说明：四个部分的涉众对象分别是浏览器、前端开发、错误排查人员、用户。其中输出给用户的提示信息
要求：简短清晰、提示友好，引导用户进行下一步操作或解释错误原因，提示信息可以包括错误原因、上
下文环境、推荐操作等。 errorCode：参考附表3。errorMessage：简要描述后端出错原因，便于错误排
查人员快速定位问题，注意不要包含敏感数据信息

正例：常见的HTTP状态码如下：
1） 200 OK: 表明该请求被成功地完成，所请求的资源发送到客户端。
2） 401 Unauthorized: 请求要求身份验证，常见对于需要登录而用户未登录的情况。
3） 403 Forbidden：服务器拒绝请求，常见于机密信息或复制其它登录用户链接访问服务器的情况。
4） 404 Not Found: 服务器无法取得所请求的网页，请求资源不存在。
5） 500 Internal Server Error: 服务器内部错误

正例：errorCode / errorMessage / assetStatus / menuList / orderList / configFlag

反例：ERRORCODE / ERROR_CODE / error_message / error-message / errormessage /
ErrorMessage / msg

说明：Java服务端如果直接返回Long整型数据给前端，JS会自动转换为Number类型（注：此类型为双
精度浮点数，表示原理与取值范围等同于Java中的Double）。Long类型能表示的最大值是2的63次方-1，
在取值范围之内，超过2的53次方 (9007199254740992)的数值转化为JS的Number时，有些数值会有
精度损失。扩展说明，在Long取值范围内，任何2的指数次整数都是绝对不会存在精度损失的，所以说
精度损失是一个概率问题。若浮点数尾数位与指数位空间不限，则可以精确表示任何整数，但很不幸，
双精度浮点数的尾数位只有52位

反例：通常在订单号或交易号大于等于16位，大概率会出现前后端单据不一致的情况，比如，"orderId":
362909601374617692，前端拿到的值却是: 362909601374617660

说明：不同浏览器对于URL的最大长度限制略有不同，并且对超出最大长度的处理逻辑也有差异，2048
字节是取所有浏览器的最小值

反例：某业务将退货的商品id列表放在URL中作为参数传递，当一次退货商品数量过多时，URL参数超长，
传递到后端的参数被截断，导致部分商品未能正确退货

说明：nginx默认限制是1MB，tomcat默认限制为2MB，当确实有业务需要传较大内容时，可以通过调
大服务器端的限制

说明：缓存有利于减少交互次数，减少交互的平均延迟

正例：http 1.1 中，s-maxage告诉服务器进行缓存，时间单位为秒，用法如下，
response.setHeader("Cache-Control", "s-maxage=" + cacheSeconds);

说明：尽管HTTP支持使用不同的输出格式，例如纯文本，JSON，CSV，XML，RSS甚至HTML。如果我
们使用的面向用户的服务，应该选择JSON作为通信中使用的标准数据交换格式，包括请求和响应。此外，
application/JSON 是一种通用的MIME类型，具有实用、精简、易读的特点

说明：当用户在低版本与高版本之间反复切换工作时，会导致迁移复杂度升高，存在数据错乱风险

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

说明：Apache BeanUtils 性能较差，可以使用其他方案比如Spring BeanUtils, Cglib BeanCopier，注意
均是浅拷贝

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

说明：如果 var=null 或者不存在，那么${var}会直接显示在页面上。

说明：根据 MVC 理论，视图的职责是展示，不要抢模型和控制器的活。

说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。

正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)
来说明注释掉代码的理由。如

说明： 错误码想得过于完美和复杂，就像康熙字典中的生僻字一样，用词似乎精准，但是字典不容易随身
携带并且简单易懂

正例：错误码回答的问题是谁的错？错在哪？1）错误码必须能够快速知晓错误来源，可快速判断是谁的问
题。2）错误码必须能够进行清晰地比对（代码中容易equals）。3）错误码有利于团队快速对错误原因达
到一致认知

说明：错误码以不断追加的方式进行兼容。错误等级由日志和错误码本身的释义来决定

说明：错误产生来源分为A/B/C，A表示错误来源于用户，比如参数错误，用户安装版本过低，用户支付
超时等问题；B表示错误来源于当前系统，往往是业务逻辑出错，或程序健壮性差等问题；C表示错误来源
于第三方服务，比如CDN服务出错，消息投递超时等问题；四位数字编号从0001到9999，大类之间的
步长间距预留100，参考文末附表3

说明：尽可能在原有错误码附表中找到语义相同或者相近的错误码在代码中使用即可

说明：堆栈（stack_trace）、错误信息(error_message)、错误码（error_code）、提示信息（user_tip）
是一个有效关联并互相转义的和谐整体，但是请勿互相越俎代庖

说明：在无法更加具体确定的错误场景中，可以直接使用一级宏观错误码，分别是：A0001（用户端错误）、
B0001（系统执行出错）、C0001（调用第三方服务出错）

正例：调用第三方服务出错是一级，中间件错误是二级，消息服务出错是三级

说明：英文单词形式的错误码不利于非英语母语国家（如阿拉伯语、希伯来语、俄罗斯语等）之间的开发
者互相协作

说明：数字是一个整体，每位数字的地位和含义是相同的

反例：一个五位数字12345，第1位是错误等级，第2位是错误来源，345是编号，人的大脑不会主动地
拆开并分辨每位数字的不同含义

说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，可能存在数字格式错误，不得不
通过catch NumberFormatException 来实现

正例：if (obj != null) {...}

反例：try { obj.method() } catch (NullPointerException e) {...}

说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多

说明：对大段代码进行try-catch，使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，
这是一种不负责任的表现

正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程
序上作出分门别类的判断，并提示给用户

说明：如果 JDK7 及以上，可以使用 try-with-resources 方式。

说明：try块中的return语句执行成功后，并不马上返回，而是继续执行finally块中的语句，如果此处存
在return 语句，则在此直接返回，无情丢弃掉try块中的返回点

反例：

说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。

说明：通过反射机制来调用方法，如果找不到方法，抛出NoSuchMethodException。什么情况会抛出
NoSuchMethodError 呢？二方包在类冲突时，仲裁机制可能导致引入非预期的版本使类的方法签名不匹配，
或者在字节码修改框架（比如：ASM）动态创建或修改类时，修改了相应的方法签名。这些情况，即使代
码编译期是正确的，但在代码运行期时，会抛出NoSuchMethodError

说明：本手册明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也
并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回null的情况

1）返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。

2） 数据库的查询结果可能为 null。

3） 集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。

4） 远程调用返回对象时，一律要求进行空指针判断，防止 NPE。

5） 对于 Session 中获取的数据，建议 NPE 检查，避免空指针。

6） 级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE。

说明：关于RPC方法返回方式使用Result方式的理由：

1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。

2）如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题
的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。

说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。
必要时抽取共性方法，或者抽象公共类，甚至是组件化。

正例：一个类中有多个 public 方法，都需要进行数行相同的参数校验操作，这个时候请抽取：
private boolean checkParam(DTO dto) {...}

说明：日志框架（SLF4J、JCL--Jakarta Commons Logging）的使用方式（推荐使用SLF4J）
    使用SLF4J：
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    private static final Logger logger = LoggerFactory.getLogger(Test.class);
    使用JCL：
    import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    private static final Log log = LogFactory.getLog(Test.class);

正例：以aap应用为例，日志保存在/home/admin/aapserver/logs/aap.log，历史日志名称为
aap.log.2016-08-01

说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系
统进行及时监控

正例：mppserver应用中单独监控时区转换异常，如：mppserver_monitor_timeZoneConvert.log

说明：因为String字符串的拼接会使用StringBuilder的append()方式，有一定的性能损耗。使用占位符仅
是替换动作，可以有效提升性能

正例：logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);

说明：虽然在debug(参数)的方法体内第一行代码isDisabled(Level.DEBUG_INT)为真时（Slf4j 的常见实现
Log4j 和Logback），就直接return，但是参数可能会进行字符串拼接运算。此外，如果debug(getName())
这种参数内有getName()方法调用，无谓浪费方法调用的开销

正例：

正例：<logger name="com.taobao.dubbo.config" additivity="false">

说明：标准日志输出与标准错误输出文件每次Jboss重启时才滚动，如果
大量输出送往这两个文件，容易造成文件大小超过操作系统大小限制

正例：logger.error("inputParams:{} and errorMessage:{}", 各类参数或者对象 toString(), e.getMessage(), e);

说明：如果对象里某些get方法被覆写，存在抛出异常的情况，则可能会因为打印日志而影响正常业务流
程的执行

正例：打印日志时仅打印出业务相关属性值或者调用其对象的toString()方法

说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些
日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

说明：注意日志输出的级别，error级别只记录系统逻辑出错、异常或者重要的错误信息

说明：国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息

• A：Automatic（自动化）

• I：Independent（独立性）

• R：Repeatable（可重复）

说明：任何字段如果为非负数，必须是 unsigned。

注意：POJO类中的任何布尔类型的变量，都不要加is前缀，所以，需要在<resultMap>设置从is_xxx到
Xxx 的映射关系。数据库表示是与否的值，使用tinyint类型，坚持is_xxx的命名方式是为了明确其取值含
义与取值范

正例：表达逻辑删除的字段名 is_deleted，1 表示删除，0 表示未删除。

说明：MySQL在Windows下不区分大小写，但在Linux下默认是区分大小写。因此，数据库名、表名、
字段名，都不允许出现任何大写字母，避免节外生枝

正例：aliyun_admin，rdc_config，level3_name

反例：AliyunAdmin，rdcConfig，level_3_name

说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，
对应于 DO 类名也是单数形式，符合表达习惯。

说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。

说明：float 和 double 在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确
的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数分开存储。

说明：其中id必为主键，类型为bigint unsigned、单表时自增、步长为1。create_time, update_time
的类型均为datetime类型，前者现在时表示主动式创建，后者过去分词表示被动式更新

正例：alipay_task / force_project / trade_config

1）不是频繁修改的字段。

2） 不是唯一索引的字段

3） 不是varchar超长字段，更不能是text字段

正例：各业务线经常冗余存储商品名称，避免查询时需要调用IC服务获取

说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。

说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，
即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生

说明：即使双表 join 也要注意表索引、SQL 性能。

说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为20的索引，区分度会高达90%
以上，可以使用count(distinct left(列名, 索引长度))/count(*)的区分度来确定

说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

正例：where a=? and b=? order by c; 索引：a_b_c

反例：索引如果存在范围查询，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b;
索引a_b无法排序

说明：如果一本书需要知道第11章是什么标题，会翻开第11章对应的那一页吗？目录浏览一下就好，这
个目录就是起到覆盖索引的作用

正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效
果，用explain 的结果，extra列会出现：using index

说明：MySQL并不是跳过offset行，而是取offset+N行，然后返回放弃前offset行，返回N行，那当
offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行SQL
改写

正例：先快速定位需要获取的id段，然后再关联：
SELECT t1.* FROM 表1 as t1, (select id from 表 1 where 条件 LIMIT 100000,20 ) as t2 where t1.id=t2.id

说明：

反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个index级别比较range
还低，与全表扫描是小巫见大巫

正例：如果 where a=? and b=? ，a 列的几乎接近于唯一值，那么只需要单建 idx_a 索引即可。

说明：存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如：where c>? and d=?
那么即使c的区分度更高，也必须把d放在索引的最前列，即建立组合索引idx_d_c

1） 索引宁滥勿缺。认为一个查询就需要建一个索引

2） 吝啬索引的创建。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度

3） 抵制惟一索引。认为惟一索引一律需要在应用层通过“先查后插”方式解决

说明：count(*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。

正例：可以使用如下方式来避免sum的NPE问题：SELECT IFNULL(SUM(column), 0) FROM table;

说明：NULL 与任何值的直接比较都为 NULL。

1） NULL<>NULL 的返回结果是 NULL，而不是 false。

2） NULL=NULL 的返回结果是 NULL，而不是 true。

3） NULL<>1 的返回结果是 NULL，而不是 true。

反例：在SQL语句中，如果在null前换行，影响可读性。select * from table where column1 is null and
column3 is not null; 而`ISNULL(column)`是一个整体，简洁易懂。从性能数据上分析，`ISNULL(column)`
执行效率更快一些

说明：（概念解释）学生表中的student_id是主键，那么成绩表中的student_id则为外键。如果更新学
生表中的student_id，同时触发成绩表中的student_id更新，即为级联更新。外键与级联更新适用于单机
低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库
的插入速度

说明：对多表进行查询记录、更新记录、删除记录时，如果对操作列没有限定表的别名（或表名），并且
操作列在多个表中存在时，就会抛异常

正例：select t1.name from table_first as t1 , table_second as t2 where t1.id=t2.id;

反例：在某业务中，由于多表关联查询语句没有加表的别名（或表名）的限制，正常运行两年后，最近在
某个表中增加一个同名字段，在预发布环境做数据库变更后，线上查询语句出现出1052异常：Column
'name' in field list is ambiguous

说明：1）别名可以是表的简称，或者是依照表在SQL语句中出现的顺序，以t1、t2、t3的方式命名。2）
别名前加as使别名更容易识别

正例：select t1.name from table_first as t1, table_second as t2 where t1.id=t2.id;

说明：

说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同

说明：1）增加查询分析器解析成本。2）增减字段容易与resultMap配置不一致。3）无用字段增加网络
消耗，尤其是text类型的字段

说明：参见定义 POJO 类以及数据库字段定义规定，在<resultMap>中增加映射，是必须的。
在 MyBatis Generator 生成的代码中，需要进行对应的修改。

说明：配置映射关系，使字段与 DO 类解耦，方便维护。

说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList取
start,size 的子集合

正例：
    Map<String, Object> map = new HashMap<>(16);
    map.put("start", start);
    map.put("size", size);

反例：某同学为避免写一个<resultMap>xxx</resultMap>，直接使用HashTable来接收数据库返回结
果，结果出现日常是把bigint转成Long值，而线上由于数据库版本不一样，解析成BigInteger，导致线
上问题

• 开放API层：可直接封装Service接口暴露成RPC接口；通过Web封装成http接口；网关控制层等

• 终端显示层：各个端的模板渲染并执行显示的层。当前主要是velocity渲染，JS渲染，JSP渲染，移
动端展示等

• Web层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等

• Service 层：相对具体的业务逻辑服务层

• Manager层：通用业务处理层，它有如下特征：

• DAO层：数据访问层，与底层MySQL、Oracle、Hbase、OB等进行数据交互

• 第三方服务：包括其它部门RPC服务接口，基础平台，其它公司的HTTP接口，如淘宝开放平台、支
付宝付款服务、高德地图服务等

• 外部数据接口：外部（应用）数据存储服务提供的接口，多见于数据迁移场景中

示例图

• DO（Data Object）：与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。

• DTO（Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象。

• BO（Business Object）：业务对象。由 Service 层输出的封装业务逻辑的对象。

• AO（Application Object）：应用对象。在 Web 层与 Service 层之间抽象的复用对象模型，极为贴近展示层，复用度不高。

• VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。

• Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输。

1） GroupID 格式：com.{公司/BU }.业务线.[子业务线]，最多 4 级

2） ArtifactID 格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下

3） Version：详细规定参考下方。

1） 主版本号：产品方向改变，或者大规模 API 不兼容，或者架构不兼容升级。

2） 次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的 API 不兼容修改。

3） 修订号：保持完全兼容性，修复 BUG、新增次要功能特性等。

说明：注意起始版本号必须为：1.0.0，而不是0.0.1

反例：仓库内某二方库版本号从1.0.0.0开始，一直默默“升级”成1.0.0.64，完全失去版本的语义信息

说明：不依赖SNAPSHOT版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建

说明：在升级时，进行dependency:resolve 前后信息比对，如果仲裁结果完全不一致，那么通过
dependency:tree 命令，找出差异点，进行<exclude>排除 jar 包

说明：依赖springframework-core,-context,-beans，它们都是同一个版本，可以定义一个变量来保存版
本：${spring.version}，定义依赖的时候，引用该版本

说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war，只能有一个版本号出现在最后的
lib 目录中。曾经出现过线下调试是正确的，发布到线上却出故障的先例

说明：<dependencyManagement>里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version 和 scope 都读取自父 pom。而<dependencies>所有声明在主 pom 的<dependencies>里的依赖都会自动引入，并默认被所有的子项目继承。

说明：<dependencyManagement>里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，
version 和 scope 都读取自父pom。而<dependencies>所有声明在主pom的<dependencies>里的依
赖都会自动引入，并默认被所有的子项目继承

说明：不稳定指的是提供方无法做到向下兼容，在编译阶段正常，但在运行时产生异常，因此，尽量使用
业界稳定的二方工具包

1）精简可控原则。移除一切不必要的API和依赖，只包含 Service API、必要的领域模型对象、Utils类、
常量、枚举等。如果依赖其它二方库，尽量是provided引入，让二方库使用者去依赖具体版本号；无log
具体实现，只依赖日志框架

2）稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能方便查到。除
非用户主动升级版本，否则公共二方库的行为不应该发生变化

说明：操作系统默认240秒后，才会关闭处于time_wait状态的连接，在高并发访问下，服务器端会因为
处于time_wait 的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值

正例：在linux服务器上请通过变更/etc/sysctl.conf 文件去修改该缺省值（秒）：
     net.ipv4.tcp_fin_timeout = 30

说明：主流操作系统的设计是将TCP/UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd。
主流的linux服务器默认所支持最大fd数量为1024，当并发连接数很大时很容易因为fd不足而出现“open
too many files”错误，导致新的连接无法建立。建议将linux服务器所支持的最大句柄数调高数倍（与服
务器的内存数量相关）

说明：OOM的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助