Java编程规约
2021-07-09 by uino 102 编码规范

一、命名风格

  1. 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束

反例name / name / $name / name / name$ / name

  1. 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式

说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。

正例:uinnova / tarsier / cmdb / ci 等国际通用的名称,可视同英文。

反例:chuangjianCI [创建] / getfenleiByName() [分类] / int 某变量 = 3

  1. 【强制】类名使用UpperCamelCase风格,但以下情形例外:DO / BO / DTO / VO / AO / PO / UID等

    正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

    反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

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

    正例: localValue / getHttpMessage() / inputUserId

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

    正例:MAX_STOCK_COUNT 反例:MAX_COUNT

  4. 【强制】抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾

  5. 【强制】类型与中括号紧挨相连来 表示 数组

    正例: 定义整形数组 int[] arrayDemo;

    反例: 在 main 参数中,使用 String args[]

  6. 【强制】POJO类中布尔类型的变量,都不要加is前缀,否则部分框架解析会引起序列化错误

    反例:定义为基本数据类型Boolean isDeleted的属性,它的方法也是isDeleted(),RPC框架在反向解析的时候,“误以为”对应的属性名称是deleted,导致属性获取不到,进而抛出异常。

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

    正例: 应用工具类包名为com.uinnova.vmdb.util、类名为MessageUtils(此规则参考spring的框架结构)

  8. 【强制】杜绝完全不规范的缩写,避免望文不知义

反例: AbstractClass“缩写”命名成AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。

  1. 【强制】为了达到代码自解释的目标,任何定义编程元素在命名时使用尽量完整单词 组合来表达其意

正例: 在 JDK 中, 表达 原子更新的类名为: AtomicReferenceFieldUpdater

反例: 变量 int a 的随意命名

  1. 【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式

    说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。

正例:public class OrderFactory;
public class LoginProxy; public class ResourceObserver;

  1. 接口和实现类的命名有两套规则

    • 【强制】对于Service和DAO类,内部的实现类用Impl的后缀与接口区别。 正例:CacheServiceImpl实现CacheService接口。
    • 【推荐】 如果是形容能力的接口名称,取对应的形容词为接口名(通常是–able的形式)。 正例:AbstractTranslator实现 Translatable接口。
  2. 【参考】枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开

    说明:枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制是私有。

正例: 枚举名字为ProcessStatusEnum的成员名称:SUCCESS / UNKNOWN_REASON。

  1. 【参考】Service/DAO层方法命名规约

    • 获取单个对象的方法用get做前缀。
    • 获取多个对象的方法用list做前缀,复数形式结尾如:listObjects。
    • 获取统计值的方法用count做前缀。
    • 插入的方法用save/insert做前缀。
    • 删除的方法用remove/delete做前缀。
    • 修改的方法用update做前缀。

二、常量定义

  1. 【强制】在long或者Long赋值时,数值后使用大写的L,不能是小写的l,小写容易跟数字1混淆,造成误解

    说明:Long a = 2l; 写的是数字的21,还是Long型的2?

  2. 【推荐】不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护。 说明:大而全的常量类,杂乱无章,使用查找功能才能定位到修改的常量,不利于理解和维护

    正例:缓存相关常量放在类CacheConsts下;系统配置相关常量放在类ConfigConsts下。

