首页  思维导图  详情

java编码规约

2021-06-30 11:13:05   1  举报





AI智能生成

Java编码规约思维脑图

java

编码规约

阿里巴巴编码规约

Java规约

Java设计

作者其他创作

大纲/内容

编码规约

命名风格

代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式

类名使用 UpperCamelCase 风格，但以下情形例外： DO / BO / DTO / VO / AO /PO / UID 等

方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格

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

抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾，异常code枚举以ExceptionCode，枚举enum

类型与中括号紧挨相连来表示数组

POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误

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

避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低

杜绝完全不规范的缩写，避免望文不知义

为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达

在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度

如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式

接口类中的方法和属性不要加任何修饰符号（ public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量，接口强制javadoc

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

枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开

各层命名规约，A强制

常量定义

不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。

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

不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护

常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量

如果变量值仅在一个固定范围内变化用 enum 类型来定义。

代码格式

如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非空代码块则

左小括号和右边相邻字符之间不出现空格；右小括号和左边相邻字符之间也不出现空格；而左大括号前需要加空格。详见第 5 条下方正例提示。

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

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

采用 4 个空格缩进，禁止使用 tab 字符。

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

在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开

单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则

方法参数在定义和传入时，多个参数逗号后边必须加空格

IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。

单个方法的总行数不超过 80 行

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

不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。说明：任何情形，没有必要插入多个空行进行隔开

OOP 规约

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

所有的覆写方法，必须加@Override 注解。

相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。

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

不能使用过时的类或方法

Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。

所有整型包装类对象之间值的比较，全部使用 equals 方法比较

任何货币金额，均以最小货币单位且整型类型来进行存储

浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用 equals来判断。

码出高效

定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配。等价于WMS-Model

禁止使用构造方法 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象。

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

定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。

序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

构造方法里面禁止加入任何业务逻辑

POJO 类必须写 toString 方法。使用 IDE 中的工具： source> generate toString时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。lombk @ToString @Data

禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()方法

使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险

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

类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter / setter方法

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

循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。说明：下例中，反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费

final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字

慎用 Object 的 clone 方法来拷贝对象

类成员与方法访问控制从严：

日期时间

日期格式化时，传入 pattern 中表示年份统一使用小写的 y。

在日期格式中分清楚大写的 M 和小写的 m，大写的 H 和小写的 h 分别指代的意义。

获取当前毫秒数： System.currentTimeMillis(); 而不是 new Date().getTime()。

JDK8中Instant

不允许在程序任何地方中使用： 1） java.sql.Date 2） java.sql.Time 3）java.sql.Timestamp。

JDK BUG吗? 混乱的日期API

不要在程序中写死一年为 365 天，避免在公历闰年时出现日期转换错误或程序逻辑错误

避免公历闰年 2 月问题。闰年的 2 月份有 29 天，一年后的那一天不可能是 2 月 29日。

使用枚举值来指代月份。如果使用数字，注意 Date， Calendar 等日期相关类的月份month 取值在 0-11 之间。

集合处理

关于 hashCode 和 equals 的处理，遵循如下规则

判断所有集合内部的元素是否为空，使用 isEmpty()方法，而不是 size()==0 的方式。说明：前者的时间复杂度为 O(1)，而且可读性更好。

在使用 java.util.stream.Collectors 类的 toMap()方法转为 Map 集合时，一定要使用含有参数类型为 BinaryOperator，参数名为 mergeFunction 的方法，否则当出现相同 key值时会抛出 IllegalStateException 异常

在使用 java.util.stream.Collectors 类的 toMap()方法转为 Map 集合时，一定要注意当 value 为 null 时会抛 NPE 异常。

ArrayList 的 subList 结果不可强转成 ArrayList，否则会抛出 ClassCastException 异常： java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。

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

Collections 类返回的对象，如： emptyList()/singletonList()等都是 immutable list，不可对其进行添加或者删除元素的操作

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

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

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

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

泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方法，而<? super T>不能使用 get 方法，两者在接口调用赋值的场景中容易出错

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

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

在 JDK7 版本及以上， Comparator 实现类要满足如下三个条件，不然 Arrays.sort，Collections.sort 会抛 IllegalArgumentException 异常

集合泛型定义时，在 JDK7 及以上，使用 diamond 语法或全省略。

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

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

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

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

利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的contains()进行遍历去重或者判断包含操作

并发处理

获取单例对象需要保证线程安全，其中的方法也要保证线程安全

创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。

线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。

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

SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为 static，必须加锁，或者使用 DateUtils 工具类

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

高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁

对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。

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

在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。锁的释放规则与锁的阻塞等待方式相同。

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

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

资金相关的金融敏感信息，使用悲观锁策略

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

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

通过双重检查锁（ double-checked locking）（在并发场景下）实现延迟初始化的优化问题隐患(可参考 The \"Double-Checked Locking is Broken\" Declaration)，推荐解决方案中较为简单一种（适用于 JDK5 及以上版本），将目标属性声明为 volatile 型（比如修改 helper 的属性声明为`private volatile Helper helper = null;`）

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

HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在开发过程中注意规避此风险

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

控制语句

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

当 switch 括号内的变量类型为 String 并且此变量为外部参数时，必须先进行 null判断

在 if/else/for/while/do 语句中必须使用大括号

三目运算符 condition? 表达式 1 : 表达式 2 中，高度注意表达式 1 和 2 在类型对齐时，可能抛出因自动拆箱导致的 NPE 异常

在高并发场景中，避免使用” 等于” 判断作为中断或退出的条件

当某个方法的代码行数超过 10 行时， return / throw 等中断逻辑的右大括号后加一个空行

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

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

不要在其它表达式（尤其是条件表达式）中，插入赋值语句

循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的 try-catch 操作（这个 try-catch 是否可以移至循环体外）

避免采用取反逻辑运算符