Java开发规范-阿里巴巴华山版-上

文章来源阿里巴巴   作者:阿里巴巴   发布时间:2020-06-25   阅读:1099   标签:代码规范

Java开发规范-阿里巴巴华山版

一-编程规约

1.1 命名风格

  1. 【强制】不能以下划线或美元符号开始和结束。

  2. 【强制】禁止中英混合与中文

  3. 【强制】类名使用 UpperCamelCase 风格(: DO / BO / DTO / VO / AO/ PO / UID 等除外 )

  4. 【强制】 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格

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

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

  7. 【强制】 数组:类型与中括号紧挨相连来表示 :int[] arrayDemo

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

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

  10. 【强制】 避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命
    名,使可读性降低 (局部变量不要和类变量重名; 代码块中局部变量不要重名)

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

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

  13. 【推荐】 在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。 startTime / workQueue /

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

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

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

    1. 【强制】 对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用
      Impl 的后缀与接口区别
    2. 【推荐】 如果是形容能力的接口名称,取对应的形容词为接口名(通常是–able 的形容词)。
      1. AbstractTranslator 实现 Translatable 接口。
  17. 【参考】 枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开

  18. 【参考】 各层命名规约:

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

      1. 获取单个对象的方法用 get 做前缀。
      2. 获取多个对象的方法用 list 做前缀,复数形式结尾如: listObjects
      3. 获取统计值的方法用 count 做前缀。
      4. 插入的方法用 save/insert 做前缀。
      5. 插入的方法用 save/insert 做前缀。
      6. 插入的方法用 save/insert 做前缀。
    2. 领域模型命名规约

      • DO( Data Object):与数据库表结构一一对应,通过DAO层向上传输数据源对象。
      • DTO( Data Transfer Object):数据传输对象,Service或Manager向外传输的对象。
      • BO( Business Object):业务对象。 由Service层输出的封装业务逻辑的对象。
      • AO( Application Object):应用对象。 在Web层与Service层之间抽象的复用对象模型,极为贴近展示层,复用度不高。
      • VO( View Object):显示层对象,通常是Web向模板渲染引擎层传输的对象。
      • POJO( Plain Ordinary Java Object):在本手册中, POJO专指只有setter/getter/toString的简单类,包括DO/DTO/BO/VO等。
      • Query:数据查询对象,各层接收上层的查询请求。 注意超过2个参数的查询封装,禁止使用Map类来传输。
      1. 数据对象: xxxDO, xxx 即为数据表名。
      2. 数据传输对象: xxxDTO, xxx 为业务领域相关的名称。
      3. 展示对象: xxxVO, xxx 一般为网页名称。
      4. POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO

1.2 - 常量定义

  1. 【强制】 不允许任何魔法值( 即未经预先定义的常量) 直接出现在代码中。

    1. String key = "Id#taobao_" + tradeId;
    2. cache.put(key, value);
    3. // 缓存 get 时,由于在代码复制时,漏掉下划线,导致缓存击穿而出现问题
  2. 【强制】 在 long 或者 Long 赋值时, 数值后使用大写的 L

  3. 【推荐】 不要使用一个常量类维护所有常量, 要按常量功能进行归类,分开维护。

  4. 【推荐】 常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、
    包内共享常量、类内共享常量。

    1) 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 constant 目录下。
    2) 应用内共享常量:放置在一方库中, 通常是子模块中的 constant 目录下。

    3) 子工程内部共享常量:即在当前子工程的 constant 目录下。
    4) 包内共享常量:即在当前包下单独的 constant 目录下。
    5) 类内共享常量:直接在类内部 private static final 定义。

  5. 【推荐】 如果变量值仅在一个固定范围内变化用 enum 类型来定义。

