阿里开发规范

 

一、编程规约

(一) 命名规约 

POJO，设计只有POJO才需要序列化？

8. 【强制】POJO 类中的任何布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错

误。

反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是 isSuccess()，RPC

框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出

异常。

 

10.【强制】杜绝完全不规范的缩写，避免望文不知义。

反例：<某业务代码>AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成

condi，此类随意缩写严重降低了代码的可阅读性

 

11.【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。

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

正例：public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

 

12.【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁

性，并加上有效的 javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是

与接口方法相关，并且是整个应用的基础常量。

正例：接口方法签名：void f();

 

 

13.接口和实现类的命名有两套规则：

1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部

的实现类用 Impl 的后缀与接口区别。

正例：CacheServiceImpl 实现 CacheService 接口。

阿里巴巴 JAVA 开发手册

3 / 32

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

式）。

正例：AbstractTranslator 实现 Translatable。

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

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

正例：枚举名字：DealStatusEnum；成员名称：SUCCESS / UNKOWN_REASON。

 

 

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

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

1） 获取单个对象的方法用 get 做前缀。

2） 获取多个对象的方法用 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。

 

(二) 常量定义 

2. 【强制】long 或者 Long 初始赋值时，必须使用大写的 L，不能是小写的 l，小写容易跟数字 1

混淆，造成误解。

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

 

 

3. 【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存

相关的常量放在类：CacheConsts 下；系统配置相关的常量放在类：ConfigConsts 下

 

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

内共享常量、类内共享常量。

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

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

反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示

“是”的变量：

类 A 中：public static final String YES = "yes";

类 B 中：public static final String YES = "y";

A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致产生线上问题。

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

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

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

 

5. 【推荐】如果变量值还带有名称之外的延伸属性，必须使用 Enum 类

如：MONDAY(1),  SUNDAY(7);

 

(三) 格式规约 

 

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

4. 【强制】任何运算符左右必须加一个空格。

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

 

 

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

1） 换行时相对上一行缩进 4 个空格。

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

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

4） 在多个参数超长，逗号后进行换行。 //参照ThreadPoolExecutor

5） 在括号前不要换行，见反例。append("huang"); 

 

 

9. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不

要使用 windows 格式。

 

10.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之

间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

 

 

(四) OOP 规约 

 

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

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

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

 

4. 【强制】对外暴露的接口签名，原则上不允许修改方法签名，避免对接口调用方产生影响。接

口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。

 

 

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

说明：java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该

使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，那

么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。

 

7. 【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

说明：对于 Integer var=?在-128 至 127 之间的赋值，Integer 对象是在 IntegerCache.cache

产生，会复用已有对象，这个区间内的 Integer 值可以直接使用==进行判断，但是这个区间之

外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，

 

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

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

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

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

说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何

NPE（NullPointerException） 问题，或者入库检查，都由使用者来保证。

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

反例：某业务的交易报表上显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的

RPC 服务，调用不成功时，返回的是默认值，页面显示：0%，这是不合理的，应该显示成中划

线-。所以包装数据类型的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。

 

9. 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。

反例：某业务的 DO 的 gmtCreate 默认值为 new Date();但是这个属性在数据提取时并没有置

入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

10.【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果

完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

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

 

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

 

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

 

13.【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内

容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

说明：

String str = "a,b,c,,"; String[] ary = str.split(",");

//预期大于 3，结果是 3

System.out.println(ary.length); 

 

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

法。

说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类

关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一

个黑盒实现；因为方法信息价值较低，所有 Service 和 DAO 的 getter/setter 方法放在类体最

后。

16.【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在

getter/setter 方法中，尽量不要增加业务逻辑，增加排查问题难度。

反例：

