通用命名规则

  1. 命名要有描述性，易于理解，少用缩写，避免不规范缩写
  2. 英文、拼音不混用

包命名约定

包名使用小写字母的单词(单数形式)

如果名称包含多个单词，则应使用点（.）分隔

根据组织自己的内部命名约定，包名称的后续部分可能不同。

类命名约定

类名使用大驼峰命名法

  • 抽象类命名使用 Abstract 或 Base 开头
  • 异常类命名使用 Exception 结尾
  • 测试类命名以它要测试的类的名称开始，以 Test 结尾
  • 例外：DO / BO / DTO / VO / AO / PO / UID 等。

接口命名约定

接口使用大驼峰命名法

在相同的情况下，接口也可以是名词，当它们呈现一系列类别时，例如List和Map。

方法命名约定

方法使用小驼峰命名法

变量命名约定

变量（参数变量、成员变量、局部变量）都使用小驼峰命名法

如果是临时变量，可以是单个字符，如x，y，z

常量命名约定

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

正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
反例：MAX_COUNT / EXPIRED_TIME

通用类型命名约定

通用类型参数名称应为大写单个字母。通常建议使用T类型字母。

在JDK类中，E用于集合元素，S用于服务加载器，K和V用于映射键和值。

枚举命名约定

枚举使用大驼峰命名法，枚举类名带上 Enum 后缀

枚举成员名称使用全大写，单词间用下划线隔开。

enum Direction {NORTH, EAST, SOUTH, WEST}

注释命名约定

注释名称遵循标题案例表示法。它们可以是基于要求的形容词，动词或名词。 public @interface FunctionalInterface {} public @interface Deprecated {} public @interface Documented {} public @Asyn Documented {} public @Test Documented {}

总结：在任何编程语言中编写干净代码，命名约定都是非常重要的，标准Java命名约定使代码更易读和可维护。

其它有用的规范

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

正例：定义整形数组 int[] arrayDemo。
反例：在 main 参数中，使用 String args[]来定义

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

说明：在本文 MySQL 规约中的建表约定第一条，表达是与否的变量采用 is_xxx 的命名方式，所以，需要在<resultMap>设置从 is_xxx 到 xxx 的映射关系。
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

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

说明：子类、父类成员变量名相同，即使是 public 类型的变量也能够通过编译，另外，局部变量在同一方法内的不同代码块中同名也是合法的，这些情况都要避免。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。

//反例
public class ConfusingName {
 public int stock;
 // 非 setter/getter 的参数名称，不允许与本类成员变量同名
 public void get(String alibaba) {
 if (condition) {
 final int money = 666;
 // ...
 }
 for (int i = 0; i < 10; i++) {
 // 在同一方法体中，不允许与其它代码块中的 money 命名相同
 final int money = 15978;
 // ...
 }
 }
}
class Son extends ConfusingName {
 // 不允许与父类的成员变量名称相同
 public int stock;
}

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

正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

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

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
正例： public class OrderFactory;
	  public class LoginProxy;
	  public class ResourceObserver;

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

正例：接口方法签名 void commit();
 	 接口基础常量 String COMPANY = "alibaba";
反例：接口方法定义 public abstract void f();
说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

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

  1. 对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别

    正例：CacheServiceImpl 实现 CacheService 接口。

  2. 如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形容词）。 正例：AbstractTranslator 实现 Translatable 接口

各层命名规约：

  • Service/DAO 层方法命名规约
    • 获取单个对象的方法用 get 做前缀
    • 获取多个对象的方法用 list 做前缀，复数结尾，如：listObjects
    • 获取统计值的方法用 count 做前缀
    • 插入的方法用 save/insert 做前缀
    • 删除的方法用 remove/delete 做前缀
    • 修改的方法用 update 做前缀
  • 领域模型命名规约
    • 数据对象：xxxDO，xxx 即为数据表名
    • 数据传输对象：xxxDTO，xxx 为业务领域相关的名称
    • 展示对象：xxxVO，xxx 一般为网页名称
    • POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

参考

  • https://blog.csdn.net/zixiao_love/article/details/90368561
  • 阿里开发手册