1.3-代码格式

  1. 【强制】 如果是大括号内为空,则简洁地写成{}即可,大括号中间无需换行和空格;如果是非 空代码块则:

    1. 左大括号前不换行。 左大括号前不换行。
    2. 右大括号前换行。 右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行。
  2. 【强制】 左小括号和字符之间不出现空格; 同样,右小括号和字符之间也不出现空格;而左
    大括号前需要空格。 反例: if (空格 a == b 空格)

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

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

  5. 【强制】 采用 4 个空格缩进,禁止使用 tab 字符 在 eclipse 中,必须勾选 insert spaces for tabs

  6. 【强制】 注释的双斜线与注释内容之间有且仅有一个空格

  7. 【强制】 在进行类型强制转换时,右括号与强制转换值之间不需要任何空格隔开。

  8. 【强制】 单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:

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

  9. 【强制】 方法参数在定义和传入时,多个参数逗号后边必须加空格。

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

  11. 【推荐】 单个方法的总行数不超过 80 行

    除注释之外的方法签名、 左右大括号、方法内代码、空行、回车及任何不可见字符的总行数

  12. 【推荐】 没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。

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

1.4-OOP规约

  1. 【强制】 避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析
    成本,直接用类名来访问即可。

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

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

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

  5. 【强制】 不能使用过时的类或方法。

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

  7. 【强制】 所有整型包装类对象之间值的比较, 全部使用 equals 方法比较。

  8. 【强制】 浮点数之间的等值判断,基本数据类型不能用==来比较,包装数据类型不能用equals 来判断。

    浮点数采用“尾数+阶码” 的编码方式,类似于科学计数法的“有效数字+指数” 的表示方式。二进 制无法精确表示大部分的十进制小数

    1. 指定一个误差范围,两个浮点数的差值在此范围之内,则认为是相等的。 Math.abs(a - b) < diff
    2. 使用 BigDecimal 来定义值,再进行浮点数的运算操作 BigDecimal x.equals(y)
  9. 【强制】 定义数据对象 DO 类时,属性类型要与数据库字段类型相匹配。

  10. 【强制】 为了防止精度损失, 禁止使用构造方法 BigDecimal(double)的方式

  11. 关于基本数据类型与包装数据类型的使用标准如下:

    1. 【强制】 所有的 POJO 类属性必须使用包装数据类型。
    2. 【强制】 所有的 POJO 类属性必须使用包装数据类型。
    3. 【推荐】 所有的局部变量使用基本数据类型。
  12. 【强制】 定义 DO/DTO/VO 等 POJO 类时,不要设定任何属性默认值。

  13. 【强制】 序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败;如果
    完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。

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

  15. 【强制】 POJO 类必须写 toString 方法。

  16. 【强制】 禁止在 POJO 类中,同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。

  17. 推荐】 使用索引访问用 String 的 split 方法得到的数组时,需做最后一个分隔符后有无内
    容的检查,否则会有抛 IndexOutOfBoundsException 的风险 :”a,b,c,,”.split(“,”).length==3

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

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

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

  21. 推荐】 循环体内,字符串的连接方式,使用 StringBuilder 的 append 方法进行扩展。

  22. 【推荐】 final 可以声明类、成员变量、方法、以及本地变量,下列情况使用 final 关键字:

    1) 不允许被继承的类,如: String 类。
    2) 不允许修改引用的域对象。
    3) 不允许被覆写的方法,如: POJO 类的 setter 方法。
    4) 不允许运行过程中重新赋值的局部变量。
    5) 避免上下文重复使用一个变量,使用 final 可以强制重新定义一个变量,方便更好地进行重构。

  23. 【推荐】 慎用 Object 的 clone 方法来拷贝对象。

    对象 clone 方法默认是浅拷贝,若想实现深拷贝需覆写 clone 方法实现域对象的深度遍历式拷贝

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

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

