从《阿里巴巴Java开发手册》看Java中的坑

 

简介

为什么会有代码规范？一个很重要的原因是，加强代码的可阅读性，避免歧义。还有一个重要的原因是，有许多语法允许，但是你这么做了，在特定情况下就会坑你一下你还不知道怎么回事的用法，应该避免使用。

今天，我们就扒一扒《阿里巴巴Java开发手册》中的此类规范。

本文可以看作《阿》的简化版，只筛选出了上述定义的规范，对于一些只是增强代码可读性的规范，还请参考《阿》原文

命名风格

Java中的内部类是以Father&Son.class命名的，特定情况下，使用$会产生编译错误

OOP规约

直接通过类名引用静态变量，会在编译时期编译成字面量，放到类自身的常量池中

名副其实的大坑，笔者曾经调了好久才找到这个bug，记忆犹新

一般都很少注意这个值吧，或者项目中用json传递数据，不受这个影响

构造函数中的业务逻辑，会在子类的构造函数中调用，应该手动init()

笔者碰到的生产问题：如果接到的报文是一个xml，只有其中一个值有用，通常会做简单处理，即：
xml.split("<a>|</a>");
标签<a>在中间和结尾处返回的数组大小是不一样的，原因同上

大部分朋友唯一用到final的地方就是常量，其实还有这么多的场景可以使用，让程序更加易读

集合处理

不按本条规则，你的HashMap最终可能只是一颗红黑树（JDK1.8起）

看似很绕，其实很容易理解，<? extents T> ，集合内部都是T的子类，add的时候不能保证类型一致，同理，<? super T> get的时候，不知道返回的是什么类型

一试便知

Comparator源码中返回值的定义如下，等于时返回0
* @return a negative integer, zero, or a positive integer as the
* first argument is less than, equal to, or greater than the
* second.

并发处理

问题在于helper=new Helper();
该操作需要三步：
1. 分配对象的内存空间
2. 初始化对象
3. 设置helper指向刚分配的内存地址
其中2和3可能会被虚拟机重排序，导致其他线程看到一个还未被初始化的helper，从而出现问题。
在标红处加上volatile可以避免重排序
参考《Java并发编程的艺术》3.8章 “双重检查锁定与延迟初始化”

volatile仅仅是解决了内存可见问题，线程在更新volatile时，会更新到主内存（这里指堆中的线程共享空间，与TLAB（ThreadLocalAllocationBuffer对应）），和锁、原子性没有任何关系

控制语句

虽然这是一个提高代码可读性的规范，但实在忍不住推荐出来，如果所有的复杂if都采用这条规范，那么世界将是多么的美好

其他

定义在类中，用static修饰，可以参考我的这篇文章《JAVA中final、static、volatile在字节码文件中的表现》，帮助理解satic的意义

异常处理

catch完，起码要打个log吧？catch住什么都不做，出错的时候会让人抓狂

索引规约

总结

本文筛选了《阿里巴巴Java开发手册》中一部分比较有意思的规范，强烈建议读者下载完整电子版通读