三、代码格式

  1. 【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则

    • 左大括号前不换行
    • 左大括号后换行
    • 右大括号前换行
    • 右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行。
  2. 【强制】左小括号和字符之间不出现空格;同样,右小括号和字符之间也不出现空格;而左大括号前需要空格。详见第5条下方正例提示

    反例:if (空格a == b空格)

  3. 【强制】if/for/while/switch/do等保留字与括号之间都必须加空格

  4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格

    说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

  5. 【强制】采用4个空格缩进,禁止使用tab字符

    说明: 如果使用 tab 缩进,必须设置 1个 tab 为 4个空格。 IDEA 设置 tab 为 4个空格时, 请勿勾选 Use tab character ;而在 eclipse 中,必须勾选 insert spaces for tabs 。

    正例: (涉及1-5点)

    public static void main(String[] args) {
        // 缩进4个空格
        String say = "hello";
        // 运算符的左右必须有一个空格
        int flag = 0;
        // 关键词if与括号之间必须有一个空格,括号内的f与左括号,0与右括号不需要空格
        if (flag == 0) {
            System.out.println(say);
        }
        // 左大括号前加空格且不换行;左大括号后换行
        if (flag == 1) {
            System.out.println("world");
            // 右大括号前换行,右大括号后有else,不用换行
        } else {
            System.out.println("ok");
            // 在右大括号后直接结束,则必须换行
        }
    }
    
  6. 【强制】单行字符数限不超过 120 个,超出需要换行时 个,超出需要换行时 遵循如下原则

    • 第二行相对一缩进 4个空格,从第三行开始不再继续缩进参考示例。
    • 运算符与下文一起换行
    • 方法调用的点符号与下文一起换行
    • 方法调用中的多个参数需要换行时,在逗号后进行
    • 在括号前不要换行,见反例。

    正例

    StringBuffer sb = new StringBuffer();
    // 超过120个字符的情况下,换行缩进4个空格,点号和方法名称一起换行
    sb.append("zi").append("xin")...
        .append("huang")...
        .append("huang")...
        .append("huang");
    

    反例

    StringBuffer sb = new StringBuffer();
    // 超过120个字符的情况下,不要在括号前换行
    sb.append("zi").append("xin")...append
        ("huang");
    // 参数很多的方法调用可能超过120个字符,不要在逗号前换行
    method(args1, args2, args3, ...
        , argsX);
    
  7. 【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格

    正例:下例中实参的args1,后边必须要有一个空格。
    method(args1, args2, args3);

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

  9. 【推荐】单个方法的总行数不超过 80 行。
    说明: 包括方法签名、结束右大号、方法内代码、注释、空行、回车及任何不可见字符的总行数不超过 80 行。

    正例:代码逻辑分清红花和绿叶,个性和共性,绿叶逻辑单独出来成为额外方法,使主干代码更加清晰;共性逻辑抽取成为共性方法,便于复用和维护。

  10. 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性

    说明:任何情形,没有必要插入多个空行进行隔开

四、OOP规约

  1. 【强制】所有的覆写方法,必须加@Override注解

    说明:getObject()与get0bject()的问题。一个是字母的O,一个是数字的0,加@Override可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错

  2. 【强制】相同参数类型,相同业务含义,才可以使用Java的可变参数,避免使用Object

    说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)

    正例: public List listUsers(String type, Long… ids) {…}

  3. 【强制】外部正在调用或者三方库依赖的接口,不允许修改方法签名,避免对接口调用方产生影响。接口过时必须加@Deprecated注解,并清晰地说明采用的新接口或者新服务是什么

  4. 【强制】不能使用过时的类或方法。
    说明:java.net.URLDecoder 中的方法decode(String encodeStr) 这个方法已经过时,应该使用双参数decode(String source, String encode)。接口提供方既然明确是过时接口,那么有义务同时提供新的接口;作为调用方来说,有义务去考证过时方法的新实现是什么

  5. 【强制】Object的equals方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals

    正例:“test”.equals(object);

    反例:object.equals(“test”);

    说明:推荐使用java.util.Objects#equals(JDK7引入的工具类)

  6. 【强制】所有的相同类型的包装类对象之间值的比较,全部使用equals方法比较
    说明:对于Integer var = ? 在-128至127范围内的赋值,Integer对象是在IntegerCache.cache产生,会复用已有对象,这个区间内的Integer值可以直接使用==进行判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑,推荐使用equals方法进行判断

  7. 【强制】序列化类新增属性时,请不要修改serialVersionUID字段,避免反序列失败;如果完全不兼容升级,避免反序列化混乱,那么请修改serialVersionUID值。 说明:注意serialVersionUID不一致会抛出序列化运行时异常。

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

  9. 【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,便于阅读,此条规则优先于第10条规则

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

说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类关心,也可能是“模板设计模式”下的核心方法;而私有方法外部一般不需要特别关心,是一个黑盒实现;因为承载的信息价值较低,所有Service和DAO的getter/setter方法放在类体最后。

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

反例

 public Integer getData() {
     if (condition) {
         return this.data + 100;
     } else {
         return this.data - 100;
     }
 }
  1. 【推荐】循环体内,字符串的连接方式,使用StringBuilder的append方法进行扩展

说明:下例中,反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象,然后进行append操作,最后通过toString方法返回String对象,造成内存资源浪费。

反例

