阿里巴巴Java开发手册——速读记录

时间:2020-12-30 03:27:26

  本随笔基于阿里巴巴Java开发手册V1.2,陆陆续续记录一些现阶段能理解的,有启发的内容,并将持续更新

一、编程规范

  1.命名规范

    (1)代码命名严禁下划线(_)或美元符号($)开头或结束

    (2)命名严禁拼音与英文混用的方式

    (3)类名采用 UpperCamelCase 命名方式,其他(变量,方法,参数等)采用 lowerCamelCase 方式

    (4)常量全部使用大写,使用下划线(_)连接

    (5)数组命名方式严禁使用 String args[] 的形式,请务必使用String[] args 的形式([]是数组的一部分)

    (6)POJO中的boolean类型变量都不要加 is(反例:isRich)以免引起解析异常。

    (7)包名统一小写,使用小数点(.)进行分隔

    (8)类名使用合适的后缀可以大大提高可读性,例如测试类 Test 结尾,异常类 Exception 结尾

   2.常量定义

    (1)严禁出现任何魔法值

    (2)long类型的变量,请使用大写L作为标识(long time = 2L)

    (3)变量尽量分类维护,尽量不要全定义在一个类中进行维护

  3.代码格式

     (1)大括号换行(竟然还有左大括号换行的?/笑哭),不再文字赘述,千言万语不如一张图

      阿里巴巴Java开发手册——速读记录

        (2)缩进采用4个空格,严禁使用Tab缩进

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

         (3)任何二目、三目运算符的左右两边都需要加一个空格。

      (4)if/for/while/switch/do 等保留字与括号之间都必须加空格。

      (5)换行规范:

        1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。

        2) 运算符与下文一起换行。

        3) 方法调用的点符号与下文一起换行。

        4) 在多个参数超长,在逗号后换行。

      (6)方法参数在定义和传入时,多个参数逗号后边必须加空格。

    4.OOP规范

      (1)静态方法与静态常量请使用 类名. 进行调用!

      (2)所有的覆写方法,必须加@Override 注解。

      (3)严禁使用过时的类或方法

      (4)Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用 equals。("abc".equals(str))

      (5)所有的 POJO 类属性必须使用包装数据类型;所有的局部变量使用基本数据类型。

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

      (7)POJO 类必须写 toString 方法。使用 IDE 的中工具:source> generate toString 时,如果继承了另一个 POJO 类,注意在前面加一下 super.toString。

      (8)类内方法定义顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter 方法。

      (9)循环体内,字符串的连接方式,使用 StringBuilder 的 append 方法进行扩展。