1.5-集合处理

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

    1) 只要覆写 equals,就必须覆写 hashCode。
    2) 因为 Set 存储的是不重复的对象,依据 hashCode 和 equals 进行判断,所以 Set 存储的对象必须覆
    写这两个方法。
    3) 如果自定义对象作为 Map 的键,那么必须覆写 hashCode 和 equals。
    说明: String 已覆写 hashCode 和 equals 方法,所以我们可以愉快地使用 String 对象作为 key 来使用。

  2. 【强制】 ArrayList 的 subList 结果不可强转成 ArrayList,否则会抛出 ClassCastException 异
    常, 即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。

  3. 【强制】 使用 Map 的方法 keySet()/values()/entrySet()返回集合对象时,不可以对其进行添
    加元素操作,否则会抛出 UnsupportedOperationException 异常。

  4. 【强制】 Collections 类返回的对象,如: emptyList()/singletonList()等都是 immutable
    list,不可对其进行添加或者删除元素的操作。

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

  6. 【强制】 使用集合转数组的方法,必须使用集合的 toArray(T[] array),传入的是类型完全一
    致、长度为 0 的空数组。

  7. 【强制】 在使用 Collection 接口任何实现类的 addAll()方法时,都要对输入的集合参数进行
    NPE 判断。

    在 ArrayList#addAll 方法的第一行代码即 Object[] a = c.toArray();

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

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

    原则: 第一、 频繁往外读取内容的,适合用<? extends T>。

    第二、 经常往里插入的,适合用<? super T>

  10. 【强制】 在无泛型限制定义的集合赋值给泛型限制的集合时,在使用集合元素时,需要进行
    instanceof 判断,避免抛出 ClassCastException 异常。

  11. 【强制】 不要在 foreach 循环里进行元素的 remove/add 操作。 remove 元素请使用
    Iterator 方式,如果并发操作,需要对 Iterator 对象加锁。

  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 比较结果相同。

  13. 【推荐】 集合泛型定义时, 在 JDK7 及以上,使用 diamond 语法或全省略

    【推荐】 集合泛型定义时, 在 JDK7 及以上,使用 diamond 语法或全省略

  14. 【推荐】 集合初始化时, 指定集合初始值大小。

  15. 【推荐】 使用 entrySet 遍历 Map 类集合 KV,而不是 keySet 方式进行遍历

    keySet 其实是遍历了 2 次,一次是转为 Iterator 对象,另一次是从 hashMap 中取出 key 所对应
    的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中,效率更高。如果是 JDK8,
    使用 Map.forEach 方法。

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

集合类KeyValueSuper说明
Hashtable不允许为 null不允许为 nullDictionary线程安全
ConcurrentHashMap不允许为 null不允许为 nullAbstractMap锁分段技术( JDK8:CAS)
TreeMap不允许为 null允许为 nullAbstractMap线程不安全
HashMap允许为 null允许为 nullAbstractMap线程不安全
  1. 【参考】 合理利用好集合的有序性(sort)和稳定性(order),避免集合的无序性(unsort)和不稳
    定性(unorder)带来的负面影响。

    说明: 有序性是指遍历的结果是按某种比较规则依次排列的。 稳定性指集合每次遍历的元素次序是一定
    的。 如: ArrayList 是 order/unsort; HashMap 是 unorder/unsort; TreeSet 是 order/sort。

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

