阿里的java文档的规范

我自己写一遍，加强印象。方便后期的学习。

---

编程规范

命名规约

1. 所有编程相关命名均不能以下划线或 美元符号开始，也不能以下划线或美元符号结束。
2. 所有编程相关的命名严谨使用拼音与英文混合的方式，更不允许直接使用中文的方式。
   *说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用
3. 类名使用UpperCameCase风格，必须遵从驼峰形式，但一下情形例外：（领域模型的相关命名）DO／DTO／VO／DAO等。
   *MarcoPolo／UserDO／XmlService／TcpUdpDeal／TaPromotion
4. 方法名、参数名、成员变量、局部变量都统一使用lowerCameCase风格，必须遵从驼峰形式。
   *localValue／getHttpMessage／inputUserId
5. 常量名称全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
6. 抽象类命名使用Abstact或Base开头；异常类命名使用Exception结尾，测试类命名以它要测试的类的名称开始，以Test结尾。
7. 中括号是数组类型的一部分，数组定义如下：String[]args;
8. POJO类中的任何布尔类型的变量，都不要加is，否则部分架构解析会引起序列化错误。
9. 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如有复数含义，类名可以使用复数形式。
10. 杜绝完全不规范的缩写，避免望文不知义。
11. 如果使用到了设计模式，建议在类名中体现出具体模式。
12. 接口类中的方法和属性不要加任何修饰符号，保证代码的简洁性，并加上有效的javadoc注释。尽量不要在接口里定义常量，如果一定要定义变量，肯定与接口方法相关，并且是整个应用的基础变量。
    *接口方法签名：void f(); 接口基础常量表示：String COMPANY=”alibaba”。
13. 接口和实现类的命名有两套规则：
    1 对于service 和dao类，基于soa的理念，暴露出来的服务一定是接口，内部的视线类用Imple的后缀于接口区别。
    2 如果是形容能力的接口名称，取对应的形容词做接口名。（通常是-able的形式）
14. 枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
    15.各层命名规约：
    server／dao层方法命名规约
    1获取单个对象的方法用get做前缀。
    2获取多个对象的方法用list做前缀。
    3获区统计值的方法用count做前缀。
    4插入的方法用save做前缀。
    5删除的方法用remove做前缀。
    6修改的方法用update做前缀。

常量定义

1. 不允许出现任何魔法值（即未经定义的常量）直接出线在代码中。
   
   • 反例：String key=”Id#taobao_”+tradeId; cache.put(key,value);
2. long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
3. 不要睡用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts下；系统配置相关的常量放在类：ConfigConsts下／
4. 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
   
   1. 跨应用共享常量：放置在二方库中，通常是client.jar中的const目录下。
   2. 应用内共享常量：放置在一方库的modules中的const目录下。
   3. 子工程内不共享常量：即在当前工程的const目录下。
   4. 包内共享常量：即在当前包下单独的const目录下。
   5. 类内共享常量：直接在类内部pivate static final定义。
5. 如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性，必须使用Enum类，下面正例中的数字就是延伸信息，表示星期几。
   *正例：public Enum{MONDAY(1),TUESDAY(2),WEDNESDAY(3),THURSDAY(4),FRIDAY(5),SATURDAY(6),SUNDAY(7);}

格式规约

1. 大括号的使用约定。如果是大括号内为空，则简介地写成{}即可，不需要换行；如果是非空代码块则：
   1 左大括号前不换行。
   2 左大括号后换行。
   3 右大括号前换行。
   4右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。

2. 左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。

3. if／for／while／switch／do等保留字与左右括号之间都必须要加空格
4. 任何运算符左右必须加一个空格。
5. 代码块缩进4个空格，如果使用tab锁进，请设置成1各tab为4个空格。

6. 单行字符数限制不超过120个，超出需要换行，换行时，遵循如下原则：
   1换行时相对上一行缩进4个空格。
   2运算符与下文一起换行。
   3方法调用的点符号与下文一起换行。
   4在多个参数超长，逗号后进行换行。
   5在括号前不要换行。

7. 在方法参数在定义和传入时，多个参数逗号后边必须要加空格。

