前言

本文参考Google Java编程规范和阿里巴巴Java规范，Android编码规范部分参考Android开发者指南

代码规范的好处

1. 提高开发团队代码一致性和可读性，便于其他开发者理解，沟通和维护
2. 降低怪异bug出现的几率
3. 降低CodeReview时间成本
4. 降低后期维护，升级成本
5. 提高源代码的可重用性
6. 提高开发效率和开发质量

软件项目设计需求

1. 面向接口设计
2. 面向组件
3. 面向服务设计
4. 面向修改（易扩展，易替换，易删除，易复用）
5. 面向切面
6. 面向动态配置
7. 面向事件编程
8. 其他设计需求，总结起来都是根据需求，灵活运用设计原则和设计模式

实现以上设计需求，请参考下文：
  一、使用面向对象设计原则
  二、使用面向对象设计模式

一、使用面向对象设计原则

1. 单一责任原则
2. 开闭原则
3. 依赖倒置原则
4. 里氏替换原则
5. 组合复用原则
6. 接口隔离原则
7. 迪米特法则

二、使用面向对象设计模式

参考：

1. 面向对象设计模式
2. 《设计模式之禅》
3. 《Head First 设计模式》

三、Java编码规范

3.1 命名规范

1.【强制】所有编程相关的命名禁止使用_和$等特殊字符开头或结尾。

 反例：\_name  __name  $Object  name_  name$   Object$
 正例：name

2.【强制】命名应该使用英文，禁止中文，禁止拼音+英文，避免拼音。

反例：DaZhePromotion [打折] 
     getPingfenByName() [评分] 
     int 变量 = 3
正例：discount  getScoreByName()  youku  hangzhou  alibaba 等通用名称可视为英文。

3.【强制】类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外:（领域模型的相关命名）DO / DTO / VO / DAO等。

反例：macroPolo  UserDo  XMLService  TCPUDPDeal  TAPromotion
正例：MarcoPolo  UserDO  XmlService  TcpUdpDeal  TaPromotion

4.【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。

反例：LocalValue  GetHttpMessage()  InputUserId
正例：localValue  getHttpMessage()  inputUserId

5.【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

反例：public static final int max_stock_count = 10；
正例：public static final int MAX_STOCK_COUNT = 10；

6.【强制】必要的模块区分，类型区分，强制使用前缀prefix和后缀suffix

1、抽象类命名使用 Abstract 或 abs 或 Base开头；
2、异常类命名使用 Exception 结尾；
3、测试类命名以它要测试的类的名称开始，以Test结尾
4、如果使用到了设计模式，建议在类名中体现出具体模式
正例：
public class BaseActivity；
public class UserLoginTest；
public class OrderFactory;   
public class LoginProxy;
public class ResourceObserver

7.【强制】中括号 [] 是数组的一部分，必须严格定义

反例：String arry[];
正例：String[] arry;

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

反例：boolean isSuccess
     它的get方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的
     属性名称是success，导致属性获取不到，进而抛出异常
正例：boolean success

9.【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

反例：com.alibaba.baselibrary.util
     其中baselibrary是由两个语义的单词组合而成。
正例：应用工具类包名为com.alibaba.mpp.util 
     类名为MessageUtils（此规则参考spring 的框架结构）

10.【强制】杜绝完全不规范的缩写，避免望文不知义，如果缩写意义不明确，就写完整单词。

11.【强制】接口和实现类的命名有两套规则
1. 对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，
内部的实现类用Impl的后缀与接口区别
正例：CacheServiceImpl实现CacheService接口

2. 如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）
    正例：AbstractTranslator实现 Translatable

12.【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

反例：接口方法定义：public abstract void f();
    说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。
正例：接口方法签名：void f();
    接口基础常量表示：String COMPANY = "alibaba";

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

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

14.【推荐】特殊业务方法命名规则根据业务定义如下。

