Note when going straight for success of Mr.Wang

0%

命名风格

发表于 分类于

命名风格

  1. 命名均不能以下划线（）或美元符号($)开始，也不能以下划线（）或美元符号($)结束。
    反例：name / __name / $name / name / name$ / name__
    reason：python下划线开头是内部变量.

  2. 严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
    正例：renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
    反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
    reason: 正确的英文拼写和语法可以让阅读者易于理解，避免歧义. 中文拼音有同音字（Pingfen：评分，平分），汉字会有编码问题。

  3. 类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。
    正例：JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal / TaPromotion

  4. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。
    正例： localValue / getHttpMessage() / inputUserId

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

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

  7. 类型与中括号紧挨相连来表示数组。
    正例：定义整形数组 int[] arrayDemo
    reason: 便于阅读，一下就知道是数组。

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

  9. 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
    正例：应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils

  10. 避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可读性降低。
    reason：子类、父类成员变量名相同，即使是 public 类型的变量也是能够通过编译，而局部变量在同一方法内的不同代码块中同名也是合法的，但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。
    code:

  11. 杜绝完全不规范的缩写
    reason：严重降低代码的可读性

  12. 任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。
    正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater
    reason: 实现代码自解释

  13. 在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度
    reason: nameList 和 listName 一个表示名字集合，一个表示集合名称，很容易混淆。

  14. 如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
    正例：
    public class OrderFactory;
    public class LoginProxy;
    public class ResourceObserver;
    reason:有利于阅读者快速理解架构设计理念

  15. 接口类中的方法和属性不要加任何修饰符号，保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量
    正例：接口方法签名 void commit();
       接口基础常量 String COMPANY = “edutech”;
       JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。
    reason:接口变量默认省略 public static final，接口方法默认省略 public abstract

  16. 对于 Service 和 DAO 类，基于 SOA（Service-Oriented Architecture） 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别；如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形容词）
    正例：CacheServiceImpl 实现 CacheService 接口；
       AbstractTranslator 实现 Translatable 接口；

  17. 枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
    正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON

  18. 各层命名规约

  • Service/DAO 层方法命名规约
    1） 获取单个对象的方法用 get 做前缀。
    2） 获取多个对象的方法用 list 做前缀，复数形式结尾如：listObjects。
    3） 获取统计值的方法用 count 做前缀。
    4） 插入的方法用 save/insert 做前缀。
    5） 删除的方法用 remove/delete 做前缀。
    6） 修改的方法用 update 做前缀。
  • 领域模型命名规约
    1） 数据对象：xxxDO，xxx 即为数据表名。
    2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
    3） 展示对象：xxxVO，xxx 一般为网页名称。
    4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。
    知识点：领域模型是一个分析模型，帮助系统分析人员、用户认识现实业务的工具，描述的是业务中涉及到的实体及其相互之间的关系，它是需求分析的产物，与问题域相关。
    知识点：
    DO（ Data Object）：与数据库表结构一一对应，通过DAO层向上传输数据源对象。
    DTO（ Data Transfer Object）：数据传输对象，Service或Manager向外传输的对象。
    BO（ Business Object）：业务对象。 由Service层输出的封装业务逻辑的对象。
    VO（ View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。
    AO (Application Object) :应用对象,在 Web 层与 Service 层之间抽象的复用对象模型,极为贴近展示层,复用度不高。
    POJO 是 DO / DTO / BO / VO 的统称， 命名时禁止使用XXPOJO。
-------------the end-------------