阿里巴巴java开发手册容易忽视的几个知识点

一、编程规约

（一）命名规范：

1、常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长，正确的如：MAX_STOCK_COUNT；
2、抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;
3、中括号是数组类型的一部分，数组定义如下:String[] args;
反例:使用String args[]的方式来定义。
3、POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。
反例:定义为基本数据类型Boolean isDeleted;的属性，它的方法也是isDeleted()，RPC框架在反向解析的时候，“以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异
常。
4、如果使用到了设计模式，建议在类名中体现出具体模式
说明:将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。 
正例:public class OrderFactory;
public class LoginProxy; 
public class ResourceObserver;
5、接口类中的方法和属性不要加任何修饰符号(public 也不要加)，保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
正例:接口方法签名:void f();
接口基础常量表示:String COMPANY = "alibaba";
6、枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。 
说明:枚举其实就是特殊的常量类，且构造方法被默认强制是私有。 
正例:枚举名字:DealStatusEnum，成员名称:SUCCESS / UNKOWN_REASON。

（二）OOP规约

1、相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。 
说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程) 
正例:public User getUsers(String type, Integer... ids) {...}
2、关于基本数据类型与包装数据类型的使用标准如下:
1) 【强制】所有的POJO类属性必须使用包装数据类型。
2) 【强制】RPC方法的返回值和参数必须使用包装数据类型。
3) 【推荐】所有的局部变量使用基本数据类型。
3、构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中；
4、POJO 类必须写 toString 方法。
使用 IDE 的中工具:source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。 说明:在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。
5、final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字: 
1) 不允许被继承的类，如:String 类。
2) 不允许修改引用的域对象，如:POJO 类的域变量。
3) 不允许被重写的方法，如:POJO 类的 setter 方法。
4) 不允许运行过程中重新赋值的局部变量。
5) 避免上下文重复使用一个变量，使用 final 描述可以强制重新定义一个变量，方便更好 地进行重构。

（三）集合处理

1、关于 hashCode 和 equals 的处理，遵循如下规则:
1) 只要重写equals，就必须重写hashCode。
2) 因为Set存储的是不重复的对象，依据hashCode和equals进行判断，所以Set存储的对象必须重写这两个方法。
3) 如果自定义对象做为Map的键，那么必须重写hashCode和equals。
说明:String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象 作为 key 来使用。
2、使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全 一样的数组，大小就是 list.size()。
说明:使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配内存空间，并返回新数组地址;如果数组元素大于实际所需，下标为[ list.size() ]的数组元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素 个数一致。
正例:
List<String> list = new ArrayList<String>(2); list.add("guan");
list.add("bao");
String[] array = new String[list.size()]; array = list.toArray(array);
反例:直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它 类型数组将出现 ClassCastException 错误。

（四）并发处理

1、获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
说明:资源驱动类、工具类、单例工厂类都需要注意。
2、线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。 说明:使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资 源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者 “过度切换”的问题。
3、线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。 说明:Executors返回的线程池对象的弊端如下:
1)FixedThreadPool 和 SingleThreadPool:
允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。
2)CachedThreadPool 和 ScheduledThreadPool:
允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。
4、并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。 
说明:如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于 3 次。
5、ThreadLocal 无法解决共享对象的更新问题，ThreadLocal 对象建议使用 static
修饰。这个变量是针对一个线程内所有操作共有的，所以设置为静态变量，所有此类实例共享此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

二、异常日志

1、捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。

三、数据库

（一）建表规约

1、varchar 是可变长字符串，不预先分配存储空间，长度不要超过5000，如果存储长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。
2、表的命名最好是加上“业务名称_表的作用”。 正例:tiger_task / tiger_reader / mpp_config
3、字段允许适当冗余，以高查询性能，但必须考虑数据一致。冗余字段应遵循:
1)不是频繁修改的字段。
2)不是 varchar 超长字段，更不能是 text 字段。
4、单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。 说明:如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

（二）索引规约

1、超过三个表禁止 join。需要 join、 的字段，数据类型必须绝对一致;多表关联查询 时，保证被关联的字段需要有索引。
2、页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
说明:索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。
3、如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。 
正例:where a=? and b=? order by c; 索引:a_b_c 
反例:索引中有范围查找，那么索引有序性无法利用，如:WHERE a>10 ORDER BY b; 索引 a_b 无法排序。
4、利用覆盖索引来进行查询操作，避免回表。
说明:如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗?目录浏览一下就好，这个目录就是起到覆盖索引的作用。 正例:能够建立索引的种类:主键索引、唯一索引、普通索引，而覆盖索引是一种查询的一种 效果，用explain的结果，extra列会出现:using index。
5、建组合索引的时候，区分度最高的在最左边。
正例:如果 where a=? and b=? ，a 列的几乎接近于唯一值，那么只需要单建 idx_a 索引即可。
说明:存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如:where a>? and b=? 那么即使 a 的区分度更高，也必须把 b 放在索引的最前列。

（三）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;oracle使用nvl函数
4、在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。节省了查询次数，提高了性能。
5、不得使用外键与级联，一切外键概念必须在应用层解决。 
说明:(概念解释)学生表中的 student_id 是主键，那么成绩表中的 student_id 则为外键。 如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，则为级联更新。 外键与级联更新适用于单机低并发，不适合分布式、高并发集群;级联更新是强阻塞，存在数 据库更新风暴的风险;外键影响数据库的插入速度。
6、数据订正时，删除和修改记录时，要先 select然后加索检查状态，避免出现误删除或修改，确认无误才能执行更新语句。
7、in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在 1000 个之内。超过1000个则建议使用分页；
8、TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE 无事务（不能回滚）且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。

（四）ORM映射

1、POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行 字段与属性之间的映射。
说明:参见定义 POJO 类以及数据库字段定义规定，在<resultMap>中增加映射，是必须的。 在 MyBatis Generator 生成的代码中，需要进行对应的修改。
2、sql.xml 配置参数使用:#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。
3、不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
说明:resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。
4、不要写一个大而全的数据更新接口，传入为 POJO 类，不管是不是自己的目标更新字
段，都进行 update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行 SQL 时，不要更新无改动的字段，一是易出错;二是效率低;三是增加 binlog 存储。

四、工程结构

1、DO(Data Object，也叫PO):与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
  DTO(Data Transfer Object):数据传输对象，Service 和 Manager 向外传输的对象。
  BO(Business Object):业务对象。可以由 Service 层输出的封装业务逻辑的对象。
  Query:数据查询对象，各层接收上层的查询请求。注:超过 2 个参数的查询封装，禁止 使用 Map 类来传输。
  VO(View Object):显示层对象，通常是 Web 向模板渲染引擎层传输的对象。