Service/DAO层方法命名规约
1） 获取单个对象的方法用 get 做前缀。
2） 获取多个对象的方法用 list 做前缀。
3） 获取统计值的方法用 count 做前缀。
4） 插入的方法用 save（推荐）或insert 做前缀。
5） 删除的方法用 remove（推荐）或delete 做前缀。
6） 修改的方法用 update 做前缀。
7） 查询使用 query 做前缀
8） 添加使用 add 做前缀

领域模型命名规约
1） 数据对象：xxxDO，xxx即为数据表名。
2） 数据传输对象：xxxDTO，xxx为业务领域相关的名称。
3） 展示对象：xxxVO，xxx一般为网页名称。
4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。

15.【强制】绝对不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。

反例：
    public int getIndexDistance(){
       int currentIndex = 10;
       return 1 + currentIndex;
    }
该例中“1”属于魔法数字，根本不知道是什么意思。其他开发者很难理解程序逻辑。

正例：
    public int getIndexDistance(){
       int indexOffset = -1;
       int currentIndex = 10;
       return startIndex + currentIndex;
    }

16.【强制】long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1 混淆，造成误解。

反例：Long a = 2l; 写的是数字的21，还是Long型的2?
正例：Long a = 2L; 

17.【强制】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。大而全的常量类，不利于理解，也不利于维护

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

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

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定义。

19.【强制】关键字，大括号，小括号，参数等语法格式约定

1)  如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
2） 左大括号前不换行。
3） 左大括号后换行。
4） 右大括号前换行。
5） 右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。
6） 左括号和后一个字符之间不出现空格；同样，右括号和前一个字符  之间也不出现空格
7)  if/for/while/switch/do等保留字与左右括号之间都必须加空格
8)  任何运算符左右必须加一个空格
9)  代码块缩进4个空格，如果使用tab缩进，请设置成1个tab为4个空格
正例：
    public int quotTest(int a, int b){
       if (a == 1) {
            b = a + b;
       } else{
           b = a * 2 + b;
       }
       return b;
    }

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

1） 换行时相对上一行缩进4个空格。
2） 运算符与下文一起换行。
3） 方法调用的点符号与下文一起换行。
4） 在多个参数超长，逗号后进行换行。
5） 在括号前不要换行

21.【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。

反例：method(a,b,c)
正例：method(a, b, c)

22.【强制】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。

正例：
int a = 3; 
long b = 4L; 
float c = 5F; 
StringBuffer sb = new StringBuffer(); 

反例：
int            a = 3; 
long           b = 4L; 
float          c = 5F; 
StringBuffer  sb = new StringBuffer(); 

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

24.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行，没有必要插入多行空格进行隔开

25.【强制】OOP原则

1、避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，
   直接用类名来访问即可
2、所有的覆写方法，必须加@Override注解
    反例：getObject()与get0bject()的问题。一个是字母的O，一个是数字的0，加@Override可以
         准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错
3、相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object，但除非必要，还是尽量
   少用可变参数，不好理解。
4、对外暴露的接口签名，原则上不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加
   @Deprecated注解，并清晰地说明采用的新接口或者新服务是什么
5、不能使用过时的类或方法
6、Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
    正例： "test".equals(object);
    反例： object.equals("test");
    说明：推荐使用java.util.Objects#equals （JDK7引入的工具类）
7、所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。
    说明：对于Integer var=?在-128至127之间的赋值，Integer对象是在IntegerCache.cache 
产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数
据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断

26.【强制】基本数据类型与包装数据类型的使用标准

1） 所有的POJO类属性必须使用包装数据类型。
2） RPC方法的返回值和参数必须使用包装数据类型。
3） 所有的局部变量推荐使用基本数据类型。
    说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，
         或者入库检查，都由使用者来保证。
    正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险。  
    反例：某业务的交易报表上显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的 RPC服务，
         调用不成功时，返回的是默认值，页面显示：0%，这是不合理的，应该显示成中划线-。所以
         包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出