8. 没有必要添加若干空格来使某一行的字符与上一行的相应字符对齐。
9. IDE的text file encoding设置为UTF-8，IDE中文件的换行符使用Unix格式，不要使用window格式。
10. 方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
    *说明：没有必要插入多行空格进行隔开。

oop规约

1. 避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编辑器解析成本，直接调用类名来访问即可。
2. 所有的覆写方法，必须加@Override注解。
3. 相同参数类型，相同业务含义，才可以使用java的可变参数，避免使用Object。
4. 对外暴露的接口签名，原则上不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。
5. 不能使用过时的类或方法
6. Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
7. 所有的相同类型的包装类对象的值的比较，全部使用equals方法比较。
8. 关于基本数据类型与包装数据类型的使用标准如下；
   1所有的pojo类属性必须使用包装数据类型。
   2RPC方法的返回值和参数必须使用包装数据类型。
   3所有的局部变量推荐使用基本数据类型。
9. 定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。
10. 序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。
11. 序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免序列化混乱，那么请修改serialVerisonUID值。
12. 构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法里。
13. 使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会抛IndexOutOfBoundsException的风险。
14. 当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。
15. 类内方法定义顺序依次是：公有方法或保护方法>私有方法>getter／setter方法。
16. setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter／setter方法中，尽量不要增加业务逻辑，增加排查问题的难度。
17. 循环体内，字符串的连接方式，使用StringBuidler的append方法进行扩展。
18. final可提高程序相应笑了，声明成final的情况。
    1不需要重新复制的变量，包括类属性、局部变量。
    2对象参数前加final，表示不允许修改引用的指向。
    3类方法确定不允许被重写。
19. 慎用Object的clone方法来拷贝对象
20. 类成员与方法访问控制从严。
    
    1 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。
    2工具类不允许有public或default构造方法。
    3类非static成员变量而且与子类共享，必须是protected。
    4类非static成员变量而且仅在本类使用，必须是private。
    5类static成员变量如果仅在本类使用，必须是private。
    6若是static成员变量，必须考虑是否为final。
    7类成员方法只供类内部调用，必须是private。
    8类成员方法只对继承类公开，那么限制为protected。
    

集合处理

1. Map/Set的key为自定义对象时，必须重写hashCode和equals。
2. ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException。
   *说明：subList返回的时ArrayList的内部类SubList，并不是ArrayList，而且ArrayList的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。
3. 在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生ConcurrentModificationException异常。

4. 使用集合转数组的方法，必须使用集合的toArray（T[]array）,传入的时类型完全一样的数组，大小就是list.size().
   *正例：List list=new ArrayList(2);
   list.add(“guan”);
   list.add(“bao”);
   String[]array=new String[list.size()];
   array=list.toArray(array);
   *说明：使用toArray带参方法，入参分配的数组空间不够大时，toArray方法内部将重新分配内存空间，并返回新数组地址，如果数组元素大于实际所需，下标为[list.size()]的数组元素将被置为null，其它数组保持原值，因此最好将方法入参数组大小定义与集合元素个数不一致。

5. 使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add／remove／clear方法会抛出UnsupportedOperationException异常。
   *说明：asList的返回对象是一个Arrays内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。
   String[]str=new String[]{“a”,”b”};
   List list=Arrays.asList(str);

6. 泛型通配符<*extends T>来接受返回的数据，此写法的泛型集合不能使用add方法。
7. 不要在foreach循环里进行元素的remove／add操作。remove元素请使用Ierator方式，如果并发操作，需要对Iterator对象加锁。
8. 在jdk7版本以上，Comparator要满足自反性、传递性、对称性、不然Arrays.sort,Collections.sort会报IllegalArgumentException异常。
   1自反性：x，y的比较结果和y,x的比较结果相反。
   2传递性：x>y,y>x,则x>z/
   3对称性：x=y,则x、z比较结果和y、z比较结果相同。