1.6-并发处理

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

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

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

  3. 【强制】 线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。

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

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

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

    1) FixedThreadPool 和 SingleThreadPool:
    允许的请求队列长度为 Integer.MAX_VALUE,可能会堆积大量的请求,从而导致 OOM。
    2) CachedThreadPool:
    允许的创建线程数量为 Integer.MAX_VALUE, 可能会创建大量的线程,从而导致 OOM。

  5. 【强制】 SimpleDateFormat 是线程不安全的类,一般不要定义为 static 变量,如果定义为
    static,必须加锁,或者使用 DateUtils 工具类。

  6. 【强制】 必须回收自定义的 ThreadLocal 变量,尤其在线程池场景下,线程经常会被复用,
    如果不清理自定义的 ThreadLocal 变量,可能会影响后续业务逻辑和造成内存泄露等问题。
    尽量在代理中使用 try-finally 块进行回收。

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

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

  8. 【强制】 对多个资源、数据库表、对象同时加锁时,需要保持一致的加锁顺序,否则可能会
    造成死锁。 (比如线程1的加锁顺序是ABC资源 线程2也应该是)

  9. 【强制】 在使用阻塞等待获取锁的方式中,必须在 try 代码块之外,并且在加锁方法与 try 代
    码块之间没有任何可能抛出异常的方法调用,避免加锁成功后,在 finally 中无法解锁。

    说明一: 如果在 lock 方法与 try 代码块之间的方法调用抛出异常,那么无法解锁,造成其它线程无法成功
    获取锁。
    说明二: 如果 lock 方法在 try 代码块之内,可能由于其它方法抛出异常,导致在 finally 代码块中,
    unlock 对未加锁的对象解锁,它会调用 AQS 的 tryRelease 方法(取决于具体实现类),抛出
    IllegalMonitorStateException 异常。
    说明三: 在 Lock 对象的 lock 方法实现中可能抛出 unchecked 异常,产生的后果与说明二相同。

    1. Lock lock = new XxxLock();
    2. // ...
    3. lock.lock();
    4. try {
    5. doSomething();
    6. doOthers();
    7. } finally {
    8. lock.unlock();
    9. }
  10. 【强制】 在使用尝试机制来获取锁的方式中,进入业务代码块之前,必须先判断当前线程是否持有锁。锁的释放规则与锁的阻塞等待方式相同

    说明: Lock 对象的 unlock 方法在执行时,它会调用 AQS 的 tryRelease 方法(取决于具体实现类),如果当前线程不持有锁,则抛出 IllegalMonitorStateException 异常

    1. Lock lock = new XxxLock();
    2. // ...
    3. boolean isLocked = lock.tryLock();
    4. if (isLocked) {
    5. try {
    6. doSomething();
    7. doOthers();
    8. } finally {
    9. lock.unlock();
    10. }
    11. }
  11. 【强制】 并发修改同一记录时,避免更新丢失, 需要加锁。 要么在应用层加锁,要么在缓存加锁,要么在数据库层使用乐观锁,使用 version 作为更新依据。

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

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

  13. 【推荐】 资金相关的金融敏感信息,使用悲观锁策略。

    乐观锁在获得锁的同时已经完成了更新操作,校验逻辑容易出现漏洞,另外,乐观锁对冲突的解决
    策略有较复杂的要求,处理不当容易造成系统压力或数据异常,所以资金相关的金融敏感信息不建议使用
    乐观锁更新

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

    注意,子线程抛出异常堆栈,不能在主线程 try-catch 到。

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

    Random 实例包括 java.util.Random 的实例或者 Math.random()的方式。

    jdk1.7后可使用ThreadLocalRandom

  16. 【推荐】 在并发场景下, 通过双重检查锁( double-checked locking) 实现延迟初始化的优化
    问题隐患(可参考 The “Double-Checked Locking is Broken” Declaration), 推荐解决方案中较为
    简单一种( 适用于 JDK5 及以上版本) ,将目标属性声明为 volatile 型。

  17. 【参考】 volatile 解决多线程内存不可见问题。对于一写多读,是可以解决变量同步问题,但
    是如果多写,同样无法解决线程安全问题。

    如果是 count++操作,使用如下类实现: AtomicInteger count = new AtomicInteger();
    count.addAndGet(1); 如果是 JDK8,推荐使用 LongAdder 对象,比 AtomicLong 性能更好(减少乐观
    锁的重试次数)

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

  19. 【参考】 ThreadLocal 对象使用 static 修饰, ThreadLocal 无法解决共享对象的更新问题。

    这个变量是针对一个线程内所有操作共享的,所以设置为静态变量,所有此类实例共享此静态变
    量,也就是说在类第一次被使用时装载,只分配一块存储空间,所有此类的对象(只要是这个线程内定义
    的)都可以操控这个变量。