public Integer getData(){ //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 可提高程序响应效率，声明成 final 的情况：

1） 不需要重新赋值的变量，包括类属性、局部变量。

2） 对象参数前加 final，表示不允许修改引用的指向。

3） 类方法确定不允许被重写。

 

 

20.【推荐】类成员与方法访问控制从严：

1） 如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private。

2） 工具类不允许有 public 或 default 构造方法。

3） 类非 static 成员变量并且与子类共享，必须是 protected。

8） 类成员方法只对继承类公开，那么限制为 protected。

说明：任何类、方法、参数、变量，严控访问范围。过宽泛的访问范围，不利于模块解耦。思

考：如果是一个 private 的方法，想删除就删除，可是一个 public 的 Service 方法，或者一

个 public 的成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视

线内，变量作用域太大，如果无限制的到处跑，那么你会担心的。

 

(五) 集合处理 

 

6. 【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方法。

说明：苹果装箱后返回一个<? extends Fruits>对象，此对象就不能往里加任何水果，包括苹

果。

 

9. 【推荐】集合初始化时，尽量指定集合初始值大小。

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

10.【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。

说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key

所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更

高。如果是 JDK8，使用 Map.foreach 方法

 

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

集合类 Key Value Super 说明

Hashtable 不允许为 null 不允许为 null Dictionary 线程安全

ConcurrentHashMap 不允许为 null 不允许为 null AbstractMap 线程局部安全

TreeMap 不允许为 null 允许为 null AbstractMap 线程不安全

HashMap 允许为 null 允许为 null AbstractMap 线程不安全

 

12.【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不

稳定性(unorder)带来的负面影响。

阿里巴巴 JAVA 开发手册

12 / 32

说明：稳定性指集合每次遍历的元素次序是一定的。有序性是指遍历的结果是按某种比较规则

依次排列的

 

 

(六) 并发处理 

 

1. 【强制】获取单例对象要线程安全。在单例对象里面做操作也要保证线程安全。

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

 

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

说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资

源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者

“过度切换”的问题。

 

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

成死锁。

说明：线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序

也必须是 A、B、C，否则可能出现死锁。

6. 【强制】并发修改同一记录时，避免更新丢失，要么在应用层加锁，要么在缓存加锁，要么在

数据库层使用乐观锁，使用 version 作为更新依据。

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

数不得小于 3 次。

 

7. 【强制】多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获

抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。

8. 【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样

的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

说明：Executors 各个方法的弊端：

1）newFixedThreadPool 和 newSingleThreadExecutor:

主要问题是堆积的请求处理队列可能会耗费非常大的内存，甚至 OOM。

2）newCachedThreadPool 和 newScheduledThreadPool:

主要问题是线程数最大数是 Integer.MAX_VALUE，可能会创建数量非常多的线程，甚至 OOM。

 

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

正例：

public class TimerTaskThread extends Thread {

public TimerTaskThread(){

super.setName("TimerTaskThread"); …

}

10.【推荐】使用 CountDownLatch 进行异步转同步操作，每个线程退出前必须调用 countDown 方

法，线程执行代码注意 catch 异常，确保 countDown 方法可以执行，避免主线程无法执行至

countDown 方法，直到超时才返回结果。

 

12.【推荐】通过双重检查锁（double-checked locking）（在并发场景）实现延迟初始化的优化

问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration),推荐问题解决方

案中较为简单一种（适用于 jdk5 及以上版本），将目标属性声明为 volatile 型（比如反例

中修改 helper 的属性声明为 private volatile Helper helper = null;）；

反例：

class Foo {

private Helper helper = null; //应该为：private volatile Helper helper = null;

public Helper getHelper() { 

if (helper == null) synchronized(this) {

if (helper == null)

helper = new Helper();

}

return helper; }

// other functions and members...

} 

参考：http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html

 

(七) 控制语句

1. 【强制】在一个 switch 块内，每个 case 要么通过 break/return 来终止，要么注释说明程序

将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且放在

最后，即使它什么代码也没有。

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

if(condition){

 …

 return obj;

}

// 接着写 else 的业务逻辑代码;

说明：如果使用要 if-else if-else 方式表达逻辑，【强制】请勿超过 3 层，超过请使用状态

设计模式。

 

4. 【推荐】除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行复杂的语句，以提高

可读性。

正例：

//伪代码如下

InputStream stream = file.open(fileName, "w"); 

阿里巴巴 JAVA 开发手册

15 / 32

if (stream != null) {

 …

}

反例：

if (file.open(fileName, "w") != null)) {

…

} 

 

 

7. 【参考】方法中需要进行参数校验的场景：

1） 调用频次低的方法。

2） 执行时间开销很大的方法，参数校验时间几乎可以忽略不计，但如果因为参数错误导致

中间执行回退，或者错误，那得不偿失。

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

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

8. 【参考】方法中不需要参数校验的场景：

1） 极有可能被循环调用的方法，不建议对参数进行校验。但在方法说明里必须注明外部参

数检查。

2） 底层的方法调用频度都比较高，一般不校验。毕竟是像纯净水过滤的最后一道，参数错

误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台

服务器中，所以 DAO 的参数校验，可以省略。

3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参

数已经做过检查或者肯定不会有问题，此时可以不校验参数。

 

 

(八) 注释规约 

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

用/* */注释，注意与代码对齐。

 

11.【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，

经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）

2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]

 

 

(九) 其它

1. 【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

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

2. 【强制】避免用 Apache Beanutils 进行属性的 copy。

说明：Apache BeanUtils 性能较差，可以使用其他方案比如 Spring BeanUtils, Cglib

BeanCopier。

 

8. 【推荐】任何数据结构的使用都应限制大小。

说明：这点很难完全做到，但很多次的故障都是因为数据结构自增长，结果造成内存被吃光。

 

 

二、异常日志

(一) 异常处理