9. 集合初始化，尽量指定集合初始化值大小。

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

        Map<String,String> map=new HashMap<String, String>();    map.put("1","haha");    map.put("2","biwu");    Iterator  iterator=map.entrySet().iterator();    while (iterator.hasNext()){        Map.Entry m= (Map.Entry) iterator.next();        System.out.println("key:"+m.getKey()+" value:"+m.getValue());    }    for( Map.Entry<String,String> m :map.entrySet()){        System.out.println("key:"+m.getKey()+" value:"+m.getValue());    }

    1. 高度注意Map类集合K/V能不能存储null值的情况，如下表格：
    集合类 Key Value Super 说明 Hashtable 不允许为null 不允许为null Dictionary 线程安全 ConcurrentHashMap 不允许为null 不允许为null AbstractMap 线程局部安全 TreeMap 不允许为null 允许为null AbstarcMap 线程不安全 HashMap 允许为null 允许为null AbstarcMap 线程不安全
    1. 合理利用好集合的有序性和稳定性，避免集合的无序性和不稳定性带来的负面影响。
       *说明：稳定性指集合每次便利的元素次序是一定的。有序性的是指遍历的结果是按某种比较的规则依次排列的。如：ArrayList的order／unsort;HashMap是unorder/unsort;TreeSet是order/sort。
    2. 利用set元素唯一的特性，可以快速对另一个集合进行去重操作，避免使用contains方法遍历去重操作。

并发处理

1. 获取单例对象要线程安全。在单例对象里面做操作也要保证线程安全。
   *说明：资源驱动类、工具类、单例工厂类都需要注意。

2. 线程资源必须通过线程池提供，不允许在应用中自行显式创建线程
   *说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销,解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类现场而导致内存或者“过度切换”的问题。

3. SimpleDateFormat是线程不安全的类，一般不要定义为static变量，如果定义为static,必须加锁，或者使用DateUtils工具。

4. 高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
5. 对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，就不要用锁，否则可能会造成死锁。
   *说明：线程一需要对表A、B、C依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是A、B、C，否则可能出现死锁。
6. 并发修改同一纪录时，避免更新丢失，要吗在应用层加锁，要么在缓存加锁，要么在数据层使用乐观锁，使用version作为更新依据。
   *说明：如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3次。
7. 多线程并性处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduleExecutorService则没有这个问题。

8. 线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
   *说明：1 newFixedThreadPool和newSingleThreadExecutor：
   主要问题时推挤的请求处理队列可能会耗费非常大的内存，甚至OOM。
   2 newCachedThreadPool和newScheduledThreadPool：
   主要问题时线程最大数时Integer.MAX_Value,可能会创建数量非常多的线程，甚至OOM。

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

        public class TimerTaskThread extends Thread{        public TimerTaskThread(){            super.setName("TimerTaskThread");        }        }

1. 使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法可以执行，避免主线程无法执行至coutDown方法，知道超时才返回结果。
2. 避免Random实例被多线程使用，虽然共享该实例时线程安全的，但会因为竞争通同一个seed导致的性能下降。

3. 通过双重检查锁实现延迟初始化的优化问题隐患，推荐问题解决方案中较为简单一种，将目标属性声明为volatile型(比如修改helper的属性声明为private volatile Helper helper =null).

    class Foo{     private Helper helper=null;     public Helper getHelper(){         if(helper==null) synchronized(this){             if(helper=null){                 helper =new Helper();             }         }     }     return helper;}

4. volatile解决多线程内存不可见问题。对于一些多读，时可以解决变量同步问题，但是如果读写，同样无法解决线程安全问题。如果想取回count++数据，使用如下类实现：AtomicInteger count =new AtomicInteger（）；count.addAndGet(1);

5. 注意hashMap的扩容死链，导致cpu飙升的问题。
6. ThreadLocal无法解决共享对象的更新问题，ThreadLocal对象建议使用static修饰。这个变量时针对一个线程内所有操作共有的，所以设置为静态变量，所有此类实例共享此静态变量，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象都可以操控这个变量。

控制语句

1. 在一个swithc块内，每一个case要么通过break／return来终止，要么注释说明程序将继续执行到哪个一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码页没有.
2. 在if／else/for/while/do语句中必须使用大括号，即使只有一行代码，避免不好形式。