27.【推荐】定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。（除非业务明确要求需要一个默认值）

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

28.【推荐】序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。

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

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

30.【强制】POJO类必须写toString方法。使用工具类source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString

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

31.【强制】使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险

32.【强制】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读

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

34.【推荐】setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在 getter/setter方法中，尽量不要增加业务逻辑，增加排查问题难度

 【反例】
  public IntegergetData(){      
      if(true)  {  
          return data +100; 
      } else{ 
          return data- 100;
      } 
  } 

35.【强制】循环体内，字符串的联接方式，使用StringBuilder的append方法进行扩展

【反例】
  String str ="start";      
  for(int i=0; i<100;i++){          
      str = str +"hello";     
  }

36.【强制】慎用Object的clone方法来拷贝对象。

  说明：对象的clone方法默认是浅拷贝，若想实现深拷贝需要重写clone方法实现属性对象的拷贝。

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

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

38.【强制】集合约定

1、Map/Set的key为自定义对象时，必须重写hashCode和equals
 正例：
    String重写了hashCode和equals方法，所以我们可以非常愉快地使用String对象作为key来使用
2、ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException 异常
  java.util.RandomAccessSubList cannot be cast to java.util.ArrayList; 
  说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是 
  ArrayList 的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。
3、在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均
   产生ConcurrentModificationException 异常
4、使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一样的数组，
   大小就是list.size()
反例：
    直接使用toArray无参方法存在问题，此方法返回值只能是Object[]类，若强转其它类型数组将
    出现ClassCastException错误。
正例：
    List<String> list = new ArrayList<String>(2);     
    list.add("guan");     
    list.add("bao");      
    String[] array = new String[list.size()];      
    array =list.toArray(array); 

说明：使用toArray带参方法，入参分配的数组空间不够大时，toArray方法内部将重新分配内存空间，
并返回新数组地址；如果数组元素大于实际所需，下标为[ list.size() ]的数组元素将被置为null，
其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致

39.【强制】在JDK7版本以上，Comparator要满足自反性，传递性，对称性，不然Arrays.sort，Collections.sort会报IllegalArgumentException异常

 说明：
  1） 自反性：x，y的比较结果和y，x的比较结果相反。
  2） 传递性：x>y,y>z,则x>z。
  3） 对称性：x=y,则x,z比较结果和y，z比较结果相同。反例：下例中没有处理相等的情况，
  实际使用中可能会出现异常：
    new Comparator<Student>(){          
        @Override         
        public int compare(Student o1, Student o2){             
            return o1.getId() > o2.getId() ? 1 :-1;         
        }     
    } 

40.【推荐】集合初始化时，尽量指定集合初始值大小。说明：ArrayList尽量使用ArrayList(int initialCapacity) 初始化。

  类似注意HashMap的扩容死链，导致CPU飙升的问题。

41.【推荐】使用entrySet遍历Map类集合KV，而不是keySet方式进行遍历，keySet其实是遍历了2次，一次是转为Iterator对象，另一次是从hashMap中取出key 所对应的value。而entrySet只是遍历了一次就把key和value都放到了entry中，效率更高。如果是JDK8，使用Map.foreach方法。

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

42.【强制】高度注意Map类集合K/V能不能存储null值的情况，并且作为KEY的对象必须同时重写hashCode和equals方法

43.【推荐】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。
说明：稳定性指集合每次遍历的元素次序是一定的。有序性是指遍历的结果是按某种比较规则依次排列的。如：ArrayList是order/unsort；HashMap是unorder/unsort；TreeSet是 order/sort

44.【推荐】利用Set元素唯一的特性，可以快速对另一个集合进行去重操作，避免使用List的 contains方法进行遍历去重操作

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