1.7-控制语句

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

  2. 【强制】 当 switch 括号内的变量类型为 String 并且此变量为外部参数时,必须先进行 null判断。

  3. 【强制】 在 if/else/for/while/do 语句中必须使用大括

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

    可能被击穿,比如库存,可能为负

  5. 【推荐】 表达异常的分支时, 少用 if-else 方式, 可以改写成: if(){return}

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

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

  7. 【推荐】 不要在其它表达式(尤其是条件表达式)中,插入赋值语句。

    赋值点类似于人体的穴位,对于代码的理解至关重要,所以赋值语句需要清晰地单独成为一行。

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

  9. 【推荐】 避免采用取反逻辑运算符。

    说明: 取反逻辑不利于快速理解,并且取反逻辑写法必然存在对应的正向逻辑写 法。
    正例: 使用 if (x < 628) 来表达 x 小于 628。
    反例: 使用 if (!(x >= 628)) 来表达 x 小于 628。

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

  11. 【参考】 下列情形,需要进行参数校验

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

  12. 【参考】 下列情形, 不需要进行参数校验:
    1) 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
    2) 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道,参数错误不太可能到底层才会暴露
    问题。一般 DAO 层与 Service 层都在同一个应用中,部署在同一台服务器中,所以 DAO 的参数校验,可
    以省略。

    3) 被声明成 private 只会被自己代码所调用的方法,如果能够确定调用方法的代码传入参数已经做过检
    查或者肯定不会有问题,此时可以不校验参数。

1.8 注释规约

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

  2. 【强制】 所有的抽象方法( 包括接口中的方法) 必须要用 Javadoc 注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。

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

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

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

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

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

  8. 【参考】 谨慎注释掉代码。 在上方详细说明,而不是简单地注释掉。 如果无用,则删除。

  9. 【参考】 对于注释的要求:

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

  11. 参考】 特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描,经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

    1) 待办事宜( TODO) :(标记人,标记时间, [预计处理时间])
    表示需要实现,但目前还未实现的功能。这实际上是一个 Javadoc 的标签,目前的 Javadoc 还没
    有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个 Javadoc 标签)。
    2) 错误,不能工作( FIXME) :(标记人,标记时间, [预计处理时间])
    在注释中用 FIXME 标记某代码是错误的,而且不能工作,需要及时纠正的情况。