3. 推荐尽量少用else，if-else 的方式可以改写成两个if。
   *说明： 如果使用要if-else if-else ,不超过3层，超过请使用状态设计模式。

4. 除常用方式等外，不要在条件判断中执行复杂的语句，以提高可读性。
   *正例：

    InputStream stream= file.open(fileName,"w");if(stream!=null){    ...}

   *反例：

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

   1. 循环体中的语句要考量性能，以下操作尽量一致循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-cathc操作（这个try-catch是否可以移至循环体外）
   2. 接口入参保护，这种场景常见的时用与做批量操作的接口
   3. 方法中需要进行参数校验的场景：
      
   4. 调用频次低的方法
   5. 执行时间开销很大的方法，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
   6. 需要极高稳定性和可用性的方法.

   7. 对外提供的开发接口，不管是RPC／API／HTTP接口
      

   8. 方法中不需要参数校验的场景。
      

   9. 极有可能被循环调用的方法，不建议对参数进行校验。但在方法说明里必须注明外不参数检查。
   10. 地产的方法调用频率都比较高，一般不校验。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。
   11. 被声明为private只会被自己代码所调用的方法，入股能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。
       

其它

1. 在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
2. 避免使用Apache Beanutils 进行属性的copy。
   *说明：Apache BeanUtils性能较差，可以使用其它方案比如Spring BeanUtils，Cglib BeanCoper。
3. velocity调用POJO类的属性时，建议之际诶使用属性名取值即可，模块引擎会自动按规范的调用POJO的getXXX（），如果时boolean基本数据类型变量，会自动调用isXXX（）方法。
4. 后台输送给页面的变量必须要加$!{var} –中间的感叹好。
5. 注意Math.random()这个方法返回是double类型，注意取值范围0=

异常日志

异常

1. 不要捕获java类库中定义的继承自RuntimeException的运行时异常类。
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问题。
10. 防止NPE，是程序猿的基本修养，注意NPE产生的场景：
    
    
    1. 返回类型为包数据类型，有可能是null，返回int值时注意判空。
    2. 数据库的查询接口可能为null。
    3. 集合里的元素即是isNotEmpty，取出的数据元素也可能为null。
    4. 远程调用返回对象，一律要求进行NPE判断
    5. 对于Session中获取的数据，建议NPE检查，避免空指针。
    6. 级联调用obj.getA().getB().getC();一连串调用，易产生NPE。
       
11. 在代码中使用抛异还是返回错误码，对于公司外的http／api开发接口必须使用错误码；而应用内部推荐异常排出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess、错误码、错误简单消息。
12. 应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DaoException／ServiceException。
13. 避免出现重复的代码。

个人觉得比较重要的点

日志规范

1. 应用中的扩展日志命名方式：
   appName_logType_logName.log
   logType:推荐分类有stats／desc／monitor／visit
2. 日志声明方式：
   条件

if(logger.isDebugEnabled()){    logger.debug("Processing trade with id:"++" symbol:"+symbol );}

占位符（先占着 如果日志级别合适，在传入参数）

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

中间写的没有保存，心疼自己。不写重复的。

mysql的规范

1. 建立索引的时候，区分度最高的在最左边。
2. cout（*）会统计为null的行，而count（列名）不会统计此列卫null值的行。
3. count（distinct col）计算该列除null之外的不重复数量。
4. 使用isnull（）来判断是否为null值。注意：null与任何值的直接比较都为null。
5. 不得使用外键与级联，一切外键概念必须在应用层解决。
6. 禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
7. in 操作能避免则避免，评估in后边的集合元素数量，控制在1000个之内。
8. 在表查询中，一律不要使用* 作为查询的字段列表，需要哪些字段必须明确写明。
9. pojo类的boolean属性不能加is，而数据字段必须加is_.
10. xml配置中参数注意使用#{},#param# 不要使用${},容易出现sql注入。
11. 不允许直接拿hashMap与hashTable作为查询结果集的输出。
12. @Transactional 事务不要滥用。考虑各方面的回滚方案。
13.