阿里巴巴开发手册要点总结-个人曾经犯过的错误与可能会犯的错误

命名风格
  1 抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类 命名以它要测试的类的名称开始，以 Test 结尾
  2 POJO 类中布尔类型的变量，都不要加 is
  3 包名统一使用 单数形式，但是类名如果有复数含义，类名可以使用复数形式。 
  4 杜绝完全不规范的缩写，避免望文不知义。 
  5 任何自定义编程元素在命名时，使用尽量完整的单词 组合来表达其意 
  6 如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式
  7 接口类中的方法和属性不要加任何修饰符号，不要在接口里定义变量。
  8 枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
  9 各层命名规约：  
      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 
常量定义
  1 不允许任何魔法值（即未经定义的常量）直接出现在代码中
  2 不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。 
  3 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包 内共享常量、类内共享常量。
     1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。 
     2） 应用内共享常量：放置在一方库中，通常是 modules 中的 constant 目录下。
     3） 子工程内部共享常量：即在当前子工程的 constant 目录下
     4） 包内共享常量：即在当前包下单独的 constant 目录下
     5） 类内共享常量：直接在类内部 private static final 定义
代码格式
  1 if/for/while/switch/do 等保留字与括号之间都必须加空格。
  2 任何二目、三目运算符的左右两边都需要加一个空格
  3 注释的双斜线与注释内容之间有且仅有一个空格
  4 单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则
      1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。 
      2） 运算符与下文一起换行
      3） 方法调用的点符号与下文一起换行。
      4） 方法调用时，多个参数，需要换行时，在逗号后进行
      5） 在括号前不要换行，见反例。
  5 IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式， 不要使用 Windows 格式
OOP 规约 
   1 外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生 影响。接口过时必须加@Deprecated 注解
   2 不能使用过时的类或方法
   3 关于基本数据类型与包装数据类型的使用标准如下：  
      1）所有的 POJO 类属性必须使用包装数据类型。  
      2）RPC 方法的返回值和参数必须使用包装数据类型。 
      3）所有的局部变量使用基本数据类型
   4 getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。 
   5 任何类、方法、参数、变量，严控访问范围
集合处理
   1 ArrayList的subList结果不可强转成ArrayList
   2 使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历.。如果是 JDK8，使用 Map.foreach 方法。 
   3 高度注意 Map 类集合 K/V 能不能存储 null 值的情况
并发处理
   1 创建线程或线程池时请指定有意义的线程名称，方便出错时回溯
   2 线程资源必须通过线程池提供，不允许在应用中自行显式创建线程
   3 线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式

控制语句
  1 不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性、
  2 循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch 
  3 下列情形，需要进行参数校验：
      1） 调用频次低的方法。  
      2） 执行时间开销很大的方法.  
      3） 需要极高稳定性和可用性的方法。  
      4） 对外提供的开放接口，不管是 RPC/API/HTTP 接口。  
      5） 敏感权限入口。
注释规约
  1 类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用 // xxx 方式
  2 所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、 异常说明外，还必须指出该方法做什么事情，实现什么功能。
  3 所有的类都必须添加创建者和创建日期
  4 方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释 使用/* */注释，注意与代码对齐
  5 所有的枚举类型字段必须要有注释，说明每个数据项的用途。
  6 代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑 等的修改
  7 谨慎注释掉代码。在上方详细说明，而不是简单的注释掉。如果无用，则删除
  8 对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三 个斜杠(///)来说明注释掉代码的理由
其他
  1 在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。