编程约束之命名约束

最新推荐文章于 2023-06-09 21:33:10 发布

weixin_34378767

最新推荐文章于 2023-06-09 21:33:10 发布

阅读量554

点赞数

文章标签：设计模式 java

原文链接：https://my.oschina.net/giegie/blog/833399

版权

为什么80%的码农都做不了架构师？>>>

编程约束

（一）命名约束

【强制】所有编程相关命名均不能以下划线和美元符号开始，也不能以下划线和美元符号介绍。
反例： name / $name / name / name$
【强制】所有编程相关命名严禁使用英文与拼音混合的方式，更不能允许直接使用中文的方式。
说明： 正确的英文拼写和语法可以让阅读者易于理解，避免歧义。也要尽量避免拼音命名
反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 变量 = 3;
正例： ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视为英文。
【强制】类名使用UpperCamelCase风格，必须遵从驼峰命名形式，但以下情况例外：（领域模型相关）DO / DTO / VO / DAO 等
正例: MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例: macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰命名形式。
正例： localValue / getHttpMessage() / inputUserId
【强制】常量命名全部大写，单词间用下划线隔开，力求语义清晰不要嫌命名过长
正例: MAX_STOCK_COUNT
反例: MAX_COUNT
【强制】抽象类命名使用Abstract或Base开头；异常类使用Exception结尾；测试类命名以它要测试的类开头以Test结尾。
【强制】中括号是数组类型的一部分，数组定义如下：String[] args
正例: String args[]来定义
【强制】POJO类型中的任何布尔型变量不要使用is开头，否则部分框架可能引起解析错误
反例: 定义为基本数据类型 boolean isSuccess；的属性，它的方法也是 isSuccess()，RPC 框架在反向解析的时候，“以为”对应的属性名称是 success，导致属性获取不到，进而抛出异常。
【强制】包名统一使用小写，点分隔符之间有且只有一个自然语义的单词。包名统一是用单数形式。
正例: 应用工具类包名为 com.alibaba.mpp.util、类名为 MessageUtils（此规则参考 spring 的框架结构）
【强制】杜绝完全不规范的缩写，避免忘文不知义。
正例: <某业务代码>AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
【推荐】如果使用到设计模式，建议在类名中体现出具体的模式。
说明: 将设计模式体现在命名中，有利于阅读者快速理解架构设计思想。
正例:

public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

【推荐】接口类的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的javadoc 注释。尽量不要在接口中定义变量，如果一定要定义变量，肯定是于接口方法有关，并且是整个应用的基础常量。
正例: 接口方法签名：void f(); 接口基础常量表示：String COMPANY = "alibaba";
反例: 接口方法定义：public abstract void f(); 说明: JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。
接口和实现类的两套规则

【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。
正例: CacheServiceImpl 实现 CacheService 接口。
【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able 的形式）。
正例: AbstractTranslator 实现 Translatable。

14 . 【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明: 枚举类其实就是特殊的常量类，而且默认构造方法默认私有（单例）。
正例: 枚举名字：DealStatusEnum；成员名称：SUCCESS / UNKOWN_REASON。
15 . 【参考】各层命名规约