java开发规范

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

2. 缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

3. Service/DAO 层方法命名规约

• 获取单个对象的方法用 get 做前缀。
• 获取多个对象的方法用 list 做前缀。
• 获取统计值的方法用 count 做前缀。
• 插入的方法用 save/insert 做前缀。
• 删除的方法用 remove/delete 做前缀。
• 修改的方法用 update 做前缀。

4. 模型命名规约

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

1. DO（Data Object）：与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
2. DTO（Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象。
3. BO（Business Object）：业务对象。由 Service 层输出的封装业务逻辑的对象。
4. AO（Application Object）：应用对象。在 Web 层与 Service 层之间抽象的复用对象模型，极为贴近展示层，复用度不高。
5. VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。
6. Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输。

5. 注释的双斜线与注释内容之间有且仅有一个空格。

6. 循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。

7. 使用集合转数组的方法，必须使用集合的 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 错误。

---

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

说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList

体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { "you", "wu" };

List list = Arrays.asList(str);

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

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

---

9. 不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator

方式，如果并发操作，需要对 Iterator 对象加锁。

正例：

Iterator<String> iterator = list.iterator(); 
while (iterator.hasNext()) { 
    String item = iterator.next(); 
    if (删除元素的条件) { 
        iterator.remove(); 
    } 
}

反例：

List<String> list = new ArrayList<String>(); 
list.add("1"); 
list.add("2"); 
for (String item : list) { 
    if ("1".equals(item)) { 
        list.remove(item); 
    } 
}

说明： 以上代码的执行结果肯定会出乎大家的意料，那么试一下把 “1” 换成 “2” ，会是同样的

结果吗？

---

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

11. 集合初始化时，指定集合初始值大小。

说明：HashMap 使用 HashMap(int initialCapacity) 初始化，

正例： initialCapacity = ( 需要存储的元素个数 / 负载因子 ) + 1 。注意 负载因子（即 loader

factor ）默认为 0.75 ， 如果暂时无法确定初始值大小，请设置为 16 （即默认值）。

反例： HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容

量 7 次被迫扩大， resize 需要重建 hash 表，严重影响性能。

---

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

说明： keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出

key 所对应的 value 。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效

率更高。如果是 JDK 8 ，使用 Map . foreach 方法。

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

一个 Set 集合对象 ； entrySet() 返回的是 K - V 值组合集合。

// keySet
for (String key : map.keySet()) {
   System.out.println("key= "+ key + " and value= " + map.get(key));
}

// entrySet
for (Map.Entry<String, String> entry : map.entrySet()) {
   System.out.println("key= " + entry.getKey() + " and value= " + entry.getValue());
}

// JDK8的迭代方式
map.forEach((key, value) -> {
    System.out.println(key + "：" + value);
});

13. 高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格：

集合类	Key	Value	Super	说明
Hashtable	不允许为 null	不允许为 null	Dictionary	线程安全
ConcurrentHashMap	不允许为 null	不允许为 null	AbstractMap	锁分段技术（ JDK8:CAS ）
TreeMap	不允许为 null	允许为 null	AbstractMap	线程不安全
HashMap	允许为 null	允许为 null	AbstractMap	线程不安全
AbstractMap	线程不安全

反例： 由于 HashMap 的干扰，很多人认为 ConcurrentHashMap 是可以置入 null 值，而事实上，

存储 null 值时会抛出 NPE 异常。

---

14. 合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。

说明： 有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次

序是一定的。如： ArrayList 是 order / unsort ； HashMap 是 unorder / unsort ； TreeSet 是

order / sort 。

---

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

HashSet去重会对数据重新排序，LinkedHashSet保持原有顺序

---

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 = new ThreadLocal<DateFormat>() {
    @Override
    protected DateFormat initialValue() {
        return new SimpleDateFormat("yyyy-MM-dd");
    }
};

说明： 如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，

DateTimeFormatter 代替 SimpleDateFormat ，官方给出的解释： simple beautiful strong

immutable thread - safe 。

---

19. 并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加

锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。

说明： 如果每次访问冲突概率小于 20% ，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次

数不得小于 3 次。

---

20. 多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获

抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。

---

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

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

---

22. volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题， 但是如果多写，同样无法解决线程安全问题。如果是 count++操作，使用如下类实现： AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8，推 荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）。

---

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

switch (name) {
    case "沈":
        return "ccshen";
    case "李":
        return "lj"; 
    default:
        return;   
}

---

24. 表达异常的分支时，少用 if-else 方式，这种方式可以改写成：

if (condition) { 
 ... 
 return obj; 
} 
// 接着写 else 的业务逻辑代码;

说明： 如果非得使用 if()...else if()...else... 方式表达逻辑，【强制】避免后续代码维

护困难，请勿超过 3 层。

正例： 超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，

其中卫语句示例如下：

public void today() {
 if (isBusy()) {
    System.out.println(“change time.”);
     return;
 }
 if (isFree()) {
    System.out.println(“go to travel.”);
     return;
 }
    System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”);
    return;
}

---

25. 除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复 杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

说明：很多 if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么 样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？

正例：

// 伪代码如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
 ...
}

反例：

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

---

26. 下列情形，需要进行参数校验：

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

---

27. 类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用

// xxx 方式

// 注释内容，注意在 // 和注释内容之间有一个空格。

方法内部单行注释，在被注释语句上方另起一行，使用 // 注释。

方法内部多行注释 使用/* */ 注释，注意与代码对齐。

对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三

个斜杠 (///) 来说明注释掉代码的理由。

​​​​​​​

---

28. 对大段代码进行 try-catch，这是不负责任的表现。

catch 时请分清稳定代码和非稳 定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。

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

说明： 如果 JDK 7 及以上，可以使用 try - with - resources 方式。

不能在 finally 块中使用 return ， finally 块中的 return 返回后方法结束执行，不

会再执行 try 块中的 return 语句。

---

29. 防止 NPE，是程序员的基本修养，注意 NPE 产生的场景

1）返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。

反例：public int f() { return Integer 对象}， 如果为 null，自动解箱抛 NPE。

2 ） 数据库的查询结果可能为 null 。

3 ） 集合里的元素即使 isNotEmpty ，取出的数据元素也可能为 null 。

4 ） 远程调用返回对象时，一律要求进行空指针判断，防止 NPE 。

5 ） 对于 Session 中获取的数据，建议 NPE 检查，避免空指针。

6 ） 级联调用 obj . getA() . getB() . getC() ； 一连串调用，易产生 NPE 。

正例： 使用 JDK8 的 Optional 类来防止 NPE 问题。