1. 【强制】不要捕获 Java 类库中定义的继承自 RuntimeException 的运行时异常类，如：

IndexOutOfBoundsException / NullPointerException，这类异常由程序员预检查来规避，保

证程序健壮性。

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

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

2. 【强制】异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。

 

3. 【强制】对大段代码进行 try-catch，这是不负责任的表现。catch 时请分清稳定代码和非稳

定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分

异常类型，再做对应的异常处理。

 

4. 【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请

将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的

内容。

5. 【强制】有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回

滚事务。

6. 【强制】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。

 

7. 【强制】不能在 finally 块中使用 return，finally 块中的 return 返回后方法结束执行，不

会再执行 try 块中的 return 语句。

 

8. 【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。

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

9. 【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分

说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。

说明：本规约明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用

者来说，也并非高枕无忧，必须考虑到远程调用失败，运行时异常等场景返回 null 的情况。

 

10.【推荐】防止 NPE，是程序员的基本修养，注意 NPE 产生的场景：

1） 返回类型为包装数据类型，有可能是 null，返回 int 值时注意判空。

 反例：public int f(){ return Integer 对象}，如果为 null，自动解箱抛 NPE。

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

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

4） 远程调用返回对象，一律要求进行 NPE 判断。

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

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

 

11.【推荐】在代码中使用“抛异常”还是“返回错误码”，对于公司外的 http/api 开放接口必

须使用“错误码”；而应用内部推荐异常抛出；跨应用间 RPC 调用优先考虑使用 Result 方式，

封装 isSuccess、“错误码”、“错误简短信息”。

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

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

2）如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用

端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输

的性能损耗也是问题。

12.【推荐】定义时区分 unchecked / checked 异常，避免直接使用 RuntimeException 抛出，更

不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义过

的自定义异常，如：DaoException / ServiceException 等。

 

 

 

(二) 日志规约

1. 【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架

SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Abc.class); 

 

 

 

3. 【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：

appName_logType_logName.log。logType:日志类型，推荐分类有 stats/desc/monitor/visit

等；logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么

类型，什么目的，也有利于归类查找。

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

mppserver_monitor_timeZoneConvert.log

说明：推荐对日志进行分类，错误日志和业务日志尽量分开存放，便于开发人员查看，也便于

通过日志对系统进行及时监控。

 

 

4. 【强制】对 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: {} and symbol : {} ", id, symbol); 

 

 

5. 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。

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

 

 

6. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么往上

抛。

正例：logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e);

 

8. 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适

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

非必要，请不要在此场景打出 error 级别，避免频繁报警。

9. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使

用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘

撑爆，并记得及时删除这些观察日志。

说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。纪录日志时请

思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

 

 

三、MYSQL 规约

(一) 建表规约

1. 【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint

（ 1 表示是，0 表示否），此规则同样适用于 odps 建表。

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

 

 

4. 【强制】禁用保留字，如 desc、range、match、delayed 等，参考官方保留字。

 

13.【推荐】字段允许适当冗余，以提高性能，但是必须考虑数据同步的情况。冗余字段应遵循：

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

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

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

14.【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。

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

反例：某业务三年总数据量才 2 万行，却分成 1024 张表，问：你为什么这么设计？答：分 1024

张表，不是标配吗？

 

 

(二) 索引规约

1. 【强制】业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。

说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明

显的；另外，即使在应用层做了非常完善的校验和控制，只要没有唯一索引，根据墨菲定律，

必然有脏数据产生。

2. 【强制】超过三个表禁止 join。需要 join 的字段，数据类型保持绝对一致；多表关联查询时，

保证被关联的字段需要有索引。

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

 

3. 【强制】在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据

实际文本区分度决定索引长度。

说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分

度会高达 90%以上，可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度来

确定。

 

4. 【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。

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

引

 

5. 【推荐】如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索

引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。

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

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

无法排序。

 

7. 【推荐】利用延迟关联或者子查询优化超多分页场景。

说明：MySQL 并不是跳过 offset 行，而是取 offset+N 行，然后返回放弃前 offset 行，返回 N

行，那当 offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特

定阈值的页数进行 SQL 改写。

正例：先快速定位需要获取的 id 段，然后再关联：

 SELECT a.* FROM 表 1 a, (select id from 表 1 where 条件 LIMIT 100000,20 ) b where a.id=b.id

 

 8. 【推荐】 SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是 consts

最好。

说明：

1）consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。

2）ref 指的是使用普通的索引。（normal index）

3）range 对索引进范围检索。

反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别

比较 range 还低，与全表扫描是小巫见大巫。

 

9. 【推荐】建组合索引的时候，区分度最高的在最左边。

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

阿里巴巴 JAVA 开发手册

24 / 32

说明：存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如：where a>?

and b=? 那么即使 a 的区分度更高，也必须把 b 放在索引的最前列。

 

 

