【Java编程规范】命名规范篇

关于命名约定,有话要说

命名原则

  • 共识:共识是指不同人的横向比较,共识按范围分包含组内共识(业务相关的专有名词)、企业内部公司和业界共识;

  • 统一:统一是指单个人的垂直比较,单个人在不同时间点编写的变量、方法、类的命名要统一,不能出现同一个概念一会儿这样命名,一会儿又那样命名;命名不统一也会加大代码阅读难度;

  • 完整︰只要命名合理,不要担心方法名称太长,但方法名称过长常常又意味着该方法干的事太多了,则需要思考是否可以拆分方法

  • 自解释 注释是为了帮助理解代码,如果代码是自解释的,即本身就具有很好的可读性,那么就无需添加注释了,这是最高境界。

    • 合适的命名规范。说明对象类型(变量/接口/枚举方法),设计模式/抽象类/实现;
    • 代码合理分段,每一段都是同一业务层面的抽象;
    • 用词合理,做到词能达意。

命名规则

由四大原则衍生出来的规则

  • 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
    正例:MAX_STOCK_COUNT
    反例:MAX_COUNT

  • 【强制】抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。
    【强制】类型与中括号紧挨相连来 表示 数组。
    正例: 定义整形数组 int[] arrayDemo;
    反例: 在 main 参数中,使用 String args[] 来定义。

  • 【强制】POJO类中布尔类型的变量,都不要加is前缀,否则部分框架解析会引起序列化错误。 反例:定义为基本数据类型Boolean isDeleted的属性,它的方法也是isDeleted(),RPC
    框架在反向解析的时候,“误以为”对应的属性名称是deleted,导致属性获取不到,进而抛出异常。

  • 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。 正例:应用工具类包名为com.alibaba.ai.util、类名为MessageUtils(此规则参考spring的框架结构)

*【强制】杜绝完全不规范的缩写,避免望文不知义。 反例:AbstractClass“缩写”命名成AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。

*【参考】枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。 说明:枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制是私有。 正例:枚举名字为ProcessStatusEnum的成员名称:SUCCESS / UNKNOWN_REASON。

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

【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。 说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。 正例:public class OrderFactory; public class LoginProxy; public class ResourceObserver; 【强制】对于Service和DAO类,基于SOA的理念,暴露出来的服务一定是接口,内部的实现类用Impl的后缀与接口区别。 正例:CacheServiceImpl实现CacheService接口。
*【推荐】 如果是形容能力的接口名称,取对应的形容词为接口名(通常是–able的形式)。 正例:AbstractTranslator实现 Translatable接口。

各层命名规则

  1. Service/DAO层方法命名规约
  2. 获取单个对象的方法用get做前缀。
  3. 获取多个对象的方法用list做前缀,复数形式结尾如:listObjects。
  4. 获取统计值的方法用count做前缀。
  5. 插入的方法用save/insert做前缀。
  6. 删除的方法用remove/delete做前缀。
  7. 修改的方法用update做前缀。

####【参考】分层领域模型规约:

  • DO(Data Object):此对象与数据库表结构一一对应,通过DAO层向上传输数据源对象。
  • DTO(Data Transfer Object):数据传输对象,Service或Manager向外传输的对象。
  • BO(Business Object):业务对象,由Service层输出的封装业务逻辑的对象。
  • VO(View Object):显示层对象,通常是Web向模板渲染引擎层传输的对象。
  • Query:数据查询对象,各层接收上层的查询请求。注意超过2个参数的查询封装,禁止使用Map类来传输。