开发总结

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

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

接口基础常量表示：StringCOMPANY = "alibaba";

反例：接口方法定义：public abstractvoid f();

 

2.各层命名规约：
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

 

3.不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类： CacheConstants下； 系统配置相关的常量放在类：ConfigConstants下。

说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

 

4.关于基本数据类型与包装数据类型的使用标准如下：
1）所有的POJO类属性必须使用包装数据类型。

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

3） 所有的局部变量【 推荐】 使用基本数据类型。
说明： POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE 问题，或者入库检查，都由使用者来保证。

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

 

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

 

6.setter方法中，参数名称与类成员变量名称一致， this.成员名=参数名。在getter/setter 方法中，尽量不要增加业务逻辑，增加排查问题的难度。
反例：
public Integer getData(){
    if(true) {
        returndata + 100;
    } else {
        returndata - 100;
    }
}

 

7.循环体内，字符串的联接方式，使用 StringBuilder的 append 方法进行扩展。
反例：
String str = "start";
for(int i=0; i<100; i++){
    str = str +"hello";
}
说明： 反编译出的字节码文件显示每次循环都会 new出一个 StringBuilder 对象，然后进行append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。

 

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

 

9.关于 hashCode和equals 的处理，遵循如下规则：

1） 只要重写 equals，就必须重写 hashCode。

2） 因为 Set存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须重写这两个方法。

3） 如果自定义对象做为 Map的键，那么必须重写 hashCode 和 equals。

正例：String重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象作为 key 来使用。

 

10.使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出UnsupportedOperationException 异常。

说明：asList的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str =new String[] { "a", "b" };

List list =Arrays.asList(str);

第一种情况：list.add("c");运行时异常。

第二种情况： str[0]="gujin";那么 list.get(0)也会随之修改。

 

11.不要在 foreach循环里进行元素的 remove/add 操作。 remove 元素请使用 Iterator
方式，如果并发操作，需要对 Iterator 对象加锁。
反例：
List<String> a = newArrayList<String>();
    a.add("1");
    a.add("2");
for (String temp : a) {
   if("1".equals(temp)){
    a.remove(temp);
    }
}
说明： 以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的
结果吗？
正例：
Iterator<String> it =a.iterator();
while(it.hasNext()){
    String temp =it.next(); 
    if(删除元素的条件){
       it.remove();
     }
}

 

12.在 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;
}
}

 

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

 

14.使用 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 值组合集合。

 

15.利用 Set元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的contains 方法进行遍历、对比、 去重操作。

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

说明： 使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

 

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

说明： Executors 返回的线程池对象的弊端如下：

1） FixedThreadPool 和 SingleThreadPool:

允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。

2） CachedThreadPool 和 ScheduledThreadPool:

允许的创建线程数量为 Integer.MAX_VALUE， 可能会创建大量的线程，从而导致 OOM。

 

18.SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为static，必须加锁，或者使用 DateUtils 工具类。
正例： 注意线程安全，使用 DateUtils。亦推荐如下处理：
private static final ThreadLocal<DateFormat> df = newThreadLocal<DateFormat>() {
      @Override
      protected DateFormat initialValue(){
           return newSimpleDateFormat("yyyy-MM-dd");
      }
};

 

19.高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁； 能锁区块，就不要锁整个方法体； 能用对象锁，就不要用类锁。

 

20.并发修改同一记录时，避免更新丢失，要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。
说明： 如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于 3 次。

 

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

 

22.推荐尽量少用 else， if-else 的方式可以改写成：
if(condition){
      ...
      return obj;
}
// 接着写 else 的业务逻辑代码;

说明： 如果非得使用 if()...else if()...else...方式表达逻辑，【强制】请勿超过 3 层，超过请使用状态设计模式。

正例： 逻辑上超过 3层的 if-else 代码可以使用卫语句，或者状态模式来实现。

 

23.循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的 try-catch操作（ 这个 try-catch 是否可以移至循环体外） 。

 

24.注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x