【JavaSe】基础篇(六) Java中的标识符命名规范

JavaSe·基础篇(六) Java中的标识符命名规范

---

标识符

标识符指在程序中我们自己定义的内容。比如类的名字、方法的名字和变量的名字等等，都被称为标识符

• 命名规则： 【硬性要求】

  • 标识符可以包含 英文字母26个(区分大小写) 、 0-9数字 、 $（美元符号） 和 _（下划线） 。
  • 标识符不能以数字开头。
  • 标识符不能是关键字。

• 命名规范： 【软性建议】

  • 类名规范：首字母大写，后面每个单词首字母大写（大驼峰式）。
  • 方法名规范： 首字母小写，后面每个单词首字母大写（小驼峰式）。
  • 变量名规范：全部小写。
  • 包名规范：全部小写
  • 常量名规范：全部大写，每个单词以 _ 分割

以上是编写Java代码中标识符的基本命名规范

学习阿里12条标识符的规范

1. 【强制】所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

• 反例： _name / __name / $Object / name_ / name$ / Object$

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

• 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。

• 反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3;

• 正例： ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视为英文。

3. 【强制】类名使用 UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / DTO / VO / DAO等。

• 反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
• 正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase风格，必须遵从驼峰形式。

• 正例： localValue / getHttpMessage() / inputUserId

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

• 反例： MAX_COUNT
• 正例： MAX_STOCK_COUNT

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

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

• 反例：定义为基本数据类型 boolean isSuccess；的属性，它的方法也是 isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。

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

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

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

反例：<某业务代码>AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成condi，此类随意缩写严重降低了代码的可阅读性。

10.【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。

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

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

• 正例：CacheServiceImpl实现 CacheService接口。

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

• 正例：AbstractTranslator实现 Translatable。

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

• 说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
• 正例：枚举名字：DealStatusEnum；成员名称：SUCCESS / UNKOWN_REASON。

养成良好的编码习惯，相信你能和阿里的大牛写出同样规范的代码，不要感觉规矩多麻烦，习惯成自然