正例：注意线程安全，使用DateUtils。亦推荐如下处理：
    private static final ThreadLocal<DateFormat> df = 
       new ThreadLocal<DateFormat>() {      
       @Override       
       protected DateFormat initialValue(){           
          return newSimpleDateFormat("yyyy-MM-dd");       
       }   
     };   
说明：如果是JDK8的应用，可以使用instant代替Date，Localdatetime代替Calendar，
Datetimeformatter代替Simpledateformatter，官方给出的解释：simple beautiful 
strong immutable thread-safe

46.【推荐】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯

正例：
      public class TimerTaskThread extends Thread{      
          publicTimerTaskThread(){         
              super.setName("TimerTaskThread");
          } 
      }

47.【推荐】线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

说明：Executors各个方法的弊端：
    1）newFixedThreadPool和newSingleThreadExecutor: 
      主要问题是堆积的请求处理队列可能会耗费非常大的内存，甚至OOM。
    2）newCachedThreadPool和newScheduledThreadPool:  
      主要问题是线程数最大数是Integer.MAX_VALUE，可能会创建数量非常多的线程，甚至OOM。

48.【强制】使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法可以执行，避免主线程无法执行至 countDown方法，直到超时才返回结果。

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

49.【强制】避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed 导致的性能下降。

说明：Random实例包括java.util.Random 的实例或者 Math.random()实例。
正例：
在JDK7之后，可以直接使用API ThreadLocalRandom，在 JDK7之前，可以做到每个线程一个实例

50.【强制】通过双重检查锁（double-checked locking）（在并发场景）实现延迟初始化的优化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration),推荐问题解决方案中较为简单一种（适用于jdk5及以上版本），将目标属性声明为 volatile型。

反例：
class Foo {  
    private Helper helper = null;  
    public Helper getHelper() { 
        if (helper ==null)   
            synchronized(this) {      
                 if (helper== null)        
                     helper = newHelper();   
        }      
        return helper; 
    } 

// other functions and members... 

} 

说明：将反例中helper的属性声明为private volatile Helper helper= null，即可解决该问题。

51.【强制】volatile解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。

解决方案：
    如果想取回count++数据，使用如下类实现
    AtomicInteger count = new AtomicInteger(); 
    count.addAndGet(1);     

    另外count++操作如果是JDK8，推荐使用LongAdder对象，
    比AtomicLong性能更好（减少乐观锁的重试次数）。

52.【推荐】ThreadLocal无法解决共享对象的更新问题，ThreadLocal对象建议使用static修饰。这个变量是针对一个线程内所有操作共有的，所以设置为静态变量，所有此类实例共享此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量

53.【推荐】在一个switch块内，每个case要么通过break/return来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有

54.【强制】在if/else/for/while/do语句中必须使用大括号，即使只有一行代码，避免使用下面的形式：if (condition) statements;

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

if(condition){            
   …            
   return obj;   
}  
// 接着写else的业务逻辑代码; 
说明：如果使用要if-else if-else方式表达逻辑，【强制】请勿超过3层，超过请使用: 状态设计模式

56.【强制】除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行复杂的语句，以提高可读性。

57.【推荐】try-catch移至循环体外

58.【推荐】方法中需要进行参数校验的场景：

1） 调用频次低的方法。
2） 执行时间开销很大的方法，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，
或者错误，那得不偿失。  
3） 需要极高稳定性和可用性的方法。
4） 对外提供的开放接口，不管是RPC/API/HTTP接口

59.【推荐】方法中不需要参数校验的场景：

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