1.9-其他

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

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

  2. 【强制】 velocity 调用 POJO 类的属性时,直接使用属性名取值即可,模板引擎会自动按规范调用 POJO 的 getXxx(),如果是 boolean 基本数据类型变量( boolean 命名不需要加 is 前缀) ,会自动调用 isXxx()方法。

    说明: 注意如果是 Boolean 包装类对象,优先调用 getXxx()的方法。

  3. 强制】 后台输送给页面的变量必须加$!{var}——中间的感叹号。

    说明: 如果 var 等于 null 或者不存在,那么${var}会直接显示在页面上

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

  5. 【强制】 获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();
    说明: 如果想获取更加精确的纳秒级时间值, 使用 System.nanoTime()的方式。在 JDK8 中,针对统计时
    间等场景,推荐使用 Instant 类

  6. 【强制】 日期格式化时,传入 pattern 中表示年份统一使用小写的 y。

    日期格式化时, yyyy 表示当天所在的年,而大写的 YYYY 代表是 week in which year
    ( JDK7 之后引入的概念),意思是当天所在的周属于的年份,一周从周日开始,周六结束,
    只要本周跨年,返回的 YYYY 就是下一年。另外需要注意:

    1. 表示月份是大写的 M
    2. 表示分钟则是小写的 m
    3. 24 小时制的是大写的 H
    4. 12 小时制的则是小写的 h
  7. 【推荐】 不要在视图模板中加入任何复杂的逻辑。

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

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

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

    对于垃圾代码或过时配置,坚决清理干净,避免程序过度臃肿,代码冗余。
    正例: 对于暂时被注释掉,后续可能恢复使用的代码片断,在注释代码上方,统一规定使用三个斜杠(///)
    来说明注释掉代码的理由。

二 日志异常

2.1 异常处理

  1. 【强制】 Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过 catch 的方式来处理,比如: NullPointerException, IndexOutOfBoundsException 等等。

    无法通过预检查的异常除外,比如,在解析字符串形式的数字时, 可能存在数字格式错误, 不得不通过 catch NumberFormatException 来实现

  2. 强制】 异常不要用来做流程控制,条件控制。

    异常设计的初衷是解决程序运行中的各种意外情况,且异常的处理效率比条件判断方式要低很多。

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

    对大段代码进行 try-catch,使程序无法根据不同的异常做出正确的应激反应,也不利于定位问题,这是一种不负责任的表现。

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

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

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

    果 JDK7 及以上,可以使用 try-with-resources 方式

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

    try 块中的 return 语句执行成功后,并不马上返回,而是继续执行 finally 块中的语句,如果此处存
    在 return 语句,则在此直接返回,无情丢弃掉 try 块中的返回点。

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

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

  9. 【强制】 在调用 RPC、二方包、或动态生成类的相关方法时,捕捉异常必须使用 Throwable类来进行拦截。

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

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

  11. 【推荐】 防止 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 问题。

  12. 【推荐】 定义时区分 unchecked / checked 异常,避免直接抛出 new RuntimeException(),
    更不允许抛出 Exception 或者 Throwable,应使用有业务含义的自定义异常。推荐业界已定
    义过的自定义异常,如: DAOException / ServiceException 等。

  13. 【参考】 对于公司外的 http/api 开放接口必须使用“错误码” ;而应用内部推荐异常抛出;
    跨应用间 RPC 调用优先考虑使用 Result 方式,封装 isSuccess()方法、 “错误码” 、 “错误
    简短信息” 。

  14. 【参考】 避免出现重复的代码( Don’t Repeat Yourself) ,即 DRY 原则

    说明: 随意复制和粘贴代码,必然会导致代码的重复,在以后需要修改时,需要修改所有的副本,容易遗漏。必要时抽取共性方法,或者抽象公共类,甚至是组件化。

2.2 日志规约

  1. 【强制】 应用中不可直接使用日志系统( Log4j、 Logback) 中的 API,而应依赖使用日志框架
    SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。

  2. 【强制】 所有日志文件至少保存 15 天,因为有些异常具备以“周” 为频次发生的特点。 网络
    运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日
    志不少于 6 个月。

  3. 【强制】 应用中的扩展日志( 如打点、临时监控、访问日志等) 命名方式:
    appName_logType_logName.log。 logType:日志类型, 如 stats/monitor/access 等; logName:日志
    描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归
    类查找

    推荐对日志进行分类, 如将错误日志和业务日志分开存放,便于开发人员查看,也便于通过日志对
    系统进行及时监控。

  4. 【强制】 在日志输出时,字符串变量之间的拼接使用占位符的方式。

    因为 String 字符串的拼接会使用 StringBuilder 的 append()方式,有一定的性能损耗。使用占位符
    仅是替换动作,可以有效提升性能

  5. 【强制】 对于 trace/debug/info 级别的日志输出,必须进行日志级别的开关判断。

    虽然在 debug(参数)的方法体内第一行代码 isDisabled(Level.DEBUG_INT)为真时( Slf4j 的常见实
    现 Log4j 和 Logback),就直接 return,但是参数可能会进行字符串拼接运算。此外,如果
    debug(getName())这种参数内有 getName()方法调用,无谓浪费方法调用的开销。

    1. // 如果判断为真,那么可以输出 trace 和 debug 级别的日志
    2. if (logger.isDebugEnabled()) {
    3. logger.debug("Current ID is: {} and name is: {}", id, getName());
    4. }
  6. 【强制】 避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false。
    正例: <logger name="com.taobao.dubbo.config" additivity="false">

  7. 【强制】 异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过关键字 throws 往上抛出。

    logger.error(各类参数或者对象 toString() + “_” + e.getMessage(), e);

  8. 【推荐】 谨慎地记录日志。生产环境禁止输出 debug 日志; 有选择地输出 info 日志; 如果使
    用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘
    撑爆,并记得及时删除这些观察日志。

    大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。 记录日志时请思考:这些
    日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?

  9. 推荐】 可以使用 warn 日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适从。如非必要,请不要在此场景打出 error 级别,避免频繁报警。

    注意日志输出的级别, error 级别只记录系统逻辑出错、异常或者重要的错误信息。

  10. 【推荐】 尽量用英文来描述日志错误信息,如果日志中的错误信息用英文描述不清楚的话使用中文描述即可,否则容易产生歧义。 【强制】 国际化团队或海外部署的服务器由于字符集问题,使用全英文来注释和描述日志错误信息。


发表评论

目录