```java
    String str = "start";
    for (int i = 0; i < 100; i++) {
        str = str + "hello";
    }
```
  1. 【推荐】final可以声明类、成员变量、方法、以及本地变量,下列情况使用final关键字

    • 不允许被继承的类,如:String类
    • 不允许修改引用的域对象
    • 不允许被重写的方法,如:POJO类的setter方法
    • 不允许运行过程中重新赋值的局部变量
    • 避免上下文重复使用一个变量,使用final描述可以强制重新定义一个变量,方便更好地进行重构。
  2. 【推荐】慎用Object的clone方法来拷贝对象

说明:对象的clone方法默认是浅拷贝,若想实现深拷贝需要重写clone方法实现域对象的深度遍历式拷贝。

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

    • 如果不允许外部直接通过new来创建对象,那么构造方法必须是private。
    • 工具类不允许有public或default构造方法。
    • 类非static成员变量并且与子类共享,必须是protected。
    • 类非static成员变量并且仅在本类使用,必须是private。
    • 类static成员变量如果仅在本类使用,必须是private。
    • 若是static成员变量,考虑是否为final。
    • 类成员方法只供类内部调用,必须是private。
    • 类成员方法只对继承类公开,那么限制为protected。

说明:任何类、方法、参数、变量,严控访问范围。过于宽泛的访问范围,不利于模块解耦。思考:如果是一个private的方法,想删除就删除,可是一个public的service成员方法或成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视线内,变量作用域太大,无限制的到处跑,那么你会担心的。

五、集合处理

  1. 【强制】关于hashCode和equals的处理,遵循如下规则

    • 只要重写equals,就必须重写hashCode。
    • 因为Set存储的是不重复的对象,依据hashCode和equals进行判断,所以Set存储的对象必须重写这两个方法。
    • 如果自定义对象作为Map的键,那么必须重写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子列表的所有操作最终会反映到原列表上

  1. 【强制】在subList场景中,高度注意对原集合元素的增加或删除,均会导致子列表的遍历、增加、删除产生ConcurrentModificationException 异常

  2. 【强制】使用集合转数组的方法,必须使用集合的toArray(T[] array),传入的是类型完全一样的数组,大小就是list.size()

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

***正例***:

```java
    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错误。
  1. 【强制】使用工具类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)也会随之修改。

  1. 【强制】泛型通配符<? extends T>来接收返回的数据,此写法的泛型集合不能使用add方法,而<? super T>不能使用get方法,作为接口调用赋值时易出错

    说明:扩展说一下PECS(Producer Extends Consumer Super)原则:

    • 频繁往外读取内容的,适合用<? extends T>。
    • 经常往里插入的,适合用<? super T>。
  2. 【强制】不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式,如果并发操作,需要对Iterator对象加锁

    正例

    List<String> list = new ArrayList<>();
    list.add("1");
    list.add("2");
    Iterator<String> iterator = list.iterator();
    while (iterator.hasNext()) {
        String item = iterator.next();
    
        if (删除元素的条件) {
            iterator.remove();
        }
    }
    

    反例

    for (String item : list) {
        if ("1".equals(item)) {
            list.remove(item);
        }
    }
    

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

  3. 【强制】 在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比较结果相同。

~~反例~~:下例中没有处理相等的情况,实际使用中可能会出现异常:

```java
    new Comparator<Student>() {
        @Override
        public int compare(Student o1, Student o2) {
            return o1.getId() > o2.getId() ? 1 : -1;
        }
    };
