Java变量命名规则

Posted 2022-03-16 aJream

内容来自阿里《Java 开发手册》

变量命名

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

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

   说明：在本文 MySQL 规约中的建表约定第一条，表达是与否的值采用 is_xxx 的命名方式，所以，需要在 设置从 is_xxx 到 xxx 的映射关系。

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

   正例：应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils（此规则参考 spring 的框架结构）

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

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

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

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

   正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT

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

   正例：

   public class OrderFactory;

   public class LoginProxy;

   public class ResourceObserver;

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

   正例：

   接口方法签名 void commit();

   接口基础常量 String COMPANY = "alibaba";

   反例：

   接口方法定义 public abstract void f()

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

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

    正例：CacheServiceImpl 实现 CacheService 接口。

    2）【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形容词）。

    正例：AbstractTranslator 实现 Translatable 接口。

11. 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

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

    正例：

    枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。

12. 【参考】各层命名规约：

    A) Service/DAO 层方法命名规约

    1） 获取单个对象的方法用 get 做前缀。

    2） 获取多个对象的方法用 list 做前缀，复数形式结尾如：listObjects。

    3） 获取统计值的方法用 count 做前缀。

    4） 插入的方法用 save/insert 做前缀。

    5） 删除的方法用 remove/delete 做前缀。

    6） 修改的方法用 update 做前缀。

常量命名

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

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

反例：
    String key = "Id#taobao_" + tradeId; cache.put(key, value); 
// 缓存 get 时，由于在代码复制时，漏掉下划线，导致缓存击穿而出现问

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

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

代码规范

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

1） 左大括号前不换行。

2） 左大括号后换行。

3） 右大括号前换行。

4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。如

if ()
    // code


if ()
    
 else 
    

【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。

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

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

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

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

正例：

// 这是示例注释，请注意在双斜线之后有一个空格

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

正例：

long first = 1000000000000L; int second = (int)first + 2

【强制】IDE 的 text file encoding 设置为 UTF-8;

IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。

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