(三) SQL 规约

1. 【强制】不要使用 count(列名)或 count(常量)来替代 count(*)，count(*)就是 SQL92 定义的

标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。

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

 

(四) ORM 规约

1. 【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。

说明：1）增加查询分析器解析成本。2）增减字段容易与 resultMap 配置不一致。

2. 【强制】POJO 类的 boolean 属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中

进行字段与属性之间的映射。

说明：参见定义 POJO 类以及数据库字段定义规定，在 sql.xml 增加映射，是必须的

 

5. 【强制】iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使

用。

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

取 start,size 的子集合，线上因为这个原因曾经出现过 OOM。

正例：在 sqlmap.xml 中引入 #start#, #size#

Map<String, Object> map = new HashMap<String, Object>();

map.put("start", start);

map.put("size", size); 

 

 

 

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

制层等。

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

染，移动端展示层等。

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

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

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

1） 对第三方平台封装的层，预处理返回结果及转化异常信息；

2） 对 Service 层通用能力的下沉，如缓存方案、中间件通用处理；

3） 与 DAO 层交互，对 DAO 的业务通用能力的封装。

 DAO 层：数据访问层，与底层 Mysql、Oracle、Hbase、OB 进行数据交互。

 外部接口或第三方平台：包括其它部门 RPC 开放接口，基础平台，其它公司的 HTTP 接口。

2. 【参考】（分层异常处理规约）在 DAO 层，产生的异常类型有很多，无法用细粒度异常进行

catch，使用 catch(Exception e)方式，并 throw new DaoException(e)，不需要打印日志，

因为日志在 Manager/Service 层一定需要捕获并打到日志文件中去，如果同台服务器再打日志，

浪费性能和存储。在 Service 层出现异常时，必须记录日志信息到磁盘，尽可能带上参数信息，

相当于保护案发现场。如果 Manager 层与 Service 同机部署，日志方式与 DAO 层处理一致，如

果是单独部署，则采用与 Service 一致的处理方式。Web 层绝不应该继续往上抛异常，因为已

经处于顶层，无继续处理异常的方式，如果意识到这个异常将导致页面无法正常渲染，那么就

应该直接跳转到友好错误页面，尽量加上友好的错误提示信息。开放接口层要将异常处理成错

误码和错误信息方式返回。

3. 【参考】分层领域模型规约：

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

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

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

 QUERY：数据查询对象，各层接收上层的查询请求。注：超过 2 个参数的查询封装，禁止使

用 Map 类来传输。

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

 

 

 

 

 

二方库规约

1. 【强制】定义 GAV 遵从以下规则：

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

说明：{公司/BU} 例如：alibaba/taobao/tmall/aliexpress 等 BU 一级；子业务线可选。

正例：com.taobao.tddl 或 com.alibaba.sourcing.multilang

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

正例：tc-client / uic-api / tair-tool

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

2. 【强制】二方库版本号命名方式：主版本号.次版本号.修订号

1） 主版本号：当做了不兼容的 API 修改，或者增加了能改变产品方向的新功能。

2） 次版本号：当做了向下兼容的功能性新增（新增类、接口等）。

3） 修订号：修复 bug，没有修改方法签名的功能加强，保持 API 兼容性。

8. 【推荐】工具类二方库已经提供的，尽量不要在本应用中编程实现。

 json 操作： fastjson

 md5 操作：commons-codec

 工具集合：Guava 包

 数组操作：ArrayUtils（org.apache.commons.lang3.ArrayUtils）

 集合操作：CollectionUtils(org.apache.commons.collections4.CollectionUtils)

 除上面以外还有 NumberUtils、DateFormatUtils、DateUtils 等优先使用

org.apache.commons.lang3 这个包下的，不要使用 org.apache.commons.lang 包下面

的。原因是 commons.lang 这个包是从 JDK1.2 开始支持的所以很多 1.5/1.6 的特性是不

支持的，例如：泛型。

 

 

服务器规约

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 的发生是有概率的，甚至有规律地相隔数月才出现一例，出现时的现场信息对查错

非常有价值。

4. 【参考】服务器内部重定向必须使用 forward；外部重定向地址必须使用 URL Broker 生成，

否则因线上采用 HTTPS 协议而导致浏览器提示“不安全”。此外，还会带来 URL 维护不一致的

问题。

 

 

表单、AJAX 提交必须执行 CSRF 安全过滤。

URL 外部重定向传入的目标地址必须执行白名单过滤。

 

 

用户请求传入的任何参数必须做有效性验证。

说明：忽略参数校验可能导致：

 page size 过大导致内存溢出

 恶意 order by 导致数据库慢查询

 正则输入源串拒绝服务 ReDOS

 任意重定向

 SQL 注入

 Shell 注入

 反序列化注入