60.【强制】类、类属性、类方法的注释必须使用javadoc规范，使用/*内容/格式，不得使用//xxx方式。

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

61.【推荐】所有的抽象方法（包括接口中的方法）必须要用javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

62.【强制】所有的类都必须添加创建者信息

63.【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐

64.【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途

65.【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词、关键字，保持英文原文即可

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

66.【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改

67.【推荐】注释掉的代码尽量要配合说明，而不是简单的注释掉。

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

68.【推荐】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担

反例：
 // put elephant into fridge  
 put(elephant,fridge);   

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

69.【推荐】待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）

70.【推荐】错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）

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

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

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

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

73.【强制】注意 Math.random() 这个方法返回是double类型，注意取值范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法

74.【强制】获取当前毫秒数：System.currentTimeMillis(); 而不是new Date().getTime(); 说明：如果想获取更加精确的纳秒级时间值，用System.nanoTime。在JDK8中，针对统计时间等场景，推荐使用Instant类

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

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

76.【推荐】对于“明确停止使用的代码和配置”，如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去，避免造成过多垃圾。清理这类垃圾代码是技术气场，不要有这样的观念：“不做不错，多做多错

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

 说明：如果JDK7，可以使用try-with-resources方法

78.【强制】不能在finally块中使用return，finally块中的return返回后方法结束执行，不会再执行try块中的return语句。

79.【强制】方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。调用方需要进行null判断防止NPE问题。

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

80.【强制】防止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。

81.【强制】避免出现重复的代码（Don’tRepeat Yourself），即DRY原则。

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

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

82.【强制】应用中不可直接使用日志系统（Log4j、Logback）中的API，而应依赖使用日志框架SLF4J中的API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

83.【推荐】日志文件推荐至少保存15天，因为有些异常具备以“周”为频次发生的特点

84.【推荐】谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志

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

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

1）json操作：fastjson
2）md5操作：commons-codec
3）工具集合：Guava包
4）数组操作：ArrayUtils（org.apache.commons.lang3.ArrayUtils）
5）集合操作：CollectionUtils(org.apache.commons.collections4.CollectionUtils)
6）除上面以外还有NumberUtils、DateFormatUtils、DateUtils
  等优先使用 org.apache.commons.lang3这个包下的，
  不要使用org.apache.commons.lang包下面的。原因是commons.lang这个包是从JDK1.2开始
  支持的所以很多1.5/1.6的特性是不支持的，例如：泛型

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

87.【强制】可被用户直接访问的功能必须进行权限控制校验。说明：防止没有做权限控制就可随意访问、操作别人的数据，比如查看、修改别人的订单

88.【强制】用户敏感数据禁止直接展示，必须对展示数据脱敏。说明：支付宝中查看个人手机号码会显示成:158****9119，隐藏中间4位，防止隐私泄露

89.【强制】用户输入的SQL参数严格使用参数绑定或者METADATA字段值限定，防止SQL注入，禁止字符串拼接SQL访问数据库

90.【强制】用户请求传入的任何参数必须做有效性验证。

说明：忽略参数校验可能导致：
1） page size过大导致内存溢出
2） 恶意order by导致数据库慢查询
3） 正则输入源串拒绝服务ReDOS
4） 任意重定向
5） SQL注入
6） Shell注入
7） 反序列化注入

91.【强制】表单、AJAX提交必须执行CSRF安全过滤。

说明：CSRF(Cross-siterequest forgery)跨站请求伪造是一类常见编程漏洞。对于存在CSRF漏洞
的应用/网站，攻击者可以事先构造好URL，只要受害者用户一访问，后台便在用户不知情情况下对数据库
中用户参数进行相应修改 

92.【强制】URL外部重定向传入的目标地址必须执行白名单过滤

93.【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放限制，如数量限制、疲劳度控制、验证码校验，避免被滥刷、资损。

说明：如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，
并造成短信平台资源浪费

94.【强制】发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略

四、Android编码规范

<b>名词解释：
1）resPrefix ：资源的前缀，用于区分不同module中的资源，每个module都需要有一个区别于其他module的资源前缀，避免资源冲突。</b>

1、【推荐】常用缩写

1、【推荐】资源缩写汇总

参考：Android 资源

有的缩写，使用时当做前缀prefix; 有的缩写则需要当做后缀sufix来使用

1、【强制】多状态资源，添加后缀来标识状态

参考：