```
  1. 【推荐】集合初始化时,指定集合初始值大小

    说明:HashMap使用HashMap(int initialCapacity) 初始化。

    正例:initialCapacity = (需要存储的元素个数 / 负载因子) + 1。
    注意 负载因子(即loader factor)默认为 0.75,如果 暂时无法 确定 初始值大小,请设置为 16(即默认值)。

    反例: HashMap需要 放置 1024个元素, 由于 没有设置容量 初始大小,随着元素不断增加容 量 7次被迫扩大, resize需要重建 hash表,严重影响性能。

  2. 【推荐】使用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值组合集合。

  3. 【推荐】高度注意Map类集合K/V能不能存储null值的情况,如下表格

    • Hashtable Key:不允许为null,Value:不允许为null,Super:Dictionary,线程安全
    • ConcurrentHashMap Key:不允许为null,Value:不允许为null,Super:AbstractMap,锁分段技术(JDK8:CAS)
    • TreeMap Key:不允许为null,Value:允许为null | Super:AbstractMap,线程不安全
    • HashMap Key:允许为null,Value:允许为null,Super:AbstractMap,线程不安全

    反例: 由于HashMap的干扰,很多人认为ConcurrentHashMap是可以置入null值,而事实上,存储null值时会抛出NPE异常。

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

六、并发处理

  1. 【强制】获取单例对象需要保证线程安全,其中的方法也要保证线程安全

    说明:资源驱动类、工具类、单例工厂类都需要注意。

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

    正例

    public class TimerTaskThread extends Thread {
        public TimerTaskThread() {
            super.setName("TimerTaskThread");
            ...
        }
    }
    
  3. 【推荐】线程资源必须通过线程池提供,不允许在应用中自行显式创建线程

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

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

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

    • FixedThreadPool和SingleThreadPoolPool:
      允许的请求队列长度为 Integer.MAX_VALUE,可 能会堆积大量的请求,从而导致 OOM。
    • CachedThreadPool 和 ScheduledThreadPool:
      允许的创建线程数量为 Integer.MAX_VALUE,可能会创建大量的线程,从而导致 OOM。
  2. 【强制】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。

  3. 【强制】高并发时,同步调用应该去考量锁的性能损耗。能用无锁数据结构,就不要用锁;能锁区块,就不要锁整个方法体;能用对象锁,就不要用类锁。

    说明:尽可能使加锁的代码块工作量尽可能的小,避免在锁代码块中调用RPC方法。

  4. 【强制】对多个资源、数据库表、对象同时加锁时,需要保持一致的加锁顺序,否则可能会造成死锁
    说明:线程一需要对表A、B、C依次全部加锁后才可以进行更新操作,那么线程二的加锁顺序也必须是A、B、C,否则可能出现死锁。

  5. 【强制】并发修改同一记录时,避免更新丢失,需要加锁。要么在应用层加锁,要么在缓存加锁,要么在数据库层使用乐观锁,使用version作为更新依据

说明:如果每次访问冲突概率小于20%,推荐使用乐观锁,否则使用悲观锁。乐观锁的重试次数不得小于3次。

  1. 【强制】多线程并行处理定时任务时,Timer运行多个TimeTask时,只要其中之一没有捕获抛出的异常,其它任务便会自动终止运行,使用ScheduledExecutorService则没有这个问题。

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

说明:Random实例包括java.util.Random 的实例或者 Math.random()的方式。 正例:在JDK7之后,可以直接使用API ThreadLocalRandom,而在 JDK7之前,需要编码保证每个线程持有一个实例。

  1. 【参考】 HashMap在容量不够进行resize时由于高并发可能出现死链,导致CPU飙升,在开发过程中可以使用其它数据结构或加锁来规避此风险

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

七、控制语句

  1. 【强制】在一个switch块内,每个case要么通过break/return等来终止,要么注释说明程序将继续执行到哪一个case为止;在一个switch块内,都必须包含一个default语句并且放在最后,即使空代码

  2. 【强制】在if/else/for/while/do语句中必须使用大括号。即使只有一行代码,避免采用单行的编码方式:if (condition) statements;

  3. 【强制】在高并发场景中,避免使用 ”等于 ”判断作为中或退出的条件。 判断作为中或退出的条件

    说明: 如果并发控制没有处理好,容易产生等值判断被 如果并发控制没有处理好,容易产生等值判断被 “击穿 ”的情况,使用大于或小区间 的情况,使用大于或小区间 的情况,使用大于或小区间 的情况,使用大于或小区间 判断条件来代替。

    反例: 判断剩余奖品数量等于0时,终止发放奖品,但因为并发处理错误导致奖品数量瞬间变成了负数, 这样的话,活动无法终止。

  4. 【推荐】表达异常的分支时,少用if-else方式,这种方式可以改写成

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

说明:如果非得使用if()…else if()…else…方式表达逻辑,【强制】避免后续代码维护困难,请勿超过3层。

***正例***:超过3层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现,其中卫语句示例如下:

```java
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;
}
```
  1. 【推荐】除常用方法(如getXxx/isXxx)等外,不要在条件判断中执行其它复杂的语句,将复杂逻辑判断的结果赋值给一个有意义的布尔变量名,以提高可读性。 说明:很多if语句内的逻辑相当复杂,阅读者需要分析条件表达式的最终结果,才能明确什么样的条件执行什么样的语句,那么,如果阅读者分析逻辑表达式错误呢?

    正例

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

    反例

    if ((file.open(fileName, "w") != null) && (...) || (...)) {
        ...
    }
    
  2. 【推荐】循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变量、获取数据库连接,进行不必要的try-catch操作(这个try-catch是否可以移至循环体外)

  3. 【推荐】避免采用取反逻辑运算符。 说明: 取反逻辑不利于快速理解,并且写法必然存在对应的正向

    正例: 使用 if (x < 628) 来表达 x 小于 628 。

    反例: 使用 if (!(x >= 628)) 来表达 x 小于 628 。

  4. 【推荐】接口入参保护,这种场景常见的是用作批量操作的接口

八、注释规约

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

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

  1. 【强制】所有的抽象方法(包括接口中的方法)必须要用Javadoc注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。 说明:对子类的实现要求,或者调用注意事项,请一并说明

  2. 【强制】所有的类都必须添加创建者和创建日期

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

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

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

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

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

说明:代码与注释更新不同步,就像路网与导航软件更新不同步一样,如果导航软件严重滞后,就失去了导航的意义。
8. 【参考】谨慎注释掉代码。在上方详细说明,而不是简单地注释掉。如果无用,则删除

说明:代码被注释掉有两种可能性:

- 后续会恢复此段代码逻辑。
- 永久不用。

前者如果没有备注信息,难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。
  1. 【参考】对于注释的要求

    • 第一、能够准确反应设计思想和代码逻辑;
    • 第二、能够描述业务含义,使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路;注释也是给继任者看的,使其能够快速接替自己的工作。
  2. 【参考】好的命名、代码结构是自解释的,注释力求精简准确、表达到位。避免出现注释的一个极端:过多过滥的注释,代码的逻辑一旦修改,修改注释是相当大的负担

反例

// put elephant into fridge

put(elephant, fridge);

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

九、异常处理

  1. 【强制】catch计划外异常后,必须输出异常Error级别日志,禁止使用IDE自动生成的 e.printStackTrace()。

  2. 【强制】Java 类库中定义的可以通过预检查方式规避的RuntimeException异常不应该通过catch 的方式来处理

比如:NullPointerException,IndexOutOfBoundsException等等。 说明:无法通过预检查的异常除外,比如,在解析字符串形式的数字时,不得不通过catch NumberFormatException来实现。

正例:if (obj != null) {…}

反例:try { obj.method(); } catch (NullPointerException e) {…}

  1. 【强制】异常不要用来做流程控制,条件控制。 说明:异常设计的初衷是解决程序运行中的各种意外情况,且异常的处理效率比条件判断方式要低很多

  2. 【强制】catch时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型,再做对应的异常处理。 说明:对大段代码进行try-catch,使程序无法根据不同的异常做出正确的应激反应,也不利于定位问题,这是一种不负责任的表现。 正例:用户注册的场景中,如果用户输入非法字符,或用户名称已存在,或用户输入密码过于简单,在程序上作出分门别类的判断,并提示给用户

  3. 【强制】捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容

  4. 【强制】有try块放到了事务代码中,catch异常后,如果需要回滚事务,一定要注意手动回滚事务

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

说明:如果JDK7及以上,可以使用try-with-resources方式。

  1. 【强制】不要在 finally块中使用 return。

说明: finally块中的 return返回后方法结束执行 ,不会再返回后方法结束执行 ,不会再try块中的 return语句。

  1. 【强制】捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类

说明:如果预期对方抛的是绣球,实际接到的是铅球,就会产生意外情况。

  1. 【推荐】方法的返回值可以为null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回null值

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

  1. 【推荐】防止NPE,是程序员的基本修养,注意NPE产生的场景

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

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

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

    • 集合里的元素即使isNotEmpty,取出的数据元素也可能为null。

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

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

    • 级联调用obj.getA().getB().getC();一连串调用,易产生NPE。

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

十、其它

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

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

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

  2. 【强制】获取当前毫秒数System.currentTimeMillis(); 而不是new Date().getTime();

说明:如果想获取更加精确的纳秒级时间值,使用System.nanoTime()的方式。在JDK8中,针对统计时间等场景,推荐使用Instant类。

  1. 【推荐】不要在视图模板中加入任何复杂的逻辑

说明:根据MVC理论,视图的职责是展示,不要抢模型和控制器的活。

  1. 【推荐】任何数据结构的构造或初始化,都应指定大小,避免数据结构无限增长吃光内存

  2. 【推荐】及时清理不再使用的代码段或配置信息

说明:对于垃圾代码或过时配置,坚决清理干净,避免程序过度臃肿,代码冗余。

正例:对于暂时被注释掉,后续可能恢复使用的代码片断,在注释代码上方,统一规定使用三个斜杠(///)来说明